InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Protected Member Functions | List of all members
IInterfaceColors Class Referenceabstract

#include <IInterfaceColors.h>

Inheritance diagram for IInterfaceColors:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINTERFACECOLORS }
 
enum  { kNumColors = kInterfaceColorCount, kFirstIndex = 0, kLastIndex = kNumColors - 1 }
 
typedef int32 InterfaceColor
 

Public Member Functions

virtual bool16 Init (const RsrcID interfaceColorTableRsrc)=0
 
virtual bool16 GetRealAGMColor (const InterfaceColor index, RealAGMColor &outColor) const =0
 
virtual bool16 GetRGBColor (const InterfaceColor index, RGBColor &outColor) 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
 

Protected Member Functions

virtual bool16 SetRealAGMColor (const InterfaceColor index, const RealAGMColor &inColor)=0
 
virtual bool16 SetRGBColor (const InterfaceColor index, const RGBColor &inColor)=0
 

Detailed Description

Interface to provide access to standard UI color values.

Member Typedef Documentation

typedef int32 IInterfaceColors::InterfaceColor
See Also
InterfaceColorDefines.h for a list of color values. We use::defines because we need these to work in resource files

Member Function Documentation

virtual bool16 IInterfaceColors::GetRealAGMColor (const InterfaceColor index,
RealAGMColor & outColor 
) const
pure virtual

Get the color value for a particular color constant as a RealAGMColor

Parameters
indexidentifier of the color you want,
See Also
InterfaceColorDefines.h for a list of color values.
Parameters
outColorthe color to be filled out
Returns
kTrue if successful
virtual bool16 IInterfaceColors::GetRGBColor (const InterfaceColor index,
RGBColor & outColor 
) const
pure virtual

Get the color value for a particular color constant as an RGBColor

Parameters
indexidentifier of the color you want,
See Also
InterfaceColorDefines.h for a list of color values.
Parameters
outColorthe color to be filled out
Returns
kTrue if successful
virtual bool16 IInterfaceColors::Init (const RsrcID interfaceColorTableRsrc)
pure virtual

initialize colors from a resource table of int16 RGB colors. returns kTrue if success.

Parameters
interfaceColorTableRsrcthe resource id for the color table to initialize from.
Returns
kTrue if successful
virtual bool16 IInterfaceColors::SetRealAGMColor (const InterfaceColor index,
const RealAGMColor & inColor 
)
protectedpure virtual

The methods below are depracated and NO-OP. They will be removed in a future version. DO NOT USE THEM set the value of one of the colors in the table from a RealAGMColor

Parameters
indexcolor index to set.
See Also
InterfaceColorDefines.h for a list of color values.
Parameters
inColorcolor value to set
Returns
kTrue if successful
virtual bool16 IInterfaceColors::SetRGBColor (const InterfaceColor index,
const RGBColor & inColor 
)
protectedpure virtual

set the value of one of the colors in the table from a RGBColor

Parameters
indexcolor index to set.
See Also
InterfaceColorDefines.h for a list of color values.
Parameters
inColorcolor value to set
Returns
kTrue if successful