Version: 2.9.4
Public Member Functions
wxTreeListCtrl Class Reference

#include </home/zeitlin/src/wx/github/interface/wx/treelist.h>

Inheritance diagram for wxTreeListCtrl:

Detailed Description

A control combining wxTreeCtrl and wxListCtrl features.

This is a multi-column tree control optionally supporting images and checkboxes for the items in the first column.

It is currently implemented using wxDataViewCtrl internally but provides a much simpler interface for the common use case it addresses. Thus, one of the design principles for this control is simplicity and intentionally doesn't provide all the features of wxDataViewCtrl. Most importantly, this class stores all its data internally and doesn't require you to define a custom model for it.

Instead, this controls works like wxTreeCtrl or non-virtual wxListCtrl and allows you to simply add items to it using wxTreeListCtrl::AppendItem() and related methods. Typically, you start by setting up the columns (you must have at least one) by calling wxTreeListCtrl::AppendColumn() and then add the items. While only the text of the first column can be specified when adding them, you can use wxTreeListCtrl::SetItemText() to set the text of the other columns.

Unlike wxTreeCtrl or wxListCtrl this control can sort its items on its own. To allow user to sort the control contents by clicking on some column you should use wxCOL_SORTABLE flag when adding that column to the control. When a column with this flag is clicked, the control resorts itself using the values in this column. By default the sort is done using alphabetical order comparison of the items text, which is not always correct (e.g. this doesn't work for the numeric columns). To change this you may use SetItemComparator() method to provide a custom comparator, i.e. simply an object that implements comparison between the two items. The treelist sample shows an example of doing this. And if you need to sort the control programmatically, you can call SetSortColumn() method.

Here are the styles supported by this control. Notice that using wxTL_USER_3STATE implies wxTL_3STATE and wxTL_3STATE in turn implies wxTL_CHECKBOX.

Styles

This class supports the following styles:

Events using this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxTreeListEvent& event)

Event macros:

Library:  wxAdvanced
Category:  Controls
Since:
2.9.3
参照:
wxTreeCtrl, wxDataViewCtrl
static const int NO_IMAGE = -1
 Image list methods.
void AssignImageList (wxImageList *imageList)
 Sets the image list and gives its ownership to the control.
void SetImageList (wxImageList *imageList)
 Sets the image list.

Public Member Functions

 wxTreeListCtrl ()
 Default constructor, call Create() later.
 wxTreeListCtrl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTL_DEFAULT_STYLE, const wxString &name=wxTreeListCtrlNameStr)
 Full constructing, creating the object and its window.
bool Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTL_DEFAULT_STYLE, const wxString &name=wxTreeListCtrlNameStr)
 Create the control window.
int AppendColumn (const wxString &title, int width=wxCOL_WIDTH_AUTOSIZE, wxAlignment align=wxALIGN_LEFT, int flags=wxCOL_RESIZABLE)
 Column methods.
unsigned GetColumnCount () const
 Return the total number of columns.
bool DeleteColumn (unsigned col)
 Delete the column with the given index.
void ClearColumns ()
 Delete all columns.
void SetColumnWidth (unsigned col, int width)
 Change the width of the given column.
int GetColumnWidth (unsigned col) const
 Get the current width of the given column in pixels.
int WidthFor (const wxString &text) const
 Get the width appropriate for showing the given text.
wxTreeListItem AppendItem (wxTreeListItem parent, const wxString &text, int imageClosed=NO_IMAGE, int imageOpened=NO_IMAGE, wxClientData *data=NULL)
 Adding and removing items.
wxTreeListItem InsertItem (wxTreeListItem parent, wxTreeListItem previous, const wxString &text, int imageClosed=NO_IMAGE, int imageOpened=NO_IMAGE, wxClientData *data=NULL)
 Insert a new item into the tree.
wxTreeListItem PrependItem (wxTreeListItem parent, const wxString &text, int imageClosed=NO_IMAGE, int imageOpened=NO_IMAGE, wxClientData *data=NULL)
 Same as InsertItem() with wxTLI_FIRST.
void DeleteItem (wxTreeListItem item)
 Delete the specified item.
void DeleteAllItems ()
 Delete all tree items.
wxTreeListItem GetRootItem () const
 Methods for the tree navigation.
wxTreeListItem GetItemParent (wxTreeListItem item) const
 Return the parent of the given item.
wxTreeListItem GetFirstChild (wxTreeListItem item) const
 Return the first child of the given item.
wxTreeListItem GetNextSibling (wxTreeListItem item) const
 Return the next sibling of the given item.
