wx.dataview.DataViewTreeCtrl¶

This class is a wx.dataview.DataViewCtrl which internally uses a wx.dataview.DataViewTreeStore and forwards most of its API to that class.

Additionally, it uses a wx.ImageList to store a list of icons.

The main purpose of this class is to provide a simple upgrade path for code using wx.TreeCtrl.

Window Styles¶

This class supports the following styles:

See wx.dataview.DataViewCtrl for the list of supported styles.

Events Emitted by this Class¶

Event macros for events emitted by this class:

See wx.dataview.DataViewCtrl for the list of events emitted by this class.

Added in version 2.9.0.

Class Hierarchy¶

Inheritance diagram for class DataViewTreeCtrl:

Control Appearance¶

Methods Summary¶

`__init__`	Default constructor.
`AppendContainer`	Appends a container to the given parent.
`AppendItem`	Appends an item to the given parent.
`Create`	Creates the control and a wx.dataview.DataViewTreeStore as its internal model.
`DeleteAllItems`	Calls the identical method from wx.dataview.DataViewTreeStore.
`DeleteChildren`	Calls the identical method from wx.dataview.DataViewTreeStore.
`DeleteItem`	Calls the identical method from wx.dataview.DataViewTreeStore.
`GetChildCount`	Calls the identical method from wx.dataview.DataViewTreeStore.
`GetClassDefaultAttributes`
`GetImageList`	Returns the image list.
`GetItemData`	Calls the identical method from wx.dataview.DataViewTreeStore.
`GetItemExpandedIcon`	Calls the identical method from wx.dataview.DataViewTreeStore.
`GetItemIcon`	Calls the identical method from wx.dataview.DataViewTreeStore.
`GetItemParent`	Returns the item’s parent.
`GetItemText`	Calls the identical method from wx.dataview.DataViewTreeStore.
`GetNthChild`	Calls the identical method from wx.dataview.DataViewTreeStore.
`GetStore`	Returns the store.
`InsertContainer`	Calls the same method from wx.dataview.DataViewTreeStore but uses an index position in the image list instead of a wx.Icon.
`InsertItem`	Calls the same method from wx.dataview.DataViewTreeStore but uses an index position in the image list instead of a wx.Icon.
`IsContainer`	Returns `True` if item is a container.
`PrependContainer`	Calls the same method from wx.dataview.DataViewTreeStore but uses an index position in the image list instead of a wx.Icon.
`PrependItem`	Calls the same method from wx.dataview.DataViewTreeStore but uses an index position in the image list instead of a wx.Icon.
`SetImageList`	Sets the image list.
`SetItemData`	Calls the identical method from wx.dataview.DataViewTreeStore.
`SetItemExpandedIcon`	Calls the identical method from wx.dataview.DataViewTreeStore.
`SetItemIcon`	Calls the identical method from wx.dataview.DataViewTreeStore.
`SetItemText`	Calls the identical method from wx.dataview.DataViewTreeStore.

Properties Summary¶

`ImageList`	See `GetImageList` and `SetImageList`
`Store`	See `GetStore`

Class API¶

class wx.dataview.DataViewTreeCtrl(DataViewCtrl)¶

Possible constructors:

DataViewTreeCtrl() -> None

DataViewTreeCtrl(parent : Window, id: int=ID_ANY, pos:
                 Point=DefaultPosition, size: Size=DefaultSize, style:
                 int=DV_NO_HEADER|DV_ROW_LINES, validator: Validator=DefaultValidator) ->
                 None

This class is a DataViewCtrl which internally uses a DataViewTreeStore and forwards most of its API to that class.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor.

Return type:: None

__init__ (self, parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=DV_NO_HEADER|DV_ROW_LINES, validator: Validator=DefaultValidator)

Constructor.

Calls Create .

Parameters:

parent (wx.Window)
id (wx.WindowID)
pos (wx.Point)
size (wx.Size)
style (long)
validator (wx.Validator)

Return type:

None

AppendContainer(self, parent: DataViewItem, text: str, icon: int = -1, expanded: int = -1, data: ClientData | None = None)¶

Appends a container to the given parent.

Parameters:

parent (wx.dataview.DataViewItem)
text (string)
icon (int)
expanded (int)
data (ClientData)

Return type:

wx.dataview.DataViewItem

AppendItem(self, parent: DataViewItem, text: str, icon: int = -1, data: ClientData | None = None)¶

Appends an item to the given parent.

Parameters:

parent (wx.dataview.DataViewItem)
text (string)
icon (int)
data (ClientData)

Return type:

wx.dataview.DataViewItem

Create(self, parent: Window, id: int = ID_ANY, pos: Point = DefaultPosition, size: Size = DefaultSize, style: int = DV_NO_HEADER | DV_ROW_LINES, validator: Validator = DefaultValidator)¶

Creates the control and a wx.dataview.DataViewTreeStore as its internal model.

The default tree column created by this method is an editable column using wx.dataview.DataViewIconTextRenderer as its renderer.

