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

#include <ITextColumnSizer.h>

Inheritance diagram for ITextColumnSizer:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTCOLUMNSIZER }
 
enum  minimumColumnWidth { kMinimumValidInUIColumnWidth = 3 }
 
enum  minimumColumnHeight { kMinimumValidInUIColumnHeight = 3 }
 

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 (bool16 fixedSize=kTrue)=0
 
virtual bool16 IsFixedColumnSizing () const =0
 
virtual void SetFixedWidth (PMReal width)=0
 
virtual PMReal GetFixedWidth () const =0
 
virtual void SetHeight (PMReal height)=0
 
virtual PMReal GetHeight () const =0
 
virtual void UseFlexibleColumnSizing (bool16 flexibleSize=kTrue)=0
 
virtual bool16 IsFlexibleColumnSizing () const =0
 
virtual void SetFlexibleWidthMax (PMReal maxWidth)=0
 
virtual PMReal GetFlexibleWidthMax () const =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 to manage columns within a text frame.

Note
Only applies to a multi-column frame boss with a IMultiColumnTextFrame interface. This object (the multi-column frame) is a 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 Enumeration Documentation

This is the minimum width and height a text frame can be set to. Prior to CS4 this was set to 12 but it was easy to specify a J FrameGrid based on a point size of 9. The value here is somewhat arbitrary - it needs to be greater than one in order to avoid problems with loaded placeguns which have a spline size of 1x1.

Member Function Documentation

virtual PMReal ITextColumnSizer::GetFixedWidth () const
pure virtual

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

Note
valid with fixed column sizes only
virtual PMReal ITextColumnSizer::GetFlexibleWidthMax () const
pure virtual

Get the min width of the flexible-sizing column(s).

Note
valid with flexible column sizes only
virtual PMReal ITextColumnSizer::GetGutterWidth () const
pure virtual

Get the gutter width for the frame.

virtual PMReal ITextColumnSizer::GetHeight () const
pure virtual

Get the height of all column(s).

virtual int32 ITextColumnSizer::GetNumberOfColumns () const
pure virtual

Get the number of columns in the frame.

virtual bool16 ITextColumnSizer::IsFixedColumnSizing () const
pure virtual

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

virtual bool16 ITextColumnSizer::IsFlexibleColumnSizing () const
pure virtual

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

virtual void ITextColumnSizer::SetFixedWidth (PMReal width)
pure virtual

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

Note
valid with fixed column sizes only
virtual void ITextColumnSizer::SetFlexibleWidthMax (PMReal maxWidth)
pure virtual

Set the maximum width of the column(s).

Note
valid with flexible column sizing only
virtual void ITextColumnSizer::SetGutterWidth (PMReal width)
pure virtual

Set the gutter width for the frame.

virtual void ITextColumnSizer::SetHeight (PMReal height)
pure virtual

Set the height of all column(s).

virtual void ITextColumnSizer::SetNumberOfColumns (int32 columns = 1)
pure virtual

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

virtual void ITextColumnSizer::UseFixedColumnSizing (bool16 fixedSize = kTrue)
pure virtual

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

virtual void ITextColumnSizer::UseFlexibleColumnSizing (bool16 flexibleSize = kTrue)
pure virtual

Set whether or not the columns should use the min and max sizes or not.