wxTreeListItem GetFirstItem () const
 Return the first item in the tree.
wxTreeListItem GetNextItem (wxTreeListItem item) const
 Get item after the given one in the depth-first tree-traversal order.
const wxStringGetItemText (wxTreeListItem item, unsigned col=0) const
 Items attributes.
void SetItemText (wxTreeListItem item, unsigned col, const wxString &text)
 Set the text of the specified column of the given item.
void SetItemText (wxTreeListItem item, const wxString &text)
 Set the text of the first column of the given item.
void SetItemImage (wxTreeListItem item, int closed, int opened=NO_IMAGE)
 Set the images for the given item.
wxClientDataGetItemData (wxTreeListItem item) const
 Get the data associated with the given item.
void SetItemData (wxTreeListItem item, wxClientData *data)
 Set the data associated with the given item.
void Expand (wxTreeListItem item)
 Expanding and collapsing tree branches.
void Collapse (wxTreeListItem item)
 Collapse the given tree branch.
bool IsExpanded (wxTreeListItem item) const
 Return whether the given item is expanded.
wxTreeListItem GetSelection () const
 Selection methods.
unsigned GetSelections (wxTreeListItems &selections) const
 Fill in the provided array with all the selected items.
void Select (wxTreeListItem item)
 Select the given item.
void Unselect (wxTreeListItem item)
 Deselect the given item.
bool IsSelected (wxTreeListItem item) const
 Return true if the item is selected.
void SelectAll ()
 Select all the control items.
void UnselectAll ()
 Deselect all the control items.
void CheckItem (wxTreeListItem item, wxCheckBoxState state=wxCHK_CHECKED)
 Checkbox handling.
void CheckItemRecursively (wxTreeListItem item, wxCheckBoxState state=wxCHK_CHECKED)
 Change the checked state of the given item and all its children.
void UncheckItem (wxTreeListItem item)
 Uncheck the given item.
void UpdateItemParentStateRecursively (wxTreeListItem item)
 Update the state of the parent item to reflect the checked state of its children.
wxCheckBoxState GetCheckedState (wxTreeListItem item) const
 Return the checked state of the item.
bool AreAllChildrenInState (wxTreeListItem item, wxCheckBoxState state) const
 Return true if all children of the given item are in the specified state.
void SetSortColumn (unsigned col, bool ascendingOrder=true)
 Sorting.
bool GetSortColumn (unsigned *col, bool *ascendingOrder=NULL)
 Return the column currently used for sorting, if any.
void SetItemComparator (wxTreeListItemComparator *comparator)
 Set the object to use for comparing the items.
wxWindowGetView () const
 View window.
wxDataViewCtrlGetDataView () const
 Return the view part of this control as wxDataViewCtrl.

List of all members.


Constructor & Destructor Documentation

wxTreeListCtrl::wxTreeListCtrl ( )

Default constructor, call Create() later.

This constructor is used during two-part construction process when it is impossible or undesirable to create the window when constructing the object.

wxTreeListCtrl::wxTreeListCtrl ( wxWindow parent,
wxWindowID  id,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
long  style = wxTL_DEFAULT_STYLE,
const wxString name = wxTreeListCtrlNameStr 
)

Full constructing, creating the object and its window.

See Create() for the parameters description.


Member Function Documentation

int wxTreeListCtrl::AppendColumn ( const wxString title,
int  width = wxCOL_WIDTH_AUTOSIZE,
wxAlignment  align = wxALIGN_LEFT,
int  flags = wxCOL_RESIZABLE 
)

Column methods.

Add a column with the given title and attributes.

Parameters:
titleThe column label.
widthThe width of the column in pixels or the special wxCOL_WIDTH_AUTOSIZE value indicating that the column should adjust to its contents. Notice that the first column is special and will be always resized to fill all the space not taken by the other columns, i.e. the width specified here is ignored for it.
alignAlignment of both the column header and its items.
flagsColumn flags, currently can include wxCOL_RESIZABLE to allow the user to resize the column and wxCOL_SORTABLE to allow the user to resort the control contents by clicking on this column.
Returns:
Index of the new column or -1 on failure.
wxTreeListItem wxTreeListCtrl::AppendItem ( wxTreeListItem  parent,
const wxString text,
int  imageClosed = NO_IMAGE,
int  imageOpened = NO_IMAGE,
wxClientData data = NULL 
)

Adding and removing items.

When adding items, the parent and text of the first column of the new item must always be specified, the rest is optional.

Each item can have two images: one used for closed state and another for opened one. Only the first one is ever used for the items that don't have children. And both are not set by default.

