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

#include <IListControlData.h>

Inheritance diagram for IListControlData:
IPMUnknownIListControlDataOf< T >IStringListBoxControlDataIViewListBoxControlDataCPMUnknown< IListControlDataOf< T > >CListControlDataOf< T >DropDownListControlDataOf< T >

Public Types

enum  { kDefaultIID = IID_ILISTCONTROLDATA }
 

Public Member Functions

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 part of listbox data-model. See also IListControlDataOf for residual.

Member Function Documentation

virtual void IListControlData::Clear (bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Clear the list, that is, remove all elements.

Parameters
invalidatespecifies whether control should be invalidated
notifyOfChangespecifies if registered observers should be notified about this change to the data model

Implemented in CListControlDataOf< T >, and DropDownListControlDataOf< T >.

virtual int32 IListControlData::Length () const
pure virtual

How many items are in the list?

Returns
count of items in the list

Implemented in CListControlDataOf< T >, and DropDownListControlDataOf< T >.

virtual void IListControlData::Refresh () const
pure virtual

Synchronize the data stored in IListControlData with the tree control.

Note: Refresh is acutally an implementation detail and doesn't seem right to be in this interface.

Implemented in CListControlDataOf< T >, and DropDownListControlDataOf< T >.

virtual void IListControlData::Remove (int32 index,
bool16 invalidate = kTrue,
bool16 notifyOfChange = kTrue 
)
pure virtual

Remove item by index.

Parameters
indexposition of item to remove from list
invalidatespecifies whether control should be invalidated
notifyOfChangespecifies if registered observers should be notified about this change to the data model

Implemented in CListControlDataOf< T >, and DropDownListControlDataOf< T >.

virtual void IListControlData::Synchronize (SysControl sysControl) const
pure virtual

Synchronize the data stored in IListControlData with the sysControl. Typically it's called right after the sysControl is created.

Note: Synchronize is acutally an implementation detail and doesn't seem right to be in this interface. However, IListControlDataOf <T> (which derives from IListControlData) is a template based interface and we want to avoid templatizing the IControlView interface.

Implemented in DropDownListControlDataOf< T >.