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

#include <ITextAttrBreakBeforeMode.h>

Inheritance diagram for ITextAttrBreakBeforeMode:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTATTRBREAKBEFOREMODE }
 
typedef Text::StartBreakLocation ValueType
 

Public Member Functions

void Set (ValueType flag)
 
ValueType Get () const
 
virtual void SetBreakMode (ValueType breakMode)=0
 
virtual ValueType GetBreakMode () 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

ITextAttrBreakMode is a simple data interface that is used to hold the desired break mode which influences where the paragraph composes: Text::kNoForcedBreak, Text::kAtColumn, Text::kAtPage, Text::kAtFrameBox, Text::kAtOddPage and Text::kAtEvenPage.

Member Function Documentation

ValueType ITextAttrBreakBeforeMode::Get (void ) const
inline

Get the value

Returns
the break mode
virtual ValueType ITextAttrBreakBeforeMode::GetBreakMode () const
pure virtual

Get the value

Returns
the break mode
void ITextAttrBreakBeforeMode::Set (ValueType flag)
inline

Set the value

Parameters
flagspecifies the break mode
virtual void ITextAttrBreakBeforeMode::SetBreakMode (ValueType breakMode)
pure virtual

Set the value

Parameters
breakModelspecifies the break mode