It is also possible to associate arbitrary client data pointer with the new item. It will be deleted by the control when the item is deleted (either by an explicit DeleteItem() call or because the entire control is destroyed). Same as InsertItem() with wxTLI_LAST.

bool wxTreeListCtrl::AreAllChildrenInState ( wxTreeListItem  item,
wxCheckBoxState  state 
) const

Return true if all children of the given item are in the specified state.

This is especially useful for the controls with wxTL_3STATE style to allow to decide whether the parent effective state should be the same state, if all its children are in it, or wxCHK_UNDETERMINED.

参照:
UpdateItemParentStateRecursively()
void wxTreeListCtrl::AssignImageList ( wxImageList imageList)

Sets the image list and gives its ownership to the control.

The image list assigned with this method will be automatically deleted by wxTreeCtrl as appropriate (i.e. it takes ownership of the list).

参照:
SetImageList().
void wxTreeListCtrl::CheckItem ( wxTreeListItem  item,
wxCheckBoxState  state = wxCHK_CHECKED 
)

Checkbox handling.

Methods in this section can only be used with the controls created with wxTL_CHECKBOX style. Change the item checked state.

Parameters:
itemValid non-root tree item.
stateOne of wxCHK_CHECKED, wxCHK_UNCHECKED or, for the controls with wxTL_3STATE or wxTL_USER_3STATE styles, wxCHK_UNDETERMINED.
void wxTreeListCtrl::CheckItemRecursively ( wxTreeListItem  item,
wxCheckBoxState  state = wxCHK_CHECKED 
)

Change the checked state of the given item and all its children.

This is the same as CheckItem() but checks or unchecks not only this item itself but all its children recursively as well.

void wxTreeListCtrl::ClearColumns ( )

Delete all columns.

参照:
DeleteAllItems()
void wxTreeListCtrl::Collapse ( wxTreeListItem  item)

Collapse the given tree branch.

bool wxTreeListCtrl::Create ( wxWindow parent,
wxWindowID  id,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
long  style = wxTL_DEFAULT_STYLE,
const wxString name = wxTreeListCtrlNameStr 
)

Create the control window.

Can be only called for the objects created using the default constructor and exactly once.

Parameters:
parentThe parent window, must be non-NULL.
idThe window identifier, may be wxID_ANY.
posThe initial window position, usually unused.
sizeThe initial window size, usually unused.
styleThe window style, see their description in the class documentation.
nameThe name of the window.

Reimplemented from wxWindow.

void wxTreeListCtrl::DeleteAllItems ( )

Delete all tree items.

bool wxTreeListCtrl::DeleteColumn ( unsigned  col)

Delete the column with the given index.

Parameters:
colColumn index in 0 to GetColumnCount() (exclusive) range.
Returns:
True if the column was deleted, false if index is invalid or deleting the column failed for some other reason.
void wxTreeListCtrl::DeleteItem ( wxTreeListItem  item)

Delete the specified item.

void wxTreeListCtrl::Expand ( wxTreeListItem  item)

Expanding and collapsing tree branches.

Notice that calling neither Expand() nor Collapse() method generates any events. Expand the given tree branch.

wxCheckBoxState wxTreeListCtrl::GetCheckedState ( wxTreeListItem  item) const

Return the checked state of the item.

The return value can be wxCHK_CHECKED, wxCHK_UNCHECKED or wxCHK_UNDETERMINED.

unsigned wxTreeListCtrl::GetColumnCount ( ) const

Return the total number of columns.

int wxTreeListCtrl::GetColumnWidth ( unsigned  col) const

Get the current width of the given column in pixels.

wxDataViewCtrl* wxTreeListCtrl::GetDataView ( ) const

Return the view part of this control as wxDataViewCtrl.

This method may return NULL in the future, non wxDataViewCtrl-based, versions of this class, use GetView() unless you really need to use wxDataViewCtrl methods on the returned object.

wxTreeListItem wxTreeListCtrl::GetFirstChild ( wxTreeListItem  item) const

Return the first child of the given item.

Item may be the root item.

Return value may be invalid if the item doesn't have any children.

wxTreeListItem wxTreeListCtrl::GetFirstItem ( ) const

Return the first item in the tree.

This is the first child of the root item.

参照:
GetNextItem()
wxClientData* wxTreeListCtrl::GetItemData ( wxTreeListItem  item) const

Get the data associated with the given item.

The returned pointer may be NULL.

It must not be deleted by the caller as this will be done by the control itself.

wxTreeListItem wxTreeListCtrl::GetItemParent ( wxTreeListItem  item) const

