IIndexingHeaderSetMaster Class Reference

#include <IIndexingHeaderSetMaster.h>

Inheritance diagram for IIndexingHeaderSetMaster:

Public Types
enum	{ kDefaultIID = IID_IINDEXINGHEADERSETMASTER }
enum	GroupOrder {   kDefault = -1, kSymbolLatin, kSymbolNumbersLatinKana, kKanaLatinNumbersSymbol,   kLatinNumbersSymbol, kSymbolNumbersLatinKorean, kSymbolNumbersPinYin, kSymbolNumbersLatinHanziStrokes,   kSymbolNumbersLatinME, kSymbolNumbersLatin, kSymbolArabic, kSymbolNumbersArabic,   kSymbolNumbersArabicLatin, kSymbolNumbersLatinArabic, kSymbolHebrew, kSymbolNumbersHebrew,   kSymbolNumbersHebrewLatin, kSymbolNumbersLatinHebrew }

Public Member Functions
virtual int32	GetNumGroups () const =0
virtual const PMString &	GetNthGroupName (int32 nth) const =0
virtual std::vector< PMString >	GetNthGroupTypes (int32 nth) const =0
virtual int32	GetNthGroupSelection (int32 nth) const =0
virtual void	SetNthGroupSelection (int32 nth, int32 selection)=0
virtual bool16	GetNthInclude (int32 nth) const =0
virtual void	SetNthInclude (int32 nth, bool16 include)=0
virtual void	Move (int32 oldPos, int32 newPos)=0
virtual void	AddGroup (const IndexHeaderGroup &headerGroup, bool16 include=kTrue)=0
virtual void	BuildHeaderSet (IIndexHeaderSet *headerSet) const =0
virtual void	SetAllGroupInfo (const std::vector< HeaderRangeTypes > &headerRangeList)=0
virtual void	CopyData (IIndexingHeaderSetMaster *iTarget) const =0
virtual void	SetDefault (GroupOrder order=kDefault)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Contains all the possible headers for indexing.

Member Function Documentation

virtual void IIndexingHeaderSetMaster::AddGroup ( const IndexHeaderGroup &  headerGroup, bool16  include = kTrue  )

pure virtual

Add header group. Added to end position

Parameters

headerGroup	header group to add.
include	if header should be included by default

virtual void IIndexingHeaderSetMaster::BuildHeaderSet ( IIndexHeaderSet *  headerSet ) const

pure virtual

Uses data to build a header set

Parameters

headerSet

header set to build. set is cleared before building.

virtual void IIndexingHeaderSetMaster::CopyData ( IIndexingHeaderSetMaster *  iTarget ) const

pure virtual

Copy these values TO the passed in interface (iTarget).

Parameters

iTarget

is filled out with the current interface's values.

virtual const PMString& IIndexingHeaderSetMaster::GetNthGroupName ( int32  nth ) const

pure virtual

Get name of nth header group. These names are like Latin, Cyrillic, and Numbers.

Parameters

nth	number of header group to get info for. < GetNumGroups.

Returns

PMString name header group

virtual int32 IIndexingHeaderSetMaster::GetNthGroupSelection ( int32  nth ) const

pure virtual

Get selection for nth header group. Which type is selected. Use GetNthGroupTypes to see vector of types.

Parameters

nth	number of header group to get info for. < GetNumGroups.

Returns

int32 which type is selected

virtual std::vector<PMString> IIndexingHeaderSetMaster::GetNthGroupTypes ( int32  nth ) const

pure virtual

Get names of types for nth header group. For example Latin has Basic Latin, Spanish, and Cyrillic has ones like Russian and Bulgarian.

Parameters

nth	number of header group to get info for. < GetNumGroups.

Returns

std::vector<PMString> names of types

virtual bool16 IIndexingHeaderSetMaster::GetNthInclude ( int32  nth ) const

pure virtual

Get if nth header group is included. Only included groups will show in the index palette.

Parameters

nth	number of header group to get info for. < GetNumGroups.

Returns

bool16 if header group is included

virtual int32 IIndexingHeaderSetMaster::GetNumGroups ( ) const

pure virtual

Get number of header groups. These groups are unicode ranges like Latin, Cyrillic, and Numbers.

Returns

int32 number of header groups

virtual void IIndexingHeaderSetMaster::Move ( int32  oldPos, int32  newPos  )

pure virtual

Move groups around.

Parameters

oldPos	header group to move. < GetNumGroups.
newPos	position to move header group before. <= GetNumGroups.

virtual void IIndexingHeaderSetMaster::SetDefault ( GroupOrder  order = kDefault )

pure virtual

Set to default values based on current UI

Parameters

order

order for groups. Common orders for things like Japanese featureset. KDefault uses current featureset and UI to create headersetmaster.

virtual void IIndexingHeaderSetMaster::SetNthGroupSelection ( int32  nth, int32  selection  )

pure virtual

Set selection for nth header group. Which type is selected. Use GetNthGroupTypes to see vector of types.

Parameters

nth	number of header group to get info for. < GetNumGroups.
selection	which type to select

virtual void IIndexingHeaderSetMaster::SetNthInclude ( int32  nth, bool16  include  )

pure virtual

Set if nth header group is included. Only included groups will show in the index palette.

Parameters

nth	number of header group to get info for. < GetNumGroups.
bool16	if header group is included