IAutoLayoutPrefsCmdData Class Reference

#include <IAutoLayoutPrefsCmdData.h>

Inheritance diagram for IAutoLayoutPrefsCmdData:

Public Member Functions
virtual void	Set (const UIDRef &doc, bool16 bAutoLayoutOn, bool16 bStretchGraphics, bool16 bMoveGuides, bool16 bLoosenLocks, bool16 bStickyGuides, bool16 bIgnoreGuides, PMReal rAutoSnapZone)=0
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 const UIDRef &	GetDocument () const =0
virtual const bool16	GetAutoLayoutOn () const =0
virtual const bool16	GetStretchGraphics () const =0
virtual const bool16	GetMoveGuides () const =0
virtual const bool16	GetLoosenLocks () const =0
virtual const bool16	GetStickyGuides () const =0
virtual const bool16	GetIgnoreGuides () const =0
virtual const PMReal	GetAutoSnapZone () 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

Detailed Description

Interface for setting and getting data for the kSetAutoLayoutPrefsCmdBoss command.

Member Function Documentation

virtual const bool16 IAutoLayoutPrefsCmdData::GetAutoLayoutOn ( ) const

pure virtual

Get the on/off state of layout adjustment.

Returns

kTrue for on, kFalse for off

virtual const PMReal IAutoLayoutPrefsCmdData::GetAutoSnapZone ( ) const

pure virtual

Get the auto-snap zone.

Returns

PMReal alignment tolerance zone in points (range 0-12 pts)

virtual const UIDRef& IAutoLayoutPrefsCmdData::GetDocument ( ) const

pure virtual

Get a UIDRef for the document to apply the preferences to.

Returns

a UIDRef for the document.

virtual const bool16 IAutoLayoutPrefsCmdData::GetIgnoreGuides ( ) const

pure virtual

Get whether guide alignments are ignored by layout adjustment.

Returns

kTrue for ignore guides, kFalse for don't ignore guides

virtual const bool16 IAutoLayoutPrefsCmdData::GetLoosenLocks ( ) const

pure virtual

Get whether locked items can be adjusted by layout adjustment.

Returns

kTrue for allow adjusting locked items, kFalse for disallow

virtual const bool16 IAutoLayoutPrefsCmdData::GetMoveGuides ( ) const

pure virtual

Get whether guides may be moved by layout adjustment.

Returns

kTrue for allow moving, kFalse for disallow

virtual const bool16 IAutoLayoutPrefsCmdData::GetStickyGuides ( ) const

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 const bool16 IAutoLayoutPrefsCmdData::GetStretchGraphics ( ) const

pure virtual

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

Returns

kTrue for allow stretching, kFalse for disallow

virtual void IAutoLayoutPrefsCmdData::Set ( const UIDRef &  doc, bool16  bAutoLayoutOn, bool16  bStretchGraphics, bool16  bMoveGuides, bool16  bLoosenLocks, bool16  bStickyGuides, bool16  bIgnoreGuides, PMReal  rAutoSnapZone  )

pure virtual

Set all the values at once.

Parameters

doc	IN a reference to the document whose preferences are being set.
bAutoLayoutOn	IN kTrue to turn on, kFalse to turn off.
bStretchGraphics	IN kTrue to allow stretching of graphics or groups, kFalse to disallow
bMoveGuides	IN kTrue to allow moving ruler guides, kFalse to disallow
bLoosenLocks	IN kTrue to allow adjusting locked items, kFalse to disallow
bStickyGuides	IGNORED guide stickiness is always on; this setting is ignored
bIgnoreGuides	IN kTrue to ignore guides, kFalse to obey guides
rAutoSnapZone	IN distance in points from either side of an edge to consider aligned with guides, columns, etc. (range is 0 to 12 pts).

virtual void IAutoLayoutPrefsCmdData::SetAutoLayoutOn ( bool16  val )

pure virtual

Enable the Layout Adjustment feature.

Parameters

val	IN kTrue to turn on, kFalse to turn off.

virtual void IAutoLayoutPrefsCmdData::SetAutoSnapZone ( PMReal  val )

pure virtual

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

Parameters

val	IN distance in points from either side of an edge to consider aligned with guides, columns, etc. (range is 0 to 12 pts).

virtual void IAutoLayoutPrefsCmdData::SetIgnoreGuides ( bool16  val )

pure virtual

Ignore alignment to ruler guides when performing layout adjustment.

Parameters

val	IN kTrue to ignore guides, kFalse to obey guides

virtual void IAutoLayoutPrefsCmdData::SetLoosenLocks ( bool16  val )

pure virtual

Allow locked items to be adjusted by layout adjustment.

Parameters

val	IN kTrue to allow adjusting locked items, kFalse to disallow

virtual void IAutoLayoutPrefsCmdData::SetMoveGuides ( bool16  val )

pure virtual

Allow guides to be moved by layout adjustment.

Parameters

val	IN kTrue to allow moving, kFalse to disallow

virtual void IAutoLayoutPrefsCmdData::SetStickyGuides ( bool16  val )

pure virtual

Set whether ruler guides move with column edges if aligned.

Parameters

val	IGNORED guide stickiness is always on; this setting is ignored

virtual void IAutoLayoutPrefsCmdData::SetStretchGraphics ( bool16  val )

pure virtual

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

Parameters

val	IN kTrue to allow stretching, kFalse to disallow