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

#include <IStringListBoxControlData.h>

Inheritance diagram for IStringListBoxControlData:
IListControlDataIPMUnknown

Public Types

enum  { kBeginning = 0, kEnd = -2 }
 
- Public Types inherited from IListControlData
enum  { kDefaultIID = IID_ILISTCONTROLDATA }
 

Public Member Functions

virtual void Add (const PMString &item, int32 at=kEnd, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual void Add (const K2Vector< PMString > &items, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual void Replace (const PMString &item, int32 index, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual PMString operator[] (int32 index) const =0
 
virtual int32 GetIDAt (int32 index) const =0
 
- Public Member Functions inherited from IListControlData
virtual void Remove (int32 index, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual void Clear (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
 
virtual int32 Length () const =0
 
virtual void Refresh () const =0
 
virtual void Synchronize (SysControl sysControl) 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 representing a PMString based listbox data-model.

Member Function Documentation

virtual void IStringListBoxControlData::Add (const PMStringitem,
int32 at = kEnd,
bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Add an item to the list.

Parameters
itementity to add to the list
atposition to add item at
invalidatespecifies whether control should be invalidated
notifyOfChangespecifies whether registered observers should be notified of this change to the data model
virtual void IStringListBoxControlData::Add (const K2Vector< PMString > & items,
bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Add a list of items to the list.

Parameters
itemscollection of new items to add into list
invalidatespecifies whether control should be invalidated
notifyOfChangespecifies whether registered observers should be notified of this change to the data model
virtual int32 IStringListBoxControlData::GetIDAt (int32 index) const
pure virtual

Return the id of the nth item. ID's are a unique integer assigned to the string when it is added. This id is used by the underlying tree control to track tree nodes in the list.

Returns
item at given position in the list
virtual PMString IStringListBoxControlData::operator[] (int32 index) const
pure virtual

Return the nth item.

Returns
item at given position in the list
virtual void IStringListBoxControlData::Replace (const PMStringitem,
int32 index,
bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Replace the nth item.

Parameters
itemspecifies new item
indexspecifies position where item to be replaced is
invalidatespecifies whether control should be invalidated
notifyOfChangespecifies whether registered observers should be notified of this change to the data model