DeltaDirectives Class Reference

#include <deltadirectives.h>

List of all members.

Classes
struct	Def
Public Types
enum	DirectiveId {   SHOW, CHARLIST, CHARTYPES, CHARNOTES,   CHARIMAGES, ITEMDESCS, TAXONIMAGES, IMPLICITVALUES,   DEPENDENTCHARS, MANDATORYCHARS, COMMENT, PSEUDO_UNKNOWN,   PSEUDO_NONE }
enum	Flags {   IsDeltaStd2005 = 1, IsCSIRODeltaImplemented = 2, IsParsed = 4, IsStoredOnly = 8,   IsInteralUseOnly = 16 }
Public Member Functions
	DeltaDirectives ()
Static Public Member Functions
static QString	abbrevName (void)
static unsigned	count (void)
static bool	isKnown (const Def *directive)
static bool	isKnown (QString str)
static bool	isPsuedoDirective (const Def *directive)
static const Def *	def (DirectiveId id)
static const Def *	def (QString str)
static const Def *	pseudoDef (DirectiveId id)

---

Member Enumeration Documentation

enum DeltaDirectives::DirectiveId

Enumerator:

SHOW
CHARLIST
CHARTYPES
CHARNOTES
CHARIMAGES
ITEMDESCS
TAXONIMAGES
IMPLICITVALUES
DEPENDENTCHARS
MANDATORYCHARS
COMMENT
PSEUDO_UNKNOWN
PSEUDO_NONE

enum DeltaDirectives::Flags

Enumerator:

IsDeltaStd2005	Documented in the DELTA Standard 2005 or. Todo: cite
IsCSIRODeltaImplemented
IsParsed
IsStoredOnly
IsInteralUseOnly

---

Constructor & Destructor Documentation

DeltaDirectives::DeltaDirectives

(

)

---

Member Function Documentation

static QString DeltaDirectives::abbrevName

(

void

)

[static]

unsigned DeltaDirectives::count

(

void

)

[static]

Returns the number of defined directives (exclusing pseudo-directives)

const DeltaDirectives::Def * DeltaDirectives::def

(

DirectiveId

id

)

[static]

Retrieve a directive definition by id. Returns a pointer to the definition, or NULL if no match with id was found.

const DeltaDirectives::Def * DeltaDirectives::def

(

QString

str

)

[static]

Retrieve, if possible, the directive definition that /str/ represents. Note that /str/ can be any valid string and therefore this function can also be used to check if the string is a directive or not. If a directive directive is found, it is then possible to skip past the 'control phrase' by simply adding the length.

If the string does not represent a (known) directive control phrase, then the a pointer to the 'pseudo-directive' definition for DeltaDirectives::PSEUDO_UNKNOWN is returned.

Note:

: The string (passed as /str/) must be a possible control phrase /without/ the leading DELTADIRECTIVE_DELIMITER ('*'). Characters after the 'control phrase' (name) of the directive are permitted.

bool DeltaDirectives::isKnown

(

const Def *

directive

)

[static]

Returns true if the given directive definition represents a known directive (e.g. if it not a 'pseudo-directive').

Precondition:

: directive != NULL

bool DeltaDirectives::isKnown

(

QString

str

)

[static]

Returns true if the given directive definition represents a known directive (e.g. if it not a 'pseudo-directive').

Note:

: The string (str) should not begin with the leading DELTADIRECTIVE_DELIMITER character. Characters after the 'control phrase' (name) of the directive are permitted.

bool DeltaDirectives::isPsuedoDirective

(

const Def *

directive

)

[static]

Returns true if the directive is a not a 'pseudo directive'

Precondition:

: directive != NULL

const DeltaDirectives::Def * DeltaDirectives::pseudoDef

(

DirectiveId

id

)

[static]

Retrieve the directive definition for the pseudo directive matching id

---

The documentation for this class was generated from the following files:

• F:/Code/DeltaQt/DeltaQt/deltadirectives.h
• F:/Code/DeltaQt/DeltaQt/deltadirectives.cpp