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

#include <IChoiceListAttr.h>

Inheritance diagram for IChoiceListAttr:
IPMUnknown

Public Member Functions

virtual void Insert (int32 inBeforeIndex, const PMString &inChoice)=0
 
virtual void Append (const PMString &inChoice)=0
 
virtual void Remove (int32 inAtIndex)=0
 
virtual void Clear ()=0
 
virtual void Set (int32 inIndex, const PMString &inChoice)=0
 
virtual void Get (int32 inIndex, PMString *outChoice) const =0
 
virtual int32 Size () const =0
 
virtual int32 Index (PMString &inChoice) const =0
 
virtual void Sort ()=0
 
virtual int32 GetSortedIndex (PMString &choice) 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

This is the data interface for a Choice List graphic attribute. The Choice List attribute is used to store the choices in List Box and Combo Box form field page items.

Member Function Documentation

virtual void IChoiceListAttr::Append (const PMString & inChoice)
pure virtual

Add a choice to the end of the list

virtual void IChoiceListAttr::Clear ()
pure virtual

Erase all choices in the list

virtual void IChoiceListAttr::Get (int32 inIndex,
PMString * outChoice 
) const
pure virtual

Get a choice at an index

Parameters
inIndex,positionof choice , on exit the Choice information
virtual int32 IChoiceListAttr::GetSortedIndex (PMString & choice) const
pure virtual
Returns
the index at which the choice should be inserted in a sorted list.
virtual int32 IChoiceListAttr::Index (PMString & inChoice) const
pure virtual
Returns
the index of the choice if the choice exists. If the choice does not exist, it will return -1.
virtual void IChoiceListAttr::Insert (int32 inBeforeIndex,
const PMString & inChoice 
)
pure virtual

Insert a new choice into the choice list

virtual void IChoiceListAttr::Remove (int32 inAtIndex)
pure virtual

Remove a choice at an index

virtual void IChoiceListAttr::Set (int32 inIndex,
const PMString & inChoice 
)
pure virtual

Change a choice at an index

virtual int32 IChoiceListAttr::Size () const
pure virtual
Returns
number of choices
virtual void IChoiceListAttr::Sort ()
pure virtual

Sort the choices in the list