CXmListCtrl Class Reference

Inheritance diagram for CXmListCtrl:

List of all members.

Detailed Description

A switchable tree/list control displaying objects in multiple columns.

A list control can have an unlimited number of various columns. Each column can assigned a name the width and a style (see XM_LISTCOL_SYTLE) which have to be set when inserting a new column. The different column formats are:

Edit column: Display data as strings and edit them via an edit control
Checkbox column: Display and modify data via a checkbox.
Progress bar column: Display and modify data via a progress bar.
Radio button column: Display and modify data via a radio button. Radio buttons makes sence only, if you provide two or more radio buttions to have a real choice.
Object column: Display an object as defined by exom::XmObject::ObjLook().
Object type column: Display the type of an object.

Other controls can be connected to the selection of a list/tree control by refering its selection. Which can be accessed by GetPermanentSel() or GetSelPath().

The view mode (list/tree) can be changed by user interface during runetime.

Public Member Functions

virtual bool InsertColumnEdit (const XmPath &p, int width, const char *name=NULL, DWORD flags=0)=0

Insert a column, which display the cell data with string.

virtual bool InsertColumnCheckbox (const XmPath &p, int width, const char *name=NULL, DWORD flags=0)=0

Insert a column, which display the cell data by a checkbox.

virtual bool InsertColumnProgress (const XmPath &p, int width, const char *name=NULL, DWORD flags=0)=0

Insert a column, which display the cell data by a progress bar.

virtual bool InsertColumnRadio (const XmPath &p, const XmData &val, int width, const char *name=NULL, DWORD flags=0)=0

Insert a column, which display the cell data by a radio button.

virtual bool InsertColumnObjLook (int width, const char *name=NULL, DWORD flags=0)=0

Insert a column, which display the object as defined by XmObject::ObjLook().

virtual bool InsertColumnObjType (exom::LABEL_TYPE label, int width, const char *name=NULL, DWORD flags=0)=0

Insert a column, which display the type of an object.

virtual const XmPath & GetPermanentSel () const =0

Return the permanent selection.

virtual const XmPath & GetSelPath () const =0

Return the current selection.

virtual const XmPath & GetContainerPath () const =0

Return the path of the base container.

virtual const XmPath & GetCurContainer () const =0

Return the current selected container.

virtual void SetContFilter (XmObjectFilter *filter)=0

Set an optional object filter.

virtual void RefreshList ()=0

Refresh the content of the list.

virtual bool NavigateToListPath (const XmPath &p)=0

Navigate and select the object indicated by the given path.

Overridables - XmObject

XMOBJ ObjectID () const

Return the ID of an object.

void manage (XmMan &m)

Provide the possibility to connect member data and sub objects.

Public Attributes

CXmFindHandler * m_ListFindHandler

Handler for search issues.

Member Function Documentation

XMOBJ ObjectID ( ) const [inline, virtual]

Return the ID of an object.
The ID give the exom framework the possibility to identify a class derived from XmObject. So all classes derived from XmObject should have their own ID.
Implements XmObject.

void manage ( XmMan & m ) [inline, virtual]

Provide the possibility to connect member data and sub objects.
Member data and sub objects can be connected, by calling the corresponding manXxx functions of XmMan.
Implements XmObject.