wx.lib.agw.customtreectrl.TreeTextCtrl¶

Control used for in-place edit.

This is a subclass of lib.expando.ExpandoTextCtrl as CustomTreeCtrl supports multiline text items.

Note

To add a newline character in a multiline item, press Shift + Enter as the Enter key alone is consumed by CustomTreeCtrl to finish the editing and Ctrl + Enter is consumed by the platform for tab navigation.

Class Hierarchy¶

Inheritance diagram for class TreeTextCtrl:

Known Superclasses¶

wx.lib.expando.ExpandoTextCtrl

Methods Summary¶

`__init__`	Default class constructor.
`AcceptChanges`	Accepts/rejects the changes made by the user.
`Finish`	Finish editing.
`item`	Returns the item currently edited.
`OnChar`	Handles the `wx.EVT_CHAR` event for `TreeTextCtrl`.
`OnKeyUp`	Handles the `wx.EVT_KEY_UP` event for `TreeTextCtrl`.
`OnKillFocus`	Handles the `wx.EVT_KILL_FOCUS` event for `TreeTextCtrl`.
`StopEditing`	Suddenly stops the editing.

Class API¶

class TreeTextCtrl(ExpandoTextCtrl)¶

Control used for in-place edit.

This is a subclass of lib.expando.ExpandoTextCtrl as CustomTreeCtrl supports multiline text items.

Note

To add a newline character in a multiline item, press Shift + Enter as the Enter key alone is consumed by CustomTreeCtrl to finish the editing and Ctrl + Enter is consumed by the platform for tab navigation.

Methods¶

__init__(self, owner, item=None)¶

Default class constructor. For internal use: do not call it in your code!

Parameters:

owner – the control parent (an instance of CustomTreeCtrl);
item – an instance of GenericTreeItem.

Raise:

Exception when the item has an associated image but the parent CustomTreeCtrl does not have a wx.ImageList assigned.

AcceptChanges(self)¶

Accepts/rejects the changes made by the user.

Returns:: True if the changes to the item text have been accepted, False if they have been rejected (i.e., vetoed by the user).

Finish(self)¶: Finish editing.

item(self)¶

Returns the item currently edited.

Returns:: An instance of GenericTreeItem.

OnChar(self, event)¶

Handles the wx.EVT_CHAR event for TreeTextCtrl.

Parameters:: event – a KeyEvent event to be processed.

OnKeyUp(self, event)¶

Handles the wx.EVT_KEY_UP event for TreeTextCtrl.

Parameters:: event – a KeyEvent event to be processed.

OnKillFocus(self, event)¶

Handles the wx.EVT_KILL_FOCUS event for TreeTextCtrl.

Parameters:: event – a FocusEvent event to be processed.

StopEditing(self)¶: Suddenly stops the editing.

Navigation