IColorPickerPanelHelper Class Reference

#include <IColorPickerPanelHelper.h>

Inheritance diagram for IColorPickerPanelHelper:

Public Types
enum	{ kDefaultIID = IID_ICOLORPICKERPANELHELPER }

Public Member Functions
virtual int32	GetPickerIndexFromColorSpace (const int32 colorspace) const =0
virtual int32	GetColorSpaceFromPickerIndex (const int32 pickerIndex) const =0
virtual IColorData *	QueryPickerMetaData ()=0
virtual ISubject *	QueryPickerPanelSubject ()=0
virtual ISliderStateData::SliderStateType	GetPickerControlState (const int32 pickerIndex) const =0
virtual ISliderStateData::SliderStateType	GetPickerControlState () const =0
virtual IColorData *	QueryColorspaceColorData (const int32 colorspace)=0
virtual const UIDList *	GetPickerNChannelInkList ()=0
virtual void	SetPickerMetaData (const int32 pickerIndex, ColorArray &components, bool16 doNotify=kFalse)=0
virtual void	SetPickerMetaData (IColorData *iColorData, bool16 doNotify=kFalse)=0
virtual void	SetPickerMetaData (const UIDRef &colorRef, bool16 doNotify=kFalse)=0
virtual void	SetPickerMetaData (const ColorArray &components, const UIDList &inkUIDList, bool16 doNotify=kFalse)=0
virtual void	SetPickerControlStates (const int32 pickerIndex, const ISliderStateData::SliderStateType controlState, bool16 doNotify=kFalse)=0
virtual void	SetPickerControlStates (const ISliderStateData::SliderStateType controlState, bool16 doNotify=kFalse)=0
virtual void	EnablePanel (const int32 pickerIndex=-1)=0
virtual void	DisablePanel (const int32 pickerIndex=-1)=0
virtual void	UpdatePickerMetaData ()=0
virtual void	SwitchPickerPanelByIndex (const int32 pickerIndex)=0
virtual void	SwitchPickerPanelByColorspace (const int32 newColorspace)=0
virtual PMIID	GetObservedProtocol (void)=0
virtual void	BroadcastChange (IControlView *iPickerView=nil)=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

An interface that helps to manage the color picker panels. A color picker typically will have a stack of color space panels and other related panels.

Member Function Documentation

virtual void IColorPickerPanelHelper::BroadcastChange ( IControlView *  iPickerView = nil )

pure virtual

Force a boadcast of color change

Parameters

iPickerView

specifies the subject view to broadcast on. If nil, broadcast on the currently visible picker view's subject.

virtual void IColorPickerPanelHelper::DisablePanel ( const int32  pickerIndex = -1 )

pure virtual

Disable the specified picker panel.

Parameters

pickerIndex

specifies picker panel to disable. If index if -1, all panels are disabled.

virtual void IColorPickerPanelHelper::EnablePanel ( const int32  pickerIndex = -1 )

pure virtual

Enable the specified picker panel.

Parameters

pickerIndex

specifies picker panel to enable. If index if -1, all panels are enabled.

virtual int32 IColorPickerPanelHelper::GetColorSpaceFromPickerIndex ( const int32  pickerIndex ) const

pure virtual

Returns the clor space of the panel from the specified panel index

Parameters

pickerIndex

specifies the panel index

Returns

the panel's color space.

virtual PMIID IColorPickerPanelHelper::GetObservedProtocol ( void  )

pure virtual

Returns panel color change broadcast protocal.

virtual ISliderStateData::SliderStateType IColorPickerPanelHelper::GetPickerControlState ( const int32  pickerIndex ) const

pure virtual

Return the control state for the specified panel index.

See Also

also ISliderStateData.h for definition of SliderStateType

Parameters

pickerIndex

specifies the panel index

Returns

panel's slider state.

virtual ISliderStateData::SliderStateType IColorPickerPanelHelper::GetPickerControlState ( ) const

pure virtual

Return the control state for the currently visible picker panel.

See Also

also ISliderStateData.h for definition of SliderStateType

Returns

visible panel's slider state.

virtual int32 IColorPickerPanelHelper::GetPickerIndexFromColorSpace ( const int32  colorspace ) const

