Inheritance diagram for IColorListControlData:

Public Types
enum	{ kDefaultIID = IID_ICOLORLISTCONTROLDATA }

enum	IncludeCustom { kIncludeCustom = 0, kColorsOnly }

Public Member Functions
virtual void	Setup (UIDRef workspace, PMIID whichInterface, IncludeCustom customOption=kIncludeCustom, UID selectedColor=kInvalidUID)=0

virtual void	Select (UID whichColor, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0

virtual bool16	IsSetup (UIDRef workspace=UIDRef::gNull) const =0

virtual UID	GetSelection () const =0

virtual void	AddIgnore () const =0

virtual void	RemoveIgnore () const =0

virtual void	AddUnnamed (UIDRef swatchRef) const =0

virtual void	RemoveUnnamed () 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

Member Function Documentation

virtual void IColorListControlData::AddIgnore ( ) const

pure virtual

Adds an "(Ignore)" entry to end of list, if none exists already

Parameters

none

virtual void IColorListControlData::AddUnnamed ( UIDRef swatchRef ) const

pure virtual

Adds "[Unnamed Color]" entry to the end of the list if one doesn't already exist

Parameters

UIDRef the ref of the unnamed color

virtual UID IColorListControlData::GetSelection ( ) const

pure virtual

Get the UID of the selected color

Parameters

none

Returns: UID - UID of the selected color

virtual bool16 IColorListControlData::IsSetup ( UIDRef workspace = UIDRef::gNull ) const

pure virtual

Has the color list been initialized yet? If the list has been initialized we don't need to intialize it again.

Parameters

workspace - UIDRef of the document this should have been setup for

Returns: bool16 - kTrue means the widget has been setup

virtual void IColorListControlData::RemoveIgnore ( ) const

pure virtual

Removes "(Ignore)" entry, if in list

Parameters

none

virtual void IColorListControlData::RemoveUnnamed ( ) const

pure virtual

Removes "[Unnamed Color]" entry to the end of the list if one doesn't already exist

Parameters

none

virtual void IColorListControlData::Select	(	UID	whichColor,
		bool16	invalidate = `kTrue`,
		bool16	notifyOfChange = `kTrue`
	)

pure virtual

Select a particular color

Parameters

whichColor - UID of the color to select (kInvalid will select nothing in the list)

Returns: none

virtual void IColorListControlData::Setup	(	UIDRef	workspace,
		PMIID	whichInterface,
		IncludeCustom	customOption = `kIncludeCustom`,
		UID	selectedColor = `kInvalidUID`
	)

pure virtual

Fill in the list box using the correct color list

Parameters

workspace	- workspace that the color list is in
whichInterface	- The color list to use (IID_IUICOLORLIST or IID_ISWATCHLIST)
kIncludeCustom	- Include an entry for a custom color?
selectedColor	- UID of the default color to select

Returns: none

Public Types

Public Member Functions

Member Function Documentation