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

Public Types

enum  { kDefaultIID = IID_IGUIDEPREFERENCESFACADE }
 

Public Member Functions

virtual bool GetShowSmartGuides () const =0
 
virtual ErrorCode ShowSmartGuides (bool bShow) const =0
 
virtual bool GetSmartAlignToObjectCenter () const =0
 
virtual ErrorCode SetSmartAlignToObjectCenter (bool bEnable) const =0
 
virtual bool GetSmartAlignToObjectEdges () const =0
 
virtual ErrorCode SetSmartAlignToObjectEdges (bool bEnable) const =0
 
virtual bool GetSmartDimensionsEnabled () const =0
 
virtual ErrorCode SetSmartDimensionsEnabled (bool bEnable) const =0
 
virtual bool GetSmartSpacingEnabled () const =0
 
virtual ErrorCode SetSmartSpacingEnabled (bool bEnable) const =0
 
virtual UIDRef GetSmartGuidesColor () const =0
 
virtual ErrorCode SetSmartGuidesColor (UID color) 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 Function Documentation

virtual bool Facade::IGuidePreferencesFacade::GetShowSmartGuides () const
pure virtual
Return whether or not Smart Guides are enabled.
Returns
true if the Smart Guides feature is enabled. false otherwise.
virtual bool Facade::IGuidePreferencesFacade::GetSmartAlignToObjectCenter () const
pure virtual
Return whether or not Smart Guides will snap to the center of objects.
Returns
true if Smart Guides will snap to the center of objects. false otherwise.
virtual bool Facade::IGuidePreferencesFacade::GetSmartAlignToObjectEdges () const
pure virtual
Return whether or not Smart Guides will snap to the edges of objects.
Returns
true if Smart Guides will snap to the edges of objects. false otherwise.
virtual bool Facade::IGuidePreferencesFacade::GetSmartDimensionsEnabled () const
pure virtual
Return whether or not Smart Dimension guides are enabled.
Returns
true if Smart Dimension guides are enabled.. false otherwise.
virtual UIDRef Facade::IGuidePreferencesFacade::GetSmartGuidesColor () const
pure virtual
Return UIDRef of the Smart Guides' UI color. The result can be

passed to Utils<IUIColorUtils>()->GetRGBColorValue() to obtain a ColorArray representing the RGB color components.

Returns
UIDRef of the Smart Guides' UI color.
virtual bool Facade::IGuidePreferencesFacade::GetSmartSpacingEnabled () const
pure virtual
Return whether or not Smart Spacing guides are enabled.
Returns
true if Smart Spacing guides are enabled. false otherwise.
virtual ErrorCode Facade::IGuidePreferencesFacade::SetSmartAlignToObjectCenter (bool bEnable) const
pure virtual
Set whether or not Smart Guides will snap to the center of objects.
Parameters
bEnable[IN]: true to enable, false to disable
Returns
kSuccess if successful. Otherwise, an error code.
virtual ErrorCode Facade::IGuidePreferencesFacade::SetSmartAlignToObjectEdges (bool bEnable) const
pure virtual
Set whether or not Smart Guides will snap to the edges of objects.
Parameters
bEnable[IN]: true to enable, false to disable
Returns
kSuccess if successful. Otherwise, an error code.
virtual ErrorCode Facade::IGuidePreferencesFacade::SetSmartDimensionsEnabled (bool bEnable) const
pure virtual
Set whether or not Smart Dimension guides are enabled.
Parameters
bEnable[IN]: true to enable, false to disable
Returns
kSuccess if successful. Otherwise, an error code.
virtual ErrorCode Facade::IGuidePreferencesFacade::SetSmartGuidesColor (UID color) const
pure virtual
Set Smart Guides color.
Parameters
color[IN]: UID of the UI color to set.
Returns
kSuccess if successful. Otherwise, an error code.
virtual ErrorCode Facade::IGuidePreferencesFacade::SetSmartSpacingEnabled (bool bEnable) const
pure virtual
Set whether or not to enable Smart Spacing guides.
Parameters
bEnable[IN]: true to enable, false to disable
Returns
kSuccess if successful. Otherwise, an error code.
virtual ErrorCode Facade::IGuidePreferencesFacade::ShowSmartGuides (bool bShow) const
pure virtual
Set whether or not the Smart Guides feature is enabled.
Parameters
bShow[IN]: true to enable, false to disable
Returns
kSuccess if successful. Otherwise, an error code.