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

#include <IGuidesFacade.h>

Inheritance diagram for IGuidesFacade:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IGUIDESFACADE }
 

Public Member Functions

virtual void EnableCenterSmartGuides (bool32 bEnable)=0
 
virtual bool32 GetCenterSmartGuidesEnabled (void) const =0
 
virtual void EnableEdgeSmartGuides (bool32 bEnable)=0
 
virtual bool32 GetEdgeSmartGuidesEnabled (void) const =0
 
virtual void SetSmartGuideColor (const UID uiColorUID)=0
 
virtual const UIDRef GetSmartGuideColor () const =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

IGuidesFacade is an interface used to set the prefs that control the behavior of smart guides.

Member Function Documentation

virtual void IGuidesFacade::EnableCenterSmartGuides (bool32 bEnable)
pure virtual

Set whether or not to show smart guides at the center of page items.

Parameters
bool32[IN]: kTrue to enable smart guides at the center of existing page items. kFalse to disable.
virtual void IGuidesFacade::EnableEdgeSmartGuides (bool32 bEnable)
pure virtual

Set whether or not to show smart guides at the edges of page items.

Parameters
bool32[IN]: kTrue to enable smart guides at the edges of existing page items. kFalse to disable.
virtual bool32 IGuidesFacade::GetCenterSmartGuidesEnabled (void ) const
pure virtual

Get whether or not smart guides at the center of page items is enabled.

Returns
kTrue if center smart guides are enabled, kFalse otherwise
virtual bool32 IGuidesFacade::GetEdgeSmartGuidesEnabled (void ) const
pure virtual

Get whether or not smart guides at the edges of page items is enabled.

Returns
kTrue if edge smart guides are enabled, kFalse otherwise
virtual const UIDRef IGuidesFacade::GetSmartGuideColor () const
pure virtual

Get the UI color UID for the smart guide color.

Parameters
none
Returns
UIDRef - UIDRef of the current UI color used for smart guides
virtual void IGuidesFacade::SetSmartGuideColor (const UID uiColorUID)
pure virtual

Set the UI color UID for the smart guide color.

Parameters
uiColorUID- UID of the new UI color