IndexHeaderGroup Class Reference

#include <IndexHeaderGroup.h>

Public Types
typedef object_type	data_type

Public Member Functions
	IndexHeaderGroup ()
bool16	operator== (const IndexHeaderGroup &other) const
bool16	operator!= (const IndexHeaderGroup &other) const
void	AppendSectionHeader (const IndexSectionHeader &sectionHeader)
const IndexSectionHeader &	GetNthSectionHeader (int32 i) const
void	ReadWrite (IPMStream *s)

Public Attributes
PMString	fName
PMString	fUIHeader
WideString	fTextHeader
bool16	fVisible
K2Vector< IndexSectionHeader >	fSectionHeadersList

Detailed Description

Groups multiple section headers into one convenient unit. The usual groups are Symbol, Numeric, Alphabet, Kana.

Constructor & Destructor Documentation

IndexHeaderGroup::IndexHeaderGroup ( )

inline

Constructs an empty header group.

Member Function Documentation

void IndexHeaderGroup::AppendSectionHeader ( const IndexSectionHeader &  sectionHeader )

inline

Appends a section header to the group.

Parameters

sectionHeader

[IN] - the section header to add to the group.

const IndexSectionHeader& IndexHeaderGroup::GetNthSectionHeader ( int32  i ) const

inline

Retrieves the section header at the specified index.

Parameters

i	[IN] - index of the desired section header within the group.

Returns

the section header at the index i.

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

inline

Inequality test operator.

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

inline

Equality test operator.

void IndexHeaderGroup::ReadWrite ( IPMStream *  s )

inline

Persistence support for the header group.

Parameters

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