#include <IStringListBoxControlData.h>
|
| enum | { kBeginning = 0, kEnd = -2 } |
| |
| enum | { kDefaultIID = IID_ILISTCONTROLDATA } |
| |
|
| 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 |
| |
| 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 |
| |
| virtual IPMUnknown * | QueryInterface (PMIID interfaceID) const =0 |
| |
| virtual void | AddRef () const =0 |
| |
| virtual void | Release () const =0 |
| |
Interface representing a PMString based listbox data-model.
| virtual void IStringListBoxControlData::Add | ( | const PMString & | item, | | | int32 | at = kEnd, | | | bool16 | invalidate = kTrue, | | | bool16 | notifyOfChange = kTrue | | ) | | |
| pure virtual |
Add an item to the list.
- Parameters
| item | entity to add to the list |
| at | position to add item at |
| invalidate | specifies whether control should be invalidated |
| notifyOfChange | specifies 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
| items | collection of new items to add into list |
| invalidate | specifies whether control should be invalidated |
| notifyOfChange | specifies 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 PMString & | item, | | | int32 | index, | | | bool16 | invalidate = kTrue, | | | bool16 | notifyOfChange = kTrue | | ) | | |
| pure virtual |
Replace the nth item.
- Parameters
| item | specifies new item |
| index | specifies position where item to be replaced is |
| invalidate | specifies whether control should be invalidated |
| notifyOfChange | specifies whether registered observers should be notified of this change to the data model |