IColumnPrefs Class Reference

#include <IColumnPrefs.h>

Inheritance diagram for IColumnPrefs:

Public Types
enum	{ kDefaultIID = IID_ICOLUMNPREFERENCES }

Public Member Functions
virtual void	SetNumColumns (const int32 &numColumns)=0
virtual int32	GetNumColumns ()=0
virtual void	SetGutter (const PMReal &gutter)=0
virtual PMReal	GetGutter ()=0
virtual void	SetColumnOrientation_2 (IColumns::ColumnOrientation direction)=0
virtual IColumns::ColumnOrientation	GetColumnOrientation_2 ()=0
virtual void	SetColor (const UID uiColorUID)=0
virtual UIDRef	GetColor ()=0
virtual void	SetLocked (const bool16 bLocked)=0
virtual bool16	GetLocked ()=0
virtual bool16	GetLocked_DURING_CONVERSION_ONLY ()=0
virtual int32	GetColorIndex_DURING_CONVERSION_ONLY ()=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 to column preferences for document or application.

Author

Paul Sorrick

See Also

IColumn

kDocWorkspaceBoss

kWorkspaceBoss

kSetColumnPrefsCmdBoss

Member Function Documentation

virtual UIDRef IColumnPrefs::GetColor ( )

pure virtual

Get the UIColorRef for the columns to be drawn with.

Returns

UIDRef of the color to use.

See Also

IUIColorUtils.h

virtual int32 IColumnPrefs::GetColorIndex_DURING_CONVERSION_ONLY ( )

pure virtual

Get the UI color index for the columns. DO NOT USE, used for conversion only.

Returns

int32 index of the color in the IID_IUICOLORLIST.

virtual IColumns::ColumnOrientation IColumnPrefs::GetColumnOrientation_2 ( )

pure virtual

Get the default column direction for columns on page (J feature set). kTrue == vertical, kFalse == horizontal.

Returns

bool16 kTrue for J columns, kFalse for Roman style.

virtual PMReal IColumnPrefs::GetGutter ( )

pure virtual

Get the gutter value (in points). This is the space between adjacent columns. Must have 2 or more columns for the gutter value to actually matter since one column won't have a gutter.

Returns

PMReal the gutter value for the columns use.

virtual bool16 IColumnPrefs::GetLocked ( )

pure virtual

Get if columns are locked (kTrue) or not (kFalse). When locked, prevents user from dragging with the pointer tool.

Returns

bool16 the lock state

virtual bool16 IColumnPrefs::GetLocked_DURING_CONVERSION_ONLY ( )

pure virtual

Get the lock state for the columns. DO NOT USE, used for conversion only.

virtual int32 IColumnPrefs::GetNumColumns ( )

pure virtual

Get the number of columns. Will be at least 1.

Returns

int32

virtual void IColumnPrefs::SetColor ( const UID  uiColorUID )

pure virtual

Set the UI color by UID for the columns.

Parameters

uiColorUID

the UID of the UI color to use for drawing the column lines.

See Also

IUIColorUtils.h

virtual void IColumnPrefs::SetColumnOrientation_2 ( IColumns::ColumnOrientation  direction )

pure virtual

Set the default column direction (J feature set). kTrue == vertical, kFalse == horizontal.

Parameters

direction

kTrue for J columns, kFalse for Roman style.

virtual void IColumnPrefs::SetGutter ( const PMReal &  gutter )

pure virtual

Set the default gutter value (in points).

Parameters

gutter

the PMReal value to use.

virtual void IColumnPrefs::SetLocked ( const bool16  bLocked )

pure virtual

Set whether columns are locked (kTrue) or not (kFalse). When locked, prevents user from dragging with the pointer tool.

Parameters

bLocked

a bool16 value (kTrue or kFalse)

virtual void IColumnPrefs::SetNumColumns ( const int32 &  numColumns )

pure virtual

Set the default number of columns per page.

Parameters

numColumns