InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IPasteboardPrefs Class Referenceabstract
Inheritance diagram for IPasteboardPrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPASTEBOARDPREFERENCES }
 
enum  { kPasteboardSeperatorAmount = 36 }
 

Public Member Functions

virtual void SetPasteboardBorder (PMReal minXBorder, PMReal minYBorder)=0
 
virtual void GetPasteboardBorder (PMReal *minXBorder, PMReal *minYBorder) const =0
 
virtual void SetPasteboardColor (UID uiColorUID)=0
 
virtual UIDRef GetPasteboardColor () const =0
 
virtual void SetPreviewBackgroundColor (UID uiColorUID)=0
 
virtual UIDRef GetPreviewBackgroundColor () const =0
 
virtual void SetMatchPreviewColorToThemeColor (bool16)=0
 
virtual bool16 GetMatchPreviewColorToThemeColor ()=0
 
virtual void SetBleedColor (UID uiColorUID)=0
 
virtual UIDRef GetBleedColor () const =0
 
virtual void SetSlugColor (UID uiColorUID)=0
 
virtual UIDRef GetSlugColor () 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
 

Member Enumeration Documentation

anonymous enum

Define the vertical gap between pasteboards.

Member Function Documentation

virtual UIDRef IPasteboardPrefs::GetBleedColor () const
pure virtual

Set the UI color UID for the bleed color. Used in normal (non-preview) mode.

Parameters
none
Returns
UIDRef - UIDRef of the UI color used for bleed line.
virtual bool16 IPasteboardPrefs::GetMatchPreviewColorToThemeColor ()
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 void IPasteboardPrefs::GetPasteboardBorder (PMReal * minXBorder,
PMReal * minYBorder 
) const
pure virtual

Get the minimum pasteboard border for around the spread.

Parameters
minXBorder- return the minimum value for left and right border.
minYBorder- return the minimum value for top and bottom border.
virtual UIDRef IPasteboardPrefs::GetPasteboardColor () const
pure virtual

Get the UI color UID for the pasteboard color. Used in normal (non-preview) mode. This is UNUSED in 3.0, but left in for future use.

Parameters
none
Returns
UIDRef - UIDRef of the UI color used for pasteboard fill.
virtual UIDRef IPasteboardPrefs::GetPreviewBackgroundColor () const
pure virtual

Get the UI color UID for the pasteboard color. Used in preview mode.

Parameters
none
Returns
UIDRef - UIDRef of the UI color used for preview background fill.
virtual UIDRef IPasteboardPrefs::GetSlugColor () const
pure virtual

Set the UI color UID for the slug color. Used in normal (non-preview) mode.

Parameters
none
Returns
UIDRef - UIDRef of the UI color used for slug line.
virtual void IPasteboardPrefs::SetBleedColor (UID uiColorUID)
pure virtual

Set the UI color UID for the bleed color. Used in normal (non-preview) mode.

Parameters
uiColorUID- UID of a UI color to set the bleed line color to.
virtual void IPasteboardPrefs::SetMatchPreviewColorToThemeColor (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 IPasteboardPrefs::SetPasteboardBorder (PMReal minXBorder,
PMReal minYBorder 
)
pure virtual

Set the minimum pasteboard border for around the spread.

Parameters
minXBorder- minimum value for left and right border.
minYBorder- minimum value for top and bottom border.
virtual void IPasteboardPrefs::SetPasteboardColor (UID uiColorUID)
pure virtual

Set the UI color UID for the pasteboard color. Used in normal (non-preview) mode. This is UNUSED in 3.0, but left in for future use.

Parameters
uiColorUID- UID of a UI color to set the pasteboard fill color to.
virtual void IPasteboardPrefs::SetPreviewBackgroundColor (UID uiColorUID)
pure virtual

Set the UI color UID for the preview background color. Used in preview mode.

Parameters
uiColorUID- UID of a UI color to set the preview background fill color to.
virtual void IPasteboardPrefs::SetSlugColor (UID uiColorUID)
pure virtual

Set the UI color UID for the slug color. Used in normal (non-preview) mode.

Parameters
uiColorUID- UID of a UI color to set the slug line color to.