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

#include <IStaticTextAttributes.h>

Inheritance diagram for IStaticTextAttributes:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISTATICTEXTATTRIBUTES }
 

Public Member Functions

virtual void SetAlignment (const int16 alignment)=0
 
virtual int16 GetAlignment () const =0
 
virtual void SetEllipsizeStyle (const EllipsizeStyle ellipsizeStyle)=0
 
virtual EllipsizeStyle GetEllipsizeStyle () const =0
 
virtual void SetConvertAmpersandsToUnderline (const bool16 convertAmpersands)=0
 
virtual bool16 GetConvertAmpersandsToUnderline () const =0
 
virtual void SetDrawUnderline (const bool16 drawUnderline)=0
 
virtual bool16 GetDrawUnderline () 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 responsible for getting and setting various attributes of static text widgets

See Also
WidgetDefs.h

Member Function Documentation

virtual int16 IStaticTextAttributes::GetAlignment () const
pure virtual

Get the alignment of the text within its bounding box.

Returns
current alignment value. Should be one of {kAlignLeft,kAlignCenter,kAlignRight}, defined in WidgetDefs.h
virtual bool16 IStaticTextAttributes::GetConvertAmpersandsToUnderline () const
pure virtual

Get whether or not to convert ampersands to underline.

Returns
current setting for convert ampersands to underline.
virtual bool16 IStaticTextAttributes::GetDrawUnderline () const
pure virtual

Get whether or not to convert to underline the text.

Returns
current setting for underline.
virtual EllipsizeStyle IStaticTextAttributes::GetEllipsizeStyle () const
pure virtual

Get the current ellipsize style of the text in case it does not fit within its bounding box.

Returns
current ellipsize Style. Should be one of {kDontEllipsize, kTrue,kEllipsizeEnd, kTruekEllipsizeBeginning,kEllipsizeMiddle}.
virtual void IStaticTextAttributes::SetAlignment (const int16 alignment)
pure virtual

Set the alignment of the text within its bounding box.

Parameters
alignmentone of {kAlignLeft,kAlignCenter,kAlignRight}, defined in WidgetDefs.h
virtual void IStaticTextAttributes::SetConvertAmpersandsToUnderline (const bool16 convertAmpersands)
pure virtual

Set whether or not to convert ampersands to underline.

Parameters
convertAmpersandskTrue to convert ampersands to underline; otherwise, kFalse.
virtual void IStaticTextAttributes::SetDrawUnderline (const bool16 drawUnderline)
pure virtual

Set whether or not to draw an underline for the text

Parameters
drawUnderlinekTrue to draw underline; otherwise, kFalse.
virtual void IStaticTextAttributes::SetEllipsizeStyle (const EllipsizeStyle ellipsizeStyle)
pure virtual

Set the ellipsize style of the text in case it does not fit within its bounding box.

Parameters
ellipsizeStyleone of {kDontEllipsize, kTrue,kEllipsizeEnd, kTruekEllipsizeBeginning,kEllipsizeMiddle}