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

#include <IAutoLayoutPrefs.h>

Inheritance diagram for IAutoLayoutPrefs:
IPMUnknown

Public Member Functions

virtual void SetAutoLayoutOn (bool16 val)=0
 
virtual void SetStretchGraphics (bool16 val)=0
 
virtual void SetMoveGuides (bool16 val)=0
 
virtual void SetLoosenLocks (bool16 val)=0
 
virtual void SetStickyGuides (bool16 val)=0
 
virtual void SetIgnoreGuides (bool16 val)=0
 
virtual void SetAutoSnapZone (PMReal val)=0
 
virtual bool16 GetAutoLayoutOn ()=0
 
virtual bool16 GetStretchGraphics ()=0
 
virtual bool16 GetMoveGuides ()=0
 
virtual bool16 GetLoosenLocks ()=0
 
virtual bool16 GetStickyGuides ()=0
 
virtual bool16 GetIgnoreGuides ()=0
 
virtual PMReal GetAutoSnapZone ()=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 preferences for Layout Adjustment feature.

Member Function Documentation

virtual bool16 IAutoLayoutPrefs::GetAutoLayoutOn ()
pure virtual

Get the on/off state of layout adjustment.

Returns
kTrue for on, kFalse for off
virtual PMReal IAutoLayoutPrefs::GetAutoSnapZone ()
pure virtual

Get the auto-snap zone.

Returns
PMReal alignment tolerance zone in points (range 0-12 pts)
virtual bool16 IAutoLayoutPrefs::GetIgnoreGuides ()
pure virtual

Get whether guide alignments are ignored by layout adjustment.

Returns
kTrue for ignore guides, kFalse for don't ignore guides
virtual bool16 IAutoLayoutPrefs::GetLoosenLocks ()
pure virtual

Get whether locked items can be adjusted by layout adjustment.

Returns
kTrue for allow adjusting locked items, kFalse for disallow
virtual bool16 IAutoLayoutPrefs::GetMoveGuides ()
pure virtual

Get whether guides may be moved by layout adjustment.

Returns
kTrue for allow moving, kFalse for disallow
virtual bool16 IAutoLayoutPrefs::GetStickyGuides ()
pure virtual

Get whether ruler guides move with column guides when aligned. UNUSED; INTERNAL STATE IS ALWAYS kTrue.

Returns
kTrue for allow stretching, kFalse for disallow
virtual bool16 IAutoLayoutPrefs::GetStretchGraphics ()
pure virtual

Get whether graphics and groups may be stretched by layout adjustment.

Returns
kTrue for allow stretching, kFalse for disallow
virtual void IAutoLayoutPrefs::SetAutoLayoutOn (bool16 val)
pure virtual

Enable the Layout Adjustment feature.

Parameters
valIN kTrue to turn on, kFalse to turn off.
virtual void IAutoLayoutPrefs::SetAutoSnapZone (PMReal val)
pure virtual

Set the tolerance zone for layout adjustment's determination of pageitem edge alignment to guides, columns, etc.

Parameters
valIN distance in points from either side of an edge to consider aligned with guides, columns, etc. (range is 0 to 12 pts).
virtual void IAutoLayoutPrefs::SetIgnoreGuides (bool16 val)
pure virtual

Ignore alignment to ruler guides when performing layout adjustment.

Parameters
valIN kTrue to ignore guides, kFalse to obey guides
virtual void IAutoLayoutPrefs::SetLoosenLocks (bool16 val)
pure virtual

Allow locked items to be adjusted by layout adjustment.

Parameters
valIN kTrue to allow adjusting locked items, kFalse to disallow
virtual void IAutoLayoutPrefs::SetMoveGuides (bool16 val)
pure virtual

Allow guides to be moved by layout adjustment.

Parameters
valIN kTrue to allow moving, kFalse to disallow
virtual void IAutoLayoutPrefs::SetStickyGuides (bool16 val)
pure virtual

Set whether ruler guides move with column edges if aligned.

Parameters
valIGNORED guide stickiness is always on; this setting is ignored
virtual void IAutoLayoutPrefs::SetStretchGraphics (bool16 val)
pure virtual

Allow graphics and groups to be stretched (as opposed to moved only) by layout adjustment.

Parameters
valIN kTrue to allow stretching, kFalse to disallow