IndexTopicEntryNode Class Reference

#include <IndexTopicEntryNode.h>

Public Types
typedef object_type	data_type

Public Member Functions
	IndexTopicEntryNode ()
bool16	operator== (const IndexTopicEntryNode &other) const
IndexTopicEntryNode &	operator= (const IndexTopicEntryNode &other)
const WideString &	GetSortString () const
const LanguageID &	GetSortLanguage () const
const int16 &	GetLevel () const
int16 &	GetLevel ()
WideString &	GetDisplayString ()
const WideString &	GetDisplayString () const
LanguageID &	GetLanguage ()
const LanguageID &	GetLanguage () const
WideString &	GetSortStringReference ()
const WideString &	GetSortStringReference () const

Protected Attributes
int16	fLevel
WideString	fDisplayString
WideString	fSortString
LanguageID	fLanguage

Detailed Description

Models a topic node with all it's properties. A topic node has a level, display string, sort string and a language. The display string is the string that will show up in the index. The sort string is used in the topic sorting process. The language specifies the language of this topic.

Constructor & Destructor Documentation

IndexTopicEntryNode::IndexTopicEntryNode ( )

inline

Constructs an empty topic node.

Member Function Documentation

WideString& IndexTopicEntryNode::GetDisplayString ( )

inline

Accessor for the display string property.

Returns

a modifiable reference to the display string.

const WideString& IndexTopicEntryNode::GetDisplayString ( ) const

inline

Accessor for the display string property.

Returns

the display string.

LanguageID& IndexTopicEntryNode::GetLanguage ( void  )

inline

Accessor for the sort language property.

Returns

a modifiable reference to the sort language.

const LanguageID& IndexTopicEntryNode::GetLanguage ( void  ) const

inline

Accessor for the sort language property.

Returns

the sort language for this topic node.

const int16& IndexTopicEntryNode::GetLevel ( ) const

inline

Accessor for the level property.

Returns

the level for this topic.

int16& IndexTopicEntryNode::GetLevel ( )

inline

Accessor for the level property.

Returns

a modifiable reference to the level property.

const LanguageID& IndexTopicEntryNode::GetSortLanguage ( ) const

inline

Accessor for the sort language.

Returns

the sort language.

const WideString& IndexTopicEntryNode::GetSortString ( ) const

inline

Accessor for the sort string.

Returns

the sort string for this topic node.

WideString& IndexTopicEntryNode::GetSortStringReference ( )

inline

Accessor for the sort string property.

Returns

a modifiable reference to the sort string.

const WideString& IndexTopicEntryNode::GetSortStringReference ( ) const

inline

Accessor for the sort string property.

Returns

the sort string for this topic node.

IndexTopicEntryNode& IndexTopicEntryNode::operator= ( const IndexTopicEntryNode &  other )

inline

Assignment operator.

bool16 IndexTopicEntryNode::operator== ( const IndexTopicEntryNode &  other ) const

inline

Equality test operator.