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

#include <IStateListData.h>

Inheritance diagram for IStateListData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISTATELISTDATA }
 

Public Member Functions

virtual void Append (Form::AppearanceState state)=0
 
virtual Form::AppearanceState Get (uint32 n) const =0
 
virtual uint32 Length () const =0
 
virtual void Clear ()=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

Used as a parameter interface for command bosses that take a list of appearance states as input or output.

Member Function Documentation

virtual void IStateListData::Append (Form::AppearanceState state)
pure virtual

Add a new state to the list, unless the state is already in the list.

Parameters
state- the new state to be added
virtual void IStateListData::Clear ()
pure virtual

Clear the list.

virtual Form::AppearanceState IStateListData::Get (uint32 n) const
pure virtual

Get the nth state.

Parameters
nis the position of the state in the list that you want (must be less than Length)
Returns
the nth state. (if n is out of range, kStateInvalid)
virtual uint32 IStateListData::Length () const
pure virtual
Returns
the number of states in the list