IndexSectionHeader Class Reference

#include <IndexSectionHeader.h>

Public Types
typedef object_type	data_type

Public Member Functions
	IndexSectionHeader ()
bool16	operator== (const IndexSectionHeader &other) const
bool16	operator!= (const IndexSectionHeader &other) const
void	ReadWrite (IPMStream *s)

Public Attributes
WideString	fSortingHeader
WideString	fTextHeader
PMString	fUIHeader
LanguageID	fLanguage

Detailed Description

Data class that stores a section header. The sections in an index depend on the language. For Roman languages (western) sections are "A", "B", ...

Constructor & Destructor Documentation

IndexSectionHeader::IndexSectionHeader ( )

inline

Constructs an empty section header.

Member Function Documentation

bool16 IndexSectionHeader::operator!= ( const IndexSectionHeader &  other ) const

inline

Inequality test operator.

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

inline

Equality test operator.

void IndexSectionHeader::ReadWrite ( IPMStream *  s )

inline

Persistence support for the section header.

Parameters

s	[IN] - the stream to read/write the section header from/to.

Member Data Documentation

LanguageID IndexSectionHeader::fLanguage

Language of the section header

WideString IndexSectionHeader::fSortingHeader

String used to attribute a topic to a section.

Multiple characters mean other possible first letters. Example "VW" is used by Swedish to indicate that a word starting with either v or w may sort using this header. If you instead want a digraph or trigraph like Czech "Ch" leave this empty and use fTextHeader. Use capital version of letters.

WideString IndexSectionHeader::fTextHeader

Used for sorting digraphs and trigraphs. Example Czech "Ch" or Hungarian "Dzs"

Before CS3 fTextHeader was only used in the CE versions for digraphs and trigraphs (Czech, Hungarian) Now in CS3 this is used by all versions for digraphs and trigraphs. Letters may be either capital or small. Will upper case both fTextHeader and sort string on compare.

PMString IndexSectionHeader::fUIHeader

String used to display the header in the UI