IInCopyUIColors Class Reference

#include <IInCopyUIColors.h>

Inheritance diagram for IInCopyUIColors:

Public Types
enum	{ kDefaultIID = IID_IINCOPYUICOLORS }

Public Member Functions
virtual int32	GetColorCount () const =0
virtual RealAGMColor	GetColorValue (int32 index) const =0
virtual RealAGMColor	GetColorValue (PMString name) const =0
virtual PMString	GetColorName (int32 index) const =0
virtual PMString	GetColorName (RealAGMColor agmColor) const =0
virtual bool	SetDefault (int32 index)=0
virtual RealAGMColor	GetDefaultColor () const =0
virtual ScriptID	GetEnumeration (int32 index) const =0
virtual int32	GetEnumerationIndex (ScriptID enumeration) const =0
virtual int32	GetColorIndex (const PMString &colorName) const =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

Interface with getter/setter methods for colors used by InCopy for user and prefs (track changes, galley, notes).

Member Function Documentation

virtual int32 IInCopyUIColors::GetColorCount ( ) const

pure virtual

Return number of colors in the list.

Returns

int32 number of colors.

virtual int32 IInCopyUIColors::GetColorIndex ( const PMString &  colorName ) const

pure virtual

Get color Index.

Parameters

name	of the color as PMString.

Returns

Index of the color name in the Vector.

virtual PMString IInCopyUIColors::GetColorName ( int32  index ) const

pure virtual

Get the color name stored at a specific index.

Parameters

index

of color for which to get the name.

Returns

PMString the name of the color, empty string if not found.

virtual PMString IInCopyUIColors::GetColorName ( RealAGMColor  agmColor ) const

pure virtual

Get the color name with the given color value.

Parameters

agmColor

color to get the name of.

Returns

PMString name of color, empty string if not found.

virtual RealAGMColor IInCopyUIColors::GetColorValue ( int32  index ) const

pure virtual

Get the color at a specific index.

Parameters

index

of the color to get value for.

Returns

RealAGMColor color value for the index specified, returns Black (0, 0, 0) if name is not found.

virtual RealAGMColor IInCopyUIColors::GetColorValue ( PMString  name ) const

pure virtual

Get the color values of the color with the given name.

Parameters

name	of the color to get value for.

Returns

RealAGMColor color value for the name specified, returns Black (0, 0, 0) if name is not found.

virtual RealAGMColor IInCopyUIColors::GetDefaultColor ( ) const

pure virtual

Get the current default color.

Returns

RealAGMColor default color.

virtual ScriptID IInCopyUIColors::GetEnumeration ( int32  index ) const

pure virtual

Map an index to a scripting enumeration.

Parameters

index

to map.

Returns

ScriptID script enum the index mapped to.

virtual int32 IInCopyUIColors::GetEnumerationIndex ( ScriptID  enumeration ) const

pure virtual

Map a scripting enumeration to a color index.

Parameters

enumeration

the scripting enum to map.

Returns

int32 index the script enum mapped to, -1 is enum not found.

virtual bool IInCopyUIColors::SetDefault ( int32  index )

pure virtual

Set default color.

Parameters

index

of the color to set as default.

Returns

bool true if successfully set default color.