InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IColorPickerWidgetProvider Class Referenceabstract
Inheritance diagram for IColorPickerWidgetProvider:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICOLORPICKERWIDGETPROVIDER }
 

Public Member Functions

virtual const int16 GetNumSliders () const =0
 
virtual const int32 GetBaseSliderWidgetID () const =0
 
virtual const int32 GetBaseEditBoxWidgetID () const =0
 
virtual const int32 GetWidgetID () const =0
 
virtual const int32 GetColorSpace () const =0
 
virtual const PMStringGetPickerModelName () const =0
 
virtual bool16 SliderDrawProc (IControlView *view, IGraphicsPort *gPort, SysRgn updateRgn, const PMRect &frame)=0
 
virtual bool16 SpectrumDrawProc (IControlView *view, IGraphicsPort *gPort, SysRgn updateRgn, const PMRect &frame)=0
 
virtual bool16 ProxyDrawProc (IControlView *view, IGraphicsPort *gPort, SysRgn updateRgn, const PMRect &frame)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual const int32 IColorPickerWidgetProvider::GetBaseEditBoxWidgetID () const
pure virtual

Returns the base widget ID of the edit box widgets provided by this picker. Edit box widget ID must be consecutive. For example, the base edit widget id is defined for the red edit box.

Returns
the base widget ID of the edit box widgets for the sliders.
virtual const int32 IColorPickerWidgetProvider::GetBaseSliderWidgetID () const
pure virtual

Returns the base widget ID of the slider widgets provided by this picker. Slider widget ID must be consecutive. For example, the base slider widget id is defined for the red slider.

Returns
the base widget ID of the slider widgets.
virtual const int32 IColorPickerWidgetProvider::GetColorSpace () const
pure virtual

Returns the color space ID of this picker panel.

Returns
the color space of the picker panel.
virtual const int16 IColorPickerWidgetProvider::GetNumSliders () const
pure virtual

Returns the number of sliders provided. For example, the number of silders in a RGB color picker panel is 3.

Returns
the number of sliders.
virtual const PMString& IColorPickerWidgetProvider::GetPickerModelName () const
pure virtual

Returns the name for the color space of this picker panel. This is used to build the menu component of the picker. Example, A RGB color picker's color model name is "RGB".

Returns
a PMString for the name of color space.
virtual const int32 IColorPickerWidgetProvider::GetWidgetID () const
pure virtual

Returns the widget ID of this picker panel.

Returns
the widget ID of the picker panel.
virtual bool16 IColorPickerWidgetProvider::ProxyDrawProc (IControlViewview,
IGraphicsPortgPort,
SysRgn updateRgn,
const PMRectframe 
)
pure virtual

The rendering function for the color proxy widget.

Parameters
viewspecifies the view of the color proxy widget
gPortis the graphic port in which the drawing occurs.
updateRgnis the update region.
frameis the rectangular frame for the color prxy widget.
Returns
kTrue if a rendering function is provided; otherwise returns kFalse.
virtual bool16 IColorPickerWidgetProvider::SliderDrawProc (IControlViewview,
IGraphicsPortgPort,
SysRgn updateRgn,
const PMRectframe 
)
pure virtual

The rendering function for the slider widgets.

Parameters
viewspecifies the view of the slider widget
gPortis the graphic port in which the drawing occurs.
updateRgnis the update region.
frameis the rectangular frame for the slider widget.
Returns
true if a rendering function is provided; otherwise returns false.
virtual bool16 IColorPickerWidgetProvider::SpectrumDrawProc (IControlViewview,
IGraphicsPortgPort,
SysRgn updateRgn,
const PMRectframe 
)
pure virtual

The rendering function for the color bar widget.

Parameters
viewspecifies the view of the color bar widget
gPortis the graphic port in which the drawing occurs.
updateRgnis the update region.
frameis the rectangular frame for the color bar widget.
Returns
kTrue if a rendering function is provided; otherwise returns kFalse.