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

#include <IGuideUIUtils.h>

Inheritance diagram for IGuideUIUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IGUIDEUIUTILS }
 

Public Member Functions

virtual void SelectAllGuides ()=0
 
virtual void ShowGuidesIfHidden ()=0
 
virtual bool16 IsGuideHidden ()=0
 
virtual PMRect CalculateGuideAdornmentRect (IShape *guideShape, const PMMatrix &innerToWindowMatrix, ColorizedIcon *pngArt)=0
 
virtual UIDRef GetActiveGuideAdornment () const =0
 
virtual void SetActiveGuideAdornment (const UIDRef &guideRef)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Utilites for answering questions about ruler guides when there is an open document window. Please use the IGuideUIUtils via kUtilsBoss (see Utils.h). 

Utils<IGuideUIUtils>()->SelectAllGuides( ... ) ;

Member Function Documentation

virtual PMRect IGuideUIUtils::CalculateGuideAdornmentRect (IShape * guideShape,
const PMMatrix & innerToWindowMatrix,
ColorizedIcon * pngArt 
)
pure virtual

Given a guide shape, calculate the location of the given adornment rect. Used for guide type adornments.

Parameters
IShape*,theguide item's shape interface
PMMatrix,theinner to window matrix for the item.
ColorizedIcon,thepng art for the adornment.
Returns
PMRect, the window coordinate rectangle representing the screen location of the guide adornment. kEmptyRect if none.
virtual UIDRef IGuideUIUtils::GetActiveGuideAdornment () const
pure virtual

Return the active guide for the guide type adornment the user clicked on.

Returns
a UIDRef for the guide the user clicked on its guide type adornment.
virtual bool16 IGuideUIUtils::IsGuideHidden ()
pure virtual

Determines if any guides are currently hidden, either overall with IGuidePrefs (GetGuidesShown), or on the active layer (IDocumentLayer, IsGuideVisible).

Returns
returns kTrue if guide is currently hidden, kFalse otherwise.
virtual void IGuideUIUtils::SelectAllGuides ()
pure virtual

Select all the visible, unlocked guides on the current spread.

virtual void IGuideUIUtils::SetActiveGuideAdornment (const UIDRef & guideRef)
pure virtual

Set the active guide for the guide type adornment the user clicked on. Generally for INTERNAL use only.

Parameters
aUIDRef for the guide the user clicked on its guide type adornment.
virtual void IGuideUIUtils::ShowGuidesIfHidden ()
pure virtual

Helper function to show guides on the page if they are hidden. Guides may be hidden overall (IGuidePrefs, GetGuidesShown) or on the active layer (IDocumentLayer, IsGuideVisible). Useful for a tracker that creates guides.