blob: 83393c50fb9e4f13fc78a74ebab63c5419f995f9 (
plain) (
tree)
|
|
/******************************************************************************
* versekey.h - code for class 'versekey'- a standard Biblical verse key
*
* $Id: treekey.h,v 1.4 2002/10/01 19:52:40 dglassey Exp $
*
* Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
* CrossWire Bible Society
* P. O. Box 2528
* Tempe, AZ 85280-2528
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation version 2.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
*/
#ifndef TREEKEY_H
#define TREEKEY_H
#include <swkey.h>
#include <swmacs.h>
#include <defs.h>
SWORD_NAMESPACE_START
/**
* Class VerseKey
* The SWKey implementation used for verse based modules like Bibles or commentaries.
*/
class SWDLLEXPORT TreeKey : public SWKey {
static SWClass classdef;
void init();
public:
// TreeKey (const char *ikey = 0);
// TreeKey (const SWKey * ikey);
// TreeKey (TreeKey const &k);
TreeKey () { init(); };
~TreeKey () {};
virtual const char *getLocalName() = 0;
virtual const char *setLocalName(const char *) = 0;
virtual const char *getUserData(int *size = 0) = 0;
virtual void setUserData(const char *userData, int size = 0) = 0;
virtual const char *getFullName() const = 0;
virtual void root() = 0;
virtual bool parent() = 0;
virtual bool firstChild() = 0;
virtual bool nextSibling() = 0;
virtual bool previousSibling() = 0;
virtual bool hasChildren() = 0;
virtual void append() = 0;
virtual void appendChild() = 0;
virtual void insertBefore() = 0;
virtual void remove() = 0;
virtual void setOffset(unsigned long offset) = 0;
virtual unsigned long getOffset() const = 0;
virtual void setText(const char *ikey) = 0;
virtual void setPosition(SW_POSITION p) = 0;
virtual const char *getText() const = 0;
virtual int compare(const SWKey &ikey) = 0;
virtual void decrement(int steps = 1) = 0;
virtual void increment(int steps = 1) = 0;
virtual char Traversable () { return 1; }
virtual long Index () const { return getOffset(); }
virtual long Index (long iindex) { setOffset(iindex); return getOffset(); }
SWKEY_OPERATORS
};
SWORD_NAMESPACE_END
#endif
|