Return the parent of the given item.

All the tree items visible in the tree have valid parent items, only the never shown root item has no parent.

const wxString& wxTreeListCtrl::GetItemText ( wxTreeListItem  item,
unsigned  col = 0 
) const

Items attributes.

Return the text of the given item.

By default, returns the text of the first column but any other one can be specified using col argument.

wxTreeListItem wxTreeListCtrl::GetNextItem ( wxTreeListItem  item) const

Get item after the given one in the depth-first tree-traversal order.

Calling this function starting with the result of GetFirstItem() allows iterating over all items in the tree.

The iteration stops when this function returns an invalid item, i.e.

            for ( wxTreeListItem item = tree->GetFirstItem();
                  item.IsOk();
                  item = tree->GetNextItem(item) )
            {
                ... Do something with every tree item ...
            }
wxTreeListItem wxTreeListCtrl::GetNextSibling ( wxTreeListItem  item) const

Return the next sibling of the given item.

Return value may be invalid if there are no more siblings.

wxTreeListItem wxTreeListCtrl::GetRootItem ( ) const

Methods for the tree navigation.

The tree has an invisible root item which is the hidden parent of all top-level items in the tree. Starting from it it is possible to iterate over all tree items using GetNextItem().

It is also possible to iterate over just the children of the given item by using GetFirstChild() to get the first of them and then calling GetNextSibling() to retrieve all the others. Return the (never shown) root item.

wxTreeListItem wxTreeListCtrl::GetSelection ( ) const

Selection methods.

The behaviour of the control is different in single selection mode (the default) and multi-selection mode (if wxTL_MULTIPLE was specified when creating it). Not all methods can be used in both modes and some of those that can don't behave in the same way in two cases. Return the currently selected item.

This method can't be used with multi-selection controls, use GetSelections() instead.

The return value may be invalid if no item has been selected yet. Once an item in a single selection control was selected, it will keep a valid selection.

unsigned wxTreeListCtrl::GetSelections ( wxTreeListItems selections) const

Fill in the provided array with all the selected items.

This method can be used in both single and multi-selection case.

The previous array contents is destroyed.

Returns the number of selected items.

bool wxTreeListCtrl::GetSortColumn ( unsigned *  col,
bool *  ascendingOrder = NULL 
)

Return the column currently used for sorting, if any.

If the control is currently unsorted, the function simply returns false and doesn't modify any of its output parameters.

Parameters:
colReceives the index of the column used for sorting if non-NULL.
ascendingOrderReceives true or false depending on whether the items are sorted in ascending or descending order.
Returns:
true if the control is sorted or false if it isn't sorted at all.
wxWindow* wxTreeListCtrl::GetView ( ) const

View window.

This control itself is entirely covered by the "view window" which is currently a wxDataViewCtrl but if you want to avoid relying on this to allow your code to work with later versions which might not be wxDataViewCtrl-based, use GetView() function only and only use GetDataView() if you really need to call wxDataViewCtrl methods on it. Return the view part of this control as a wxWindow.

This method always returns non-NULL pointer once the window was created.

wxTreeListItem wxTreeListCtrl::InsertItem ( wxTreeListItem  parent,
wxTreeListItem  previous,
const wxString text,
int  imageClosed = NO_IMAGE,
int  imageOpened = NO_IMAGE,
wxClientData data = NULL 
)

Insert a new item into the tree.

Parameters:
parentThe item parent. Must be valid, may be GetRootItem().
previousThe previous item that this one should be inserted immediately after. It must be valid but may be one of the special values wxTLI_FIRST or wxTLI_LAST indicating that the item should be either inserted before the first child of its parent (if any) or after the last one.
imageClosedThe normal item image, may be NO_IMAGE to not show any image.
imageOpenedThe item image shown when it's in the expanded state.
dataOptional client data pointer that can be later retrieved using GetItemData() and will be deleted by the tree when the item itself is deleted.
bool wxTreeListCtrl::IsExpanded ( wxTreeListItem  item) const

Return whether the given item is expanded.

bool wxTreeListCtrl::IsSelected ( wxTreeListItem  item) const

Return true if the item is selected.

This method can be used in both single and multiple selection modes.

wxTreeListItem wxTreeListCtrl::PrependItem ( wxTreeListItem  parent,
const wxString text,
int  imageClosed = NO_IMAGE,
int  imageOpened = NO_IMAGE,
wxClientData data = NULL 
)

Same as InsertItem() with wxTLI_FIRST.

void wxTreeListCtrl::Select ( wxTreeListItem  item)

Select the given item.