pure virtual

Returns a panel index from the specified color space.

Parameters

colorspace

specifies the color space of the picker panel.

Returns

the panel index.

virtual const UIDList* IColorPickerPanelHelper::GetPickerNChannelInkList ( )

pure virtual

Return the ink UID list of the NChannel picker panel.

Returns

panel's ink UID list. A nil pointer is returned if there isn't a NChannel picker panel.

virtual IColorData* IColorPickerPanelHelper::QueryColorspaceColorData ( const int32  colorspace )

pure virtual

Return the specified picker panel's IColorData interface pointer.

Parameters

colorspace

specifies the color space of picker panel

Returns

panel's IColorData interface pointer.

virtual IColorData* IColorPickerPanelHelper::QueryPickerMetaData ( )

pure virtual

Return the panel's IColorData interface pointer.

Returns

panel's IColorData interface pointer.

virtual ISubject* IColorPickerPanelHelper::QueryPickerPanelSubject ( )

pure virtual

Return the panel's ISubject interface pointer.

Returns

panel's ISubject interface pointer.

virtual void IColorPickerPanelHelper::SetPickerControlStates ( const int32  pickerIndex, const ISliderStateData::SliderStateType  controlState, bool16  doNotify = kFalse  )

pure virtual

Sets the new control statefor the picker panel.

See Also

also ISliderStateData.h for definition of SliderStateType

Parameters

pickerIndex	specifies the index of the picker panel.
controlState	specifies the control state of the picker panel.
doNotify	will broadcast control change messages if true. The default value for doNotify is kFalse.

virtual void IColorPickerPanelHelper::SetPickerControlStates ( const ISliderStateData::SliderStateType  controlState, bool16  doNotify = kFalse  )

pure virtual

Sets the new control statefor the picker panel.

See Also

also ISliderStateData.h for definition of SliderStateType

Parameters

controlState	specifies the control state of the picker panel to set.
doNotify	will broadcast control change messages if true. The default value for doNotify is kFalse.

virtual void IColorPickerPanelHelper::SetPickerMetaData ( const int32  pickerIndex, ColorArray &  components, bool16  doNotify = kFalse  )

pure virtual

Sets color values for the specified panel index.

Parameters

pickerIndex	specifies the panel index
components	specifies the color values to set
doNotify	will broadcast control change messages if true. The default value for doNotify is kFalse.

virtual void IColorPickerPanelHelper::SetPickerMetaData ( IColorData *  iColorData, bool16  doNotify = kFalse  )

pure virtual

Sets the new color data for the color picker panel.

Parameters

iColorData	specifies the new color data to set.
doNotify	will broadcast control change messages if true. The default value for doNotify is kFalse.

virtual void IColorPickerPanelHelper::SetPickerMetaData ( const UIDRef &  colorRef, bool16  doNotify = kFalse  )

pure virtual

Sets the new color data for the color picker panel.

Parameters

colorRef	specifies the new color data to set.
doNotify	will broadcast control change messages if true. The default value for doNotify is kFalse.

virtual void IColorPickerPanelHelper::SetPickerMetaData ( const ColorArray &  components, const UIDList &  inkUIDList, bool16  doNotify = kFalse  )

pure virtual

Sets the new NChannel color data for the color picker panel.

Parameters

components	specifies the new color values to set.
inkUIDList	specifies the corresponding ink UID list set.
doNotify	will broadcast control change messages if true. The default value for doNotify is kFalse.

virtual void IColorPickerPanelHelper::SwitchPickerPanelByColorspace ( const int32  newColorspace )

pure virtual

Switch color picker's visible view to the picker panel specified by he panel's color space.

Parameters

newColorspace

specifies the color space panel to switch to.

virtual void IColorPickerPanelHelper::SwitchPickerPanelByIndex ( const int32  pickerIndex )

pure virtual

Switch color picker's visible view to the picker panel specified by the panel index.

Parameters

pickerIndex

specifies the panel index.

virtual void IColorPickerPanelHelper::UpdatePickerMetaData ( )

pure virtual

Update color picker panel's color data based on the currently visible panel.