InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IEditBoxAttributes Class Referenceabstract

#include <IEditBoxAttributes.h>

Inheritance diagram for IEditBoxAttributes:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IEDITBOXATTRIBUTES }
 

Public Member Functions

virtual void SetNudgeButtonWidgetID (const WidgetID &nudgeButton)=0
 
virtual WidgetID GetNudgeButtonWidgetID () const =0
 
virtual void SetSmallNudgeAmount (const PMReal &increment)=0
 
virtual PMReal GetSmallNudgeAmount () const =0
 
virtual void SetLargeNudgeAmount (const PMReal &increment)=0
 
virtual PMReal GetLargeNudgeAmount () const =0
 
virtual CharCounter GetMaxNumChars () const =0
 
virtual void SetMaxNumChars (const CharCounter &maxNumChars)=0
 
virtual bool16 IsEditboxReadOnly () const =0
 
virtual void SetEditboxReadOnly (const bool16 &readOnly)=0
 
virtual bool16 ShouldNotifyEveryStroke () const =0
 
virtual void SetNotifyEveryStroke (const bool16 &flag)=0
 
virtual void SelectRange (const CharCounter &startOfRange, const CharCounter &endOfRange=kEndOfRange)=0
 
virtual CharCounter GetStartOfSelection () const =0
 
virtual CharCounter GetEndOfSelection () const =0
 
virtual bool16 IsMultiLine () 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 which maintains current editbox settings.

Member Function Documentation

virtual CharCounter IEditBoxAttributes::GetEndOfSelection () const
pure virtual

Get the end index of the selected text

Returns
the end index for the selection in the editbox.
virtual PMReal IEditBoxAttributes::GetLargeNudgeAmount () const
pure virtual

Get the large nudge amount to use for the associated nudge button widget. Note that for editboxes which use a measurement system, the measurement system defines it's own large and small nudge amount, so this number is used as a multiplier of the base UOM nudge amount.

See Also
IUnitOfMeasure
Returns
large nudge amount to use.
virtual CharCounter IEditBoxAttributes::GetMaxNumChars () const
pure virtual

Get the max number of characters which can be input into this editbox. The editbox will prevent users from entering more than this number of characters.

Returns
max allowed characters
virtual WidgetID IEditBoxAttributes::GetNudgeButtonWidgetID () const
pure virtual

Get the widget ID for the associated nudge button widget

Returns
the nudge button that goes with this editbox.
virtual PMReal IEditBoxAttributes::GetSmallNudgeAmount () const
pure virtual

Get the small nudge amount to use for the associated nudge button widget. Note that for editboxes which use a measurement system, the measurement system defines it's own large and small nudge amount, so this number is used as a multiplier of the base UOM nudge amount.

See Also
IUnitOfMeasure
Returns
small nudge amount to use.
virtual CharCounter IEditBoxAttributes::GetStartOfSelection () const
pure virtual

Get the beginning index of the selected text

Returns
the beginning index for the selection in the editbox.
virtual bool16 IEditBoxAttributes::IsEditboxReadOnly () const
pure virtual

Check if this editbox is read only. Users cannot type in editboxes which are marked read-only.

Returns
kTrue if this editbox is read only.
virtual bool16 IEditBoxAttributes::IsMultiLine () const
pure virtual

Check if this editbox supports multiple lines. Most editboxes do not.

Returns
kTrue if this editbox does support multiple lines.
virtual void IEditBoxAttributes::SelectRange (const CharCounter & startOfRange,
const CharCounter & endOfRange = kEndOfRange 
)
pure virtual

Select a range of text in the editbox.

Parameters
startOfRangethe beginning index for the new selection.
endOfRangethe ending index for the new selection.
virtual void IEditBoxAttributes::SetEditboxReadOnly (const bool16 & readOnly)
pure virtual

Set if this editbox is read only. Users cannot type in editboxes which are marked read-only.

Parameters
readOnlykTrue if this editbox is now read only.
virtual void IEditBoxAttributes::SetLargeNudgeAmount (const PMReal & increment)
pure virtual

Set the large nudge amount to use for the associated nudge button widget. Note that for editboxes which use a measurement system, the measurement system defines it's own large and small nudge amount, so this number is used as a multiplier of the base UOM nudge amount.

See Also
IUnitOfMeasure
Parameters
incrementlarge nudge amount to use.
virtual void IEditBoxAttributes::SetMaxNumChars (const CharCounter & maxNumChars)
pure virtual

Set the max number of characters which can be input into this editbox. The editbox will prevent users from entering more than this number of characters.

Parameters
maxNumCharsnewmaximum allowed characters
virtual void IEditBoxAttributes::SetNotifyEveryStroke (const bool16 & flag)
pure virtual

Set if this editbox needs to notify after every keystroke. Usually editboxes only notify that their text has changed when the editbox looses the text focus. If a particular observer cares to enable/disable or do something else based on every keystroke, you need to turn this flag on.

Parameters
flagkTrue if this editbox should notify after every keystroke.
virtual void IEditBoxAttributes::SetNudgeButtonWidgetID (const WidgetID & nudgeButton)
pure virtual

Set the widget ID for the associated nudge button widget

Parameters
nudgeButtonthe nudge button that goes with this editbox.
virtual void IEditBoxAttributes::SetSmallNudgeAmount (const PMReal & increment)
pure virtual

Set the small nudge amount to use for the associated nudge button widget. Note that for editboxes which use a measurement system, the measurement system defines it's own large and small nudge amount, so this number is used as a multiplier of the base UOM nudge amount.

See Also
IUnitOfMeasure
Parameters
incrementsmall nudge amount to use.
virtual bool16 IEditBoxAttributes::ShouldNotifyEveryStroke () const
pure virtual

Check if this editbox needs to notify after every keystroke. Usually editboxes only notify that their text has changed when the editbox looses the text focus. If a particular observer cares to enable/disable or do something else based on every keystroke, you need to turn this flag on.

Returns
kTrue if this editbox is notifying on every keystroke.