ITextColumnData Class Reference

#include <ITextColumnData.h>

Inheritance diagram for ITextColumnData:

Public Types
enum	{ kDefaultIID = IID_ITEXTCOLUMNDATA }

Public Member Functions
virtual void	SetNumberOfColumns (int32 columns=1)=0
virtual int32	GetNumberOfColumns () const =0
virtual PMReal	GetGutterWidth () const =0
virtual void	SetGutterWidth (PMReal width)=0
virtual void	UseFixedColumnSizing (int16 fixedSize=kTrue)=0
virtual int16	IsFixedColumnSizing () const =0
virtual void	SetFixedWidth (const PMReal &width)=0
virtual PMReal	GetFixedWidth () const =0
virtual void	SetHeight (const PMReal &height)=0
virtual PMReal	GetHeight () const =0
virtual void	UseFlexibleColumnSizing (int16 flexibleSize=kTrue)=0
virtual int16	IsFlexibleColumnSizing () const =0
virtual void	SetFlexibleWidthMax (const PMReal &max)=0
virtual PMReal	GetFlexibleWidthMax () 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 to manage columns within a text frame.

Note

Only applies to a multi-column frame boss. That boss also supports the IMultiColumnTextFrame interface. This object (the multi-column frame) is a container for columns. Each column also supports the ITextFrameColumn interface. The columns also appear in the associated frame list (IFrameList). See the Programming Guide for more information on the text frame hierarchy.

Member Function Documentation

virtual PMReal ITextColumnData::GetFixedWidth ( ) const

pure virtual

Get the width of the (fixed) column(s).

Note

valid with fixed column sizes only

virtual PMReal ITextColumnData::GetFlexibleWidthMax ( ) const

pure virtual

Get the maximum width of a column(s).

Note

valid with flexible column sizes only

virtual PMReal ITextColumnData::GetGutterWidth ( ) const

pure virtual

Get the gutter width for the frame.

virtual PMReal ITextColumnData::GetHeight ( ) const

pure virtual

Get the height of the column(s).

virtual int32 ITextColumnData::GetNumberOfColumns ( ) const

pure virtual

Get the number of columns in the frame.

virtual int16 ITextColumnData::IsFixedColumnSizing ( ) const

pure virtual

Check whether or not the columns are a fixed size or not.

virtual int16 ITextColumnData::IsFlexibleColumnSizing ( ) const

pure virtual

Check whether or not the columns are a flexible size or not.

virtual void ITextColumnData::SetFixedWidth ( const PMReal &  width )

pure virtual

Set the width of the (fixed) column(s).

Note

valid with fixed column sizes only

virtual void ITextColumnData::SetFlexibleWidthMax ( const PMReal &  max )

pure virtual

Set the maximum width of a column.

Note

valid with flexible column sizes only

virtual void ITextColumnData::SetGutterWidth ( PMReal  width )

pure virtual

Set the gutter width for the frame.

virtual void ITextColumnData::SetHeight ( const PMReal &  height )

pure virtual

Set the height of all column(s).

virtual void ITextColumnData::SetNumberOfColumns ( int32  columns = 1 )

pure virtual

Set the number of columns in the frame (default parameter of 1 column)

virtual void ITextColumnData::UseFixedColumnSizing ( int16  fixedSize = kTrue )

pure virtual

Set whether or not the columns should be a fixed size or not.

virtual void ITextColumnData::UseFlexibleColumnSizing ( int16  flexibleSize = kTrue )

pure virtual

Set whether or not the columns should be a flexible size or not.