InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
DropDownListControlDataOf< T > Class Template Reference
Inheritance diagram for DropDownListControlDataOf< T >:
CPMUnknown< IListControlDataOf< T > >IListControlDataOf< T >IListControlDataIPMUnknown

Public Member Functions

 DropDownListControlDataOf (IPMUnknown *boss)
 
virtual void Add (const T &item, int32 at, bool16 invalidate, bool16 notifyOfChange)
 
virtual void Add (const K2Vector< T > &items, bool16 invalidate, bool16 notifyOfChange)
 
virtual void Remove (int32 index, bool16 invalidate, bool16 notifyOfChange)
 
virtual void Replace (const T &item, int32 index, bool16 invalidate, bool16 notifyOfChange)
 
virtual void Clear (bool16 invalidate, bool16 notifyOfChange)
 
virtual T operator[] (int32 index) const
 
virtual int32 Length () const
 
virtual void Refresh () const
 
virtual void Synchronize (SysControl sysControl) const
 
- Public Member Functions inherited from CPMUnknown< IListControlDataOf< T > >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Public Types inherited from IListControlDataOf< T >
enum  { kBeginning = 0, kEnd = -2 }
 
- Protected Member Functions inherited from CPMUnknown< IListControlDataOf< T > >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IListControlDataOf< T > >
HelperInterface fHelperInterface
 

Member Function Documentation

template<class T >
virtual void DropDownListControlDataOf< T >::Add (const T & item,
int32 at,
bool16 invalidate,
bool16 notifyOfChange 
)
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

Implements IListControlDataOf< T >.

template<class T >
virtual void DropDownListControlDataOf< T >::Add (const K2Vector< T > & items,
bool16 invalidate,
bool16 notifyOfChange 
)
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

Implements IListControlDataOf< T >.

template<class T >
virtual void DropDownListControlDataOf< T >::Clear (bool16 invalidate,
bool16 notifyOfChange 
)
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

Implements IListControlData.

template<class T >
virtual int32 DropDownListControlDataOf< T >::Length () const
virtual

How many items are in the list?

Returns
count of items in the list

Implements IListControlData.

template<class T >
virtual T DropDownListControlDataOf< T >::operator[] (int32 index) const
virtual

Return the nth item.

Returns
item at given position in the list

Implements IListControlDataOf< T >.

template<class T >
virtual void DropDownListControlDataOf< T >::Refresh () const
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.

Implements IListControlData.

template<class T >
virtual void DropDownListControlDataOf< T >::Remove (int32 index,
bool16 invalidate,
bool16 notifyOfChange 
)
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

Implements IListControlData.

template<class T >
virtual void DropDownListControlDataOf< T >::Replace (const T & item,
int32 index,
bool16 invalidate,
bool16 notifyOfChange 
)
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

Implements IListControlDataOf< T >.

template<class T >
virtual void DropDownListControlDataOf< T >::Synchronize (SysControl sysControl) const
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.

Implements IListControlData.