IPickerPanelModKeyStateData Class Reference

#include <IPickerPanelModKeyStateData.h>

Inheritance diagram for IPickerPanelModKeyStateData:

Public Types
enum	{ kDefaultIID = IID_ICOLORPICKERPANELMODKEYSTATEDATA }
enum	{ kPickerPanel_AltOptKeyPressed = 0x04, kPickerPanel_CmdKeyPressed = 0x02, kPickerPanel_ShiftKeyPressed = 0x01 }

Public Member Functions
virtual void	SetKeyState (int32 keyState)=0
virtual void	SetStrokeUID (UID strokeColorUID)=0
virtual void	SetStrokeTint (PMReal strokeTint)=0
virtual void	SetStrokeIsGlobal (bool16 isGlobal)=0
virtual void	SetFillUID (UID fillColorUID)=0
virtual void	SetFillTint (PMReal fillTint)=0
virtual void	SetFillIsGlobal (bool16)=0
virtual void	UpdateStrokeColorspaceColorData (int32 colorspace, const ColorArray &colorValues, const PMReal &tint)=0
virtual void	UpdateFillColorspaceColorData (int32 colorspace, const ColorArray &colorValues, const PMReal &tint)=0
virtual void	ResetCachedColorValues ()=0
virtual int32	GetKeyState (void) const =0
virtual UID	GetStrokeUID (void) const =0
virtual PMReal	GetStrokeTint (void) const =0
virtual bool16	StrokeIsGlobal (void) const =0
virtual UID	GetFillUID (void) const =0
virtual PMReal	GetFillTint (void) const =0
virtual bool16	FillIsGlobal (void) const =0
virtual ColorArray	GetStrokeColorspaceColorData (int32 colorspace)=0
virtual ColorArray	GetFillColorspaceColorData (int32 colorspace)=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

This is a helper interface which keeps track of some KBSC key state and states of stroke or fill color data for Color Panel. This is mainly used for processing user action with modifier keys in the Color Panel such as switching color space using shift-click.

Member Enumeration Documentation

anonymous enum

Enumerator
kPickerPanel_AltOptKeyPressed	Indicates alt-option key has been prressed.
kPickerPanel_CmdKeyPressed	Indicates cmd key has been prressed.
kPickerPanel_ShiftKeyPressed	Indicates shift key has been prressed.

Member Function Documentation

virtual bool16 IPickerPanelModKeyStateData::FillIsGlobal ( void  ) const

pure virtual

Returns true if current fill color UID is a global color swatch.

Returns

true if fill is a global swatch.

virtual ColorArray IPickerPanelModKeyStateData::GetFillColorspaceColorData ( int32  colorspace )

pure virtual

Returns the cached fill color value corresponding the specified color space.

Parameters

colorspace

is the color space for the fill color value being returned.

Returns

the fill color value.

virtual PMReal IPickerPanelModKeyStateData::GetFillTint ( void  ) const

pure virtual

Returns the current fill color UID.

Returns

the fille color UID.

virtual UID IPickerPanelModKeyStateData::GetFillUID ( void  ) const

pure virtual

Returns the current fill color UID.

Returns

the fill color UID.

virtual int32 IPickerPanelModKeyStateData::GetKeyState ( void  ) const

pure virtual

Returns the current key state.

Returns

the current key state.

virtual ColorArray IPickerPanelModKeyStateData::GetStrokeColorspaceColorData ( int32  colorspace )

pure virtual

Returns the cached stroke color value corresponding the specified color space.

Parameters

colorspace

is the color space for the stroke color value being returned.

Returns

the stroke color value.

virtual PMReal IPickerPanelModKeyStateData::GetStrokeTint ( void  ) const

pure virtual

Returns the current stroke tint percent.

Returns

the stroke tint percent.

virtual UID IPickerPanelModKeyStateData::GetStrokeUID ( void  ) const

pure virtual

Returns the current stroke color UID.

Returns

the stroke color UID.

virtual void IPickerPanelModKeyStateData::ResetCachedColorValues ( )

pure virtual

Reset the cached color values for stroke and fill color.

virtual void IPickerPanelModKeyStateData::SetFillIsGlobal ( bool16  )

pure virtual

Sets to true to indicate that current fill color is a global swatch.

Parameters

isGlobal

is set to true to indicate that the current fill color is a global color swtach.

virtual void IPickerPanelModKeyStateData::SetFillTint ( PMReal  fillTint )

pure virtual

Sets the current fill tint percent.

Parameters

fillTint

the fill tint percent.

virtual void IPickerPanelModKeyStateData::SetFillUID ( UID  fillColorUID )

pure virtual

Sets the current fill color UID.

Parameters

fillColorUID

the fill color UID.

virtual void IPickerPanelModKeyStateData::SetKeyState ( int32  keyState )

pure virtual

Sets the current key state. Key states is one of kPickerPanel_AltOptKeyPressed, kPickerPanel_CmdKeyPressed, or kPickerPanel_ShiftKeyPressed.

Parameters

keyState

the current key state.

virtual void IPickerPanelModKeyStateData::SetStrokeIsGlobal ( bool16  isGlobal )

pure virtual

Sets to true to indicate that current stroke color is a global swatch.

Parameters

isGlobal

is set to true to indicate that the current stroke color is a global color swtach.

virtual void IPickerPanelModKeyStateData::SetStrokeTint ( PMReal  strokeTint )

pure virtual

Sets the current stroke tint percent.

Parameters

strokeTint

the stroke tint percent.

virtual void IPickerPanelModKeyStateData::SetStrokeUID ( UID  strokeColorUID )

pure virtual

Sets the current stroke color UID.

Parameters

strokeColorUID

the stroke color UID.

virtual bool16 IPickerPanelModKeyStateData::StrokeIsGlobal ( void  ) const

pure virtual

Returns true if current stroke color UID is a global color swatch.

Returns

true if stroke is a global swatch.

virtual void IPickerPanelModKeyStateData::UpdateFillColorspaceColorData ( int32  colorspace, const ColorArray &  colorValues, const PMReal &  tint  )

pure virtual

Update the current fill color.

Parameters

colorspace	is the color space to update to.
colorValue	is the color values corresponding to the color space.
tint	is the tint percent to apply to.

virtual void IPickerPanelModKeyStateData::UpdateStrokeColorspaceColorData ( int32  colorspace, const ColorArray &  colorValues, const PMReal &  tint  )

pure virtual

Update the current stroke color.

Parameters

colorspace	is the color space to update to.
colorValue	is the color values corresponding to the color space.
tint	is the tint percent to apply to.