Parameters:

parent (wx.Window)
id (wx.WindowID)
pos (wx.Point)
size (wx.Size)
style (long)
validator (wx.Validator)

Return type:

bool

DeleteAllItems(self)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Return type:: None

DeleteChildren(self, item: DataViewItem)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:: item (wx.dataview.DataViewItem)
Return type:: None

DeleteItem(self, item: DataViewItem)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:: item (wx.dataview.DataViewItem)
Return type:: None

GetChildCount(self, parent: DataViewItem)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:: parent (wx.dataview.DataViewItem)
Return type:: int

static GetClassDefaultAttributes(variant: WindowVariant = WINDOW_VARIANT_NORMAL)¶

Parameters:: variant (WindowVariant)
Return type:: VisualAttributes

GetImageList(self)¶

Returns the image list.

Return type:: ImageList

GetItemData(self, item: DataViewItem)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:: item (wx.dataview.DataViewItem)
Return type:: ClientData

GetItemExpandedIcon(self, item: DataViewItem)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:: item (wx.dataview.DataViewItem)
Return type:: Icon

GetItemIcon(self, item: DataViewItem)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:: item (wx.dataview.DataViewItem)
Return type:: Icon

GetItemParent(self, item: DataViewItem)¶

Returns the item’s parent.

Parameters:: item (wx.dataview.DataViewItem)
Return type:: wx.dataview.DataViewItem

Added in version 4.1/wxWidgets-3.1.6.

GetItemText(self, item: DataViewItem)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:: item (wx.dataview.DataViewItem)
Return type:: str

GetNthChild(self, parent: DataViewItem, pos: int)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:

parent (wx.dataview.DataViewItem)
pos (int)

Return type:

wx.dataview.DataViewItem

GetStore(self)¶

Returns the store.

Return type:: wx.dataview.DataViewTreeStore

InsertContainer(self, parent: DataViewItem, previous: DataViewItem, text: str, icon: int = -1, expanded: int = -1, data: ClientData | None = None)¶

Calls the same method from wx.dataview.DataViewTreeStore but uses an index position in the image list instead of a wx.Icon.

Parameters:

parent (wx.dataview.DataViewItem)
previous (wx.dataview.DataViewItem)
text (string)
icon (int)
expanded (int)
data (ClientData)

Return type:

wx.dataview.DataViewItem

InsertItem(self, parent: DataViewItem, previous: DataViewItem, text: str, icon: int = -1, data: ClientData | None = None)¶

Calls the same method from wx.dataview.DataViewTreeStore but uses an index position in the image list instead of a wx.Icon.

Parameters:

parent (wx.dataview.DataViewItem)
previous (wx.dataview.DataViewItem)
text (string)
icon (int)
data (ClientData)

Return type:

wx.dataview.DataViewItem

IsContainer(self, item: DataViewItem)¶

Returns True if item is a container.

Parameters:: item (wx.dataview.DataViewItem)
Return type:: bool

PrependContainer(self, parent: DataViewItem, text: str, icon: int = -1, expanded: int = -1, data: ClientData | None = None)¶

Calls the same method from wx.dataview.DataViewTreeStore but uses an index position in the image list instead of a wx.Icon.

Parameters:

parent (wx.dataview.DataViewItem)
text (string)
icon (int)
expanded (int)
data (ClientData)

Return type:

wx.dataview.DataViewItem

PrependItem(self, parent: DataViewItem, text: str, icon: int = -1, data: ClientData | None = None)¶

Calls the same method from wx.dataview.DataViewTreeStore but uses an index position in the image list instead of a wx.Icon.

Parameters:

parent (wx.dataview.DataViewItem)
text (string)
icon (int)
data (ClientData)

Return type:

wx.dataview.DataViewItem

SetImageList(self, imagelist: ImageList)¶

Sets the image list.

Parameters:: imagelist (wx.ImageList)
Return type:: None

SetItemData(self, item: DataViewItem, data: ClientData)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:

item (wx.dataview.DataViewItem)
data (ClientData)

Return type:

None

SetItemExpandedIcon(self, item: DataViewItem, icon: BitmapBundle)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:

item (wx.dataview.DataViewItem)
icon (wx.BitmapBundle)

Return type:

None

SetItemIcon(self, item: DataViewItem, icon: BitmapBundle)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:

item (wx.dataview.DataViewItem)
icon (wx.BitmapBundle)

Return type:

None

SetItemText(self, item: DataViewItem, text: str)¶

Calls the identical method from wx.dataview.DataViewTreeStore.

Parameters:

item (wx.dataview.DataViewItem)
text (string)

Return type:

None

Properties¶

ImageList¶: See GetImageList and SetImageList

Store¶: See GetStore

Navigation

wx.dataview.DataViewTreeCtrl¶

Window Styles¶

Events Emitted by this Class¶

Class Hierarchy¶

Control Appearance¶

Methods Summary¶

Properties Summary¶

Class API¶

Methods¶

Properties¶