InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPasteboardColorsData Class Referenceabstract

#include <IPasteboardColorsData.h>

Inheritance diagram for IPasteboardColorsData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPASTEBOARDCOLORSDATA }
 

Public Member Functions

virtual void Set (int32 iPasteboardColorIndex, int32 iPreviewBackgroundColorIndex, int32 iBleedColorIndex, int32 iSlugColorIndex)=0
 
virtual void SetPasteboardColorIndex (int32 val)=0
 
virtual void SetPreviewBackgroundColorIndex (int32 val)=0
 
virtual void SetBleedColorIndex (int32 val)=0
 
virtual void SetSlugColorIndex (int32 val)=0
 
virtual const int32 GetPasteboardColorIndex () const =0
 
virtual const int32 GetPreviewBackgroundColorIndex () const =0
 
virtual const int32 GetBleedColorIndex () const =0
 
virtual const int32 GetSlugColorIndex () const =0
 
virtual void SetDataMatchPreviewColorToTheme (bool16)=0
 
virtual bool16 GetDataMatchPreviewColorToTheme ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface for setting and getting color data for the pasteboard.

Member Function Documentation

virtual const int32 IPasteboardColorsData::GetBleedColorIndex () const
pure virtual

Get the bleed line color

Returns
the color index for bleed lines
virtual bool16 IPasteboardColorsData::GetDataMatchPreviewColorToTheme ()
pure virtual

Get the flag to match the Preview color with theme color. Used in preview mode.

Parameters
none
Returns
bool16 - match color to theme or not
virtual const int32 IPasteboardColorsData::GetPasteboardColorIndex () const
pure virtual

Get the pasteboard color

Returns
the color index for the pasteboard
virtual const int32 IPasteboardColorsData::GetPreviewBackgroundColorIndex () const
pure virtual

Get the preview background color

Returns
the color index for the preview background
virtual const int32 IPasteboardColorsData::GetSlugColorIndex () const
pure virtual

Get the slug line color

Returns
the color index for slug lines
virtual void IPasteboardColorsData::Set (int32 iPasteboardColorIndex,
int32 iPreviewBackgroundColorIndex,
int32 iBleedColorIndex,
int32 iSlugColorIndex 
)
pure virtual

Set the color data all at once.

Parameters
iPasteboardColorIndexIN color index for the pasteboard
iPreviewBackgroundColorIndexIN color index for the preview background
iBleedColorIndexIN color index for bleed lines
iSlugColorIndexIN color index for slug lines
virtual void IPasteboardColorsData::SetBleedColorIndex (int32 val)
pure virtual

Set the bleed line color

Parameters
valIN color index for bleed lines
virtual void IPasteboardColorsData::SetDataMatchPreviewColorToTheme (bool16 )
pure virtual

Set the flag to match the Preview color with theme color. Used in preview mode.

Parameters
bool- true - match color to theme, false - do not match to theme color
Returns
UIDRef - UIDRef of the UI color used for preview background fill.
virtual void IPasteboardColorsData::SetPasteboardColorIndex (int32 val)
pure virtual

Set the pasteboard color

Parameters
valIN color index for the pasteboard
virtual void IPasteboardColorsData::SetPreviewBackgroundColorIndex (int32 val)
pure virtual

Set the preview background color

Parameters
valIN color index for the preview background
virtual void IPasteboardColorsData::SetSlugColorIndex (int32 val)
pure virtual

Set the slug line color

Parameters
valIN color index for slug lines