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

#include <IStaticMultiLineTextAttr.h>

Inheritance diagram for IStaticMultiLineTextAttr:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISTATICMULTILINETEXTATTR }
 

Public Member Functions

virtual WidgetID GetScrollBarWidgetID () const =0
 
virtual int32 GetFontID () const =0
 
virtual int32 GetNumPixelsBetweenLines () const =0
 
virtual PMPoint GetInset () const =0
 
virtual void SetScrollBarWidgetID (const WidgetID &widgetID)=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 for getting the attributes of a StaticMultiLineTextAttr widget.

Member Function Documentation

virtual int32 IStaticMultiLineTextAttr::GetFontID () const
pure virtual

Get the font ID for the widget.

Returns
the fontID for the widget's text output.
virtual PMPoint IStaticMultiLineTextAttr::GetInset () const
pure virtual

Get the x and y inset for the text display within the widget frame.

Returns
a PMPoint containing the x and y insets (positive values).
virtual int32 IStaticMultiLineTextAttr::GetNumPixelsBetweenLines () const
pure virtual

Get the number of pixels between lines in the widget.

Returns
the number of pixels.
virtual WidgetID IStaticMultiLineTextAttr::GetScrollBarWidgetID () const
pure virtual

Get the widgetID of the associated scrollbar.

Returns
the widgetID for the scrollbar associated with this static multi-line text widget.
virtual void IStaticMultiLineTextAttr::SetScrollBarWidgetID (const WidgetIDwidgetID)
pure virtual

Get the widgetID of the associated scrollbar. Note: Setting the widgetID does not automatically cause the static multi-line text widget to redraw. To ensure that the new widget is used, you must force the dialog to re-layout.

Returns
the widgetID for the scrollbar associated with this static multi-line text widget.