In single selection mode, deselects any other selected items, in multi-selection case it adds to the selection.

void wxTreeListCtrl::SelectAll ( )

Select all the control items.

Can be only used in multi-selection mode.

void wxTreeListCtrl::SetColumnWidth ( unsigned  col,
int  width 
)

Change the width of the given column.

Set column width to either the given value in pixels or to the value large enough to fit all of the items if width is wxCOL_WIDTH_AUTOSIZE.

Notice that setting the width of the first column is ignored as this column is always resized to fill the space left by the other columns.

void wxTreeListCtrl::SetImageList ( wxImageList imageList)

Sets the image list.

The image list assigned with this method will not be deleted by the control itself and you will need to delete it yourself, use AssignImageList() to give the image list ownership to the control.

Parameters:
imageListImage list to use, may be NULL to not show any images any more.
void wxTreeListCtrl::SetItemComparator ( wxTreeListItemComparator comparator)

Set the object to use for comparing the items.

This object will be used when the control is being sorted because the user clicked on a sortable column or SetSortColumn() was called.

The provided pointer is stored by the control so the object it points to must have a life-time equal or greater to that of the control itself. In addition, the pointer can be NULL to stop using custom comparator and revert to the default alphabetical comparison.

void wxTreeListCtrl::SetItemData ( wxTreeListItem  item,
wxClientData data 
)

Set the data associated with the given item.

Previous client data, if any, is deleted when this function is called so it may be used to delete the current item data object and reset it by passing NULL as data argument.

void wxTreeListCtrl::SetItemImage ( wxTreeListItem  item,
int  closed,
int  opened = NO_IMAGE 
)

Set the images for the given item.

See InsertItem() for the images parameters descriptions.

void wxTreeListCtrl::SetItemText ( wxTreeListItem  item,
const wxString text 
)

Set the text of the first column of the given item.

void wxTreeListCtrl::SetItemText ( wxTreeListItem  item,
unsigned  col,
const wxString text 
)

Set the text of the specified column of the given item.

void wxTreeListCtrl::SetSortColumn ( unsigned  col,
bool  ascendingOrder = true 
)

Sorting.

If some control columns were added with wxCOL_SORTABLE flag, clicking on them will automatically resort the control using the custom comparator set by SetItemComparator() or by doing alphabetical comparison by default.

In any case, i.e. even if the user can't sort the control by clicking on its header, you may call SetSortColumn() to sort it programmatically and call GetSortColumn() to determine whether it's sorted now and, if so, by which column and in which order. Set the column to use for sorting and the order in which to sort.

Calling this method resorts the control contents using the values of the items in the specified column. Sorting uses custom comparator set with SetItemComparator() or alphabetical comparison of items texts if none was specified.

Notice that currently there is no way to reset sort order.

Parameters:
colA valid column index.
ascendingOrderIndicates whether the items should be sorted in ascending (A to Z) or descending (Z to A) order.
void wxTreeListCtrl::UncheckItem ( wxTreeListItem  item)

Uncheck the given item.

This is synonymous with CheckItem(wxCHK_UNCHECKED).

void wxTreeListCtrl::Unselect ( wxTreeListItem  item)

Deselect the given item.

This method can be used in multiple selection mode only.

void wxTreeListCtrl::UnselectAll ( )

Deselect all the control items.

Can be only used in multi-selection mode.

void wxTreeListCtrl::UpdateItemParentStateRecursively ( wxTreeListItem  item)

Update the state of the parent item to reflect the checked state of its children.

This method updates the parent of this item recursively: if this item and all its siblings are checked, the parent will become checked as well. If this item and all its siblings are unchecked, the parent will be unchecked. And if the siblings of this item are not all in the same state, the parent will be switched to indeterminate state. And then the same logic will be applied to the parents parent and so on recursively.

This is typically called when the state of the given item has changed from EVT_TREELIST_ITEM_CHECKED() handler in the controls which have wxTL_3STATE flag. Notice that without this flag this function can't work as it would be unable to set the state of a parent with both checked and unchecked items so it's only allowed to call it when this flag is set.

int wxTreeListCtrl::WidthFor ( const wxString text) const

Get the width appropriate for showing the given text.

This is typically used as second argument for AppendColumn() or with SetColumnWidth().


Member Data Documentation

const int wxTreeListCtrl::NO_IMAGE = -1 [static]

Image list methods.

Like wxTreeCtrl and wxListCtrl this class uses wxImageList so if you intend to use item icons with it, you must construct wxImageList containing them first and then specify the indices of the icons in this image list when adding the items later. A constant indicating that no image should be used for an item.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines