IGeneralXMLPreferences Class Reference

#include <IGeneralXMLPreferences.h>

Inheritance diagram for IGeneralXMLPreferences:

Public Types
enum	{ kDefaultIID = IID_IGENERALXMLPREFERENCES }
enum	kElementType {   kStoryLocation = 0, kTableLocation, kRowLocation, kCellLocation,   kImageLocation, kTableHeaderLocation, kTableBodyLocation, kTableFooterLocation,   kEndElementType }

Public Member Functions
virtual ErrorCode	Set (IGeneralXMLPreferences *data)=0
virtual void	SetData (IGeneralXMLPreferences::kElementType which, const WideString &name, UID color)=0
virtual void	GetData (IGeneralXMLPreferences::kElementType which, WideString *name, UID *color) const =0
virtual WideString	GetName (IGeneralXMLPreferences::kElementType which) const =0
virtual UID	GetColor (IGeneralXMLPreferences::kElementType which) const =0
virtual WideString	GetDefaultName (IGeneralXMLPreferences::kElementType which) const =0
virtual int32	GetDefaultColor (IGeneralXMLPreferences::kElementType which) const =0
virtual bool16	operator== (const IGeneralXMLPreferences &o)=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

Used to store tagging presets. These presets are used to determine what names and colors to use when autotagging tables, cells, and stories

Member Enumeration Documentation

enum IGeneralXMLPreferences::kElementType

Used to indicate which type of preset you are getting or setting NOTE: this is used in persisted data. Do not alter values of existing data. Additions are fine

Enumerator
kStoryLocation	Used to indicate the story preset
kTableLocation	Used to indicate the table preset
kRowLocation	Used to indicate the table row preset
kCellLocation	Used to indicate the table cell preset
kImageLocation	Used to indicate the image preset
kTableHeaderLocation	Used to indicate table header preset
kTableBodyLocation	Used to indicate table body preset
kTableFooterLocation	Used to indicate table footer preset
kEndElementType	Used to indicate the count of element types. Do not add types after this

Member Function Documentation

virtual UID IGeneralXMLPreferences::GetColor ( IGeneralXMLPreferences::kElementType  which ) const

pure virtual

Used to get the color of a given preset

Parameters

which

- The preset you wnat information about

Returns

- The color to use for the tag

virtual void IGeneralXMLPreferences::GetData ( IGeneralXMLPreferences::kElementType  which, WideString *  name, UID *  color  ) const

pure virtual

Used to get appropriate data for a given preset

Parameters

which	- The preset you want information about
name	- Gets filled with the name to use. Can be nil to skip
color	- Gets filled with the color to use. Can be nil to skip

virtual int32 IGeneralXMLPreferences::GetDefaultColor ( IGeneralXMLPreferences::kElementType  which ) const

pure virtual

Used to get the index of a default color for a given preset. This may be different from the current stored color if the user has changed their presets. If you want to add a tag with the color that the user chose call GetName. If you want to get the factory presets call this method. NOTE: This is only an index into the color list and must be used in conjunction with

See Also

IUIColorUtils::GetUIColor

Parameters

which

- The preset you want information about

Returns

- The index of the default color to use for the tag

virtual WideString IGeneralXMLPreferences::GetDefaultName ( IGeneralXMLPreferences::kElementType  which ) const

pure virtual

Used to get the default name of a given preset. This may be different from the current stored name if the user has changed their presets. If you want to add a tag with the name that the user chose call GetName. If you want to get the factory presets call this method.

Parameters

which

- The preset you want information about

Returns

- The default name to use for the tag

virtual WideString IGeneralXMLPreferences::GetName ( IGeneralXMLPreferences::kElementType  which ) const

pure virtual

Used to get the name of a given preset

Parameters

which

- The preset you wnat information about

Returns

- The name to use for the tag

virtual bool16 IGeneralXMLPreferences::operator== ( const IGeneralXMLPreferences &  o )

pure virtual

Used to determine if two objects are the same

Parameters

o	- The object you want to compair this one to

Returns

- kTrue if the objects are the same

virtual ErrorCode IGeneralXMLPreferences::Set ( IGeneralXMLPreferences *  data )

pure virtual

Initialize the settings of this object from the settings of the 'data' object.

Parameters

data	- The object whose settings you want to use

Returns

error code

virtual void IGeneralXMLPreferences::SetData ( IGeneralXMLPreferences::kElementType  which, const WideString &  name, UID  color  )

pure virtual

Set up one of the tag presets. These presets are used to

Parameters

which	- The preset you want to setup
name	- The name this preset should use
color	- The color to be used