This class holds all the information and methods for every single item in CustomTreeCtrl. This is a generic implementation of TreeItem.
__init__ | Default class constructor. |
AssignAttributes | Assigns the item attributes (font, colours, etc...) for this item. |
Attr | Creates a new attribute (font, colours, etc...) for this item. |
Check | Checks/unchecks an item. |
Collapse | Collapses the item. |
DeleteChildren | Deletes the item children. |
DeleteWindow | Deletes the window associated to the item (if any). |
Enable | Enables/disables the item. |
Expand | Expands the item. |
Get3StateValue | Gets the state of a 3-state checkbox item. |
GetAttributes | Returns the item attributes (font, colours, etc...). |
GetCheckedImage | Returns the item check image. |
GetChildren | Returns the item’s children. |
GetChildrenCount | Gets the number of children of this item. |
GetCurrentCheckedImage | Returns the current item check image. |
GetCurrentImage | Returns the current item image. |
GetData | Returns the data associated to this item. |
GetHeight | Returns the height of the item, in pixels. |
GetImage | Returns the item image for a particular item state. |
GetLeftImage | Returns the leftmost image associated to this item, i.e. the image on the |
GetParent | Gets the item parent (another instance of GenericTreeItem or None for |
GetSize | Returns the item size. |
GetText | Returns the item text. |
GetType | Returns the item type. |
GetValue | Returns whether the item is checked or not. |
GetVisited | Returns whether an hypertext item was visited or not. |
GetWidth | Returns the width of the item, in pixels. |
GetWindow | Returns the window associated to the item (if any). |
GetWindowEnabled | Returns whether the associated window is enabled or not. |
GetWindowSize | Returns the associated window size. |
GetX | Returns the x position on an item, in logical coordinates. |
GetY | Returns the y position on an item, in logical coordinates. |
HasChildren | Returns whether the item has children or not. |
HasPlus | Returns whether the item has the plus button or not. |
HitTest | HitTest method for an item. Called from the main window CustomTreeCtrl.HitTest(). |
Insert | Inserts an item in the item children list for this item. |
Is3State | Returns whether or not the checkbox item is a 3-state checkbox. |
IsBold | Returns whether the item font is bold or not. |
IsChecked | This is just a maybe more readable synonym for GetValue. |
IsEnabled | Returns whether the item is enabled or not. |
IsExpanded | Returns whether the item is expanded or not. |
IsHyperText | Returns whether the item is hypetext or not. |
IsItalic | Returns whether the item font is italic or not. |
IsOk | Returns whether the item is ok or not. |
IsSelected | Returns whether the item is selected or not. |
IsSeparator | Returns whether the item is meant to be an horizontal line separator or not. |
OnSetFocus | Handles the EVT_SET_FOCUS event for the window associated with the item. |
Set3State | Sets whether the item has a 3-state value checkbox assigned to it or not. |
Set3StateValue | Sets the checkbox item to the given state. |
SetAttributes | Sets the item attributes (font, colours, etc...). |
SetBold | Sets the item font bold. |
SetData | Sets the data associated to this item. |
SetHasPlus | Sets whether an item has the ‘plus’ button. |
SetHeight | Sets the item’s height. |
SetHilight | Sets the item focus/unfocus. |
SetHyperText | Sets whether the item is hypertext or not. |
SetImage | Sets the item image. |
SetItalic | Sets the item font italic. |
SetLeftImage | Sets the item leftmost image, i.e. the image associated to the item on the leftmost |
SetText | Sets the item text. |
SetType | Sets the item type. |
SetVisited | Sets whether an hypertext item was visited or not. |
SetWidth | Sets the item’s width. |
SetWindow | Sets the window associated to the item. |
SetWindowEnabled | Sets whether the associated window is enabled or not. |
SetX | Sets the x position on an item, in logical coordinates. |
SetY | Sets the y position on an item, in logical coordinates. |
This class holds all the information and methods for every single item in CustomTreeCtrl. This is a generic implementation of TreeItem.
Default class constructor. For internal use: do not call it in your code!
Parameters: |
|
---|
Note
Regarding radiobutton-type items (with ct_type = 2), the following approach is used:
Note
Separator items should not have children, labels, data or an associated window. Other issues/features associated to separator items:
Assigns the item attributes (font, colours, etc...) for this item.
Parameters: | attr – an instance of TreeItemAttr. |
---|
Creates a new attribute (font, colours, etc...) for this item.
Returns: | An instance of TreeItemAttr. |
---|
Checks/unchecks an item.
Parameters: | checked (bool) – True to check an item, False to uncheck it. |
---|
Note
This is meaningful only for checkbox-like and radiobutton-like items.
Collapses the item.
Deletes the item children.
Parameters: | tree – the main CustomTreeCtrl instance. |
---|
Deletes the window associated to the item (if any).
Enables/disables the item.
Parameters: | enable (bool) – True to enable the item, False to disable it. |
---|
Expands the item.
Gets the state of a 3-state checkbox item.
Returns: | CHK_UNCHECKED when the checkbox is unchecked, CHK_CHECKED when it is checked and CHK_UNDETERMINED when it’s in the undetermined state. |
---|---|
Raise : | Exception when the item is not a 3-state checkbox item. |
Note
This method raises an exception when the function is used with a 2-state checkbox item.
Note
This method is meaningful only for checkbox-like items.
Returns the item attributes (font, colours, etc...).
Returns: | An instance of TreeItemAttr. |
---|
Returns the item check image.
Parameters: | which (integer) – can be one of the following bits:
|
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Returns: | An integer index that can be used to retrieve the item check image inside a ImageList. |
Note
This method is meaningful only for radio & check items.
Returns the item’s children.
Returns: | A Python list containing instances of GenericTreeItem, representing this item’s children. |
---|
Gets the number of children of this item.
Parameters: | recursively (bool) – if True, returns the total number of descendants, otherwise only one level of children is counted. |
---|
Returns the current item check image.
Returns: | An integer index that can be used to retrieve the item check image inside a ImageList. |
---|
Returns the current item image.
Returns: | An integer index that can be used to retrieve the item image inside a ImageList. |
---|
Returns the data associated to this item.
Returns: | A Python object representing the item data, or None if no data has been assigned to this item. |
---|
Returns the height of the item, in pixels.
Returns the item image for a particular item state.
Parameters: | which (integer) – can be one of the following bits:
|
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns: | An integer index that can be used to retrieve the item image inside a ImageList. |
Returns the leftmost image associated to this item, i.e. the image on the leftmost part of the client area of CustomTreeCtrl.
Returns: | An integer index that can be used to retrieve the item leftmost image inside a ImageList. |
---|
Gets the item parent (another instance of GenericTreeItem or None for root items.
Returns: | An instance of GenericTreeItem or None for root items. |
---|
Returns the item size.
Parameters: |
|
---|---|
Returns: | A tuple of (x, y) dimensions, in pixels, representing the item’s width and height. |
Returns the item text.
Returns: | A string containing the item text. |
---|
Returns the item type.
Returns whether the item is checked or not.
Note
This is meaningful only for checkbox-like and radiobutton-like items.
Returns whether an hypertext item was visited or not.
Returns the width of the item, in pixels.
Returns the window associated to the item (if any).
Returns: | An instance of any Window derived class, excluding top-level windows. |
---|
Returns whether the associated window is enabled or not.
Returns: | True if the associated window is enabled, False if it is disabled. |
---|---|
Raise : | Exception when the item has no associated window. |
Returns the associated window size.
Returns the x position on an item, in logical coordinates.
Returns the y position on an item, in logical coordinates.
Returns whether the item has children or not.
Returns: | True if the item has children, False otherwise. |
---|
Returns whether the item has the plus button or not.
Returns: | True if the item has a ‘plus’ mark, False otherwise. |
---|
HitTest method for an item. Called from the main window CustomTreeCtrl.HitTest().
Parameters: |
|
---|
See also
CustomTreeCtrl.HitTest() method for the flags explanation.
Inserts an item in the item children list for this item.
Parameters: |
|
---|
Returns whether or not the checkbox item is a 3-state checkbox.
Returns: | True if this checkbox is a 3-state checkbox, False if it’s a 2-state checkbox item. |
---|
Note
This method is meaningful only for checkbox-like items.
Returns whether the item font is bold or not.
Returns: | True if the item has bold text, False otherwise. |
---|
This is just a maybe more readable synonym for GetValue. Returns whether the item is checked or not.
Note
This is meaningful only for checkbox-like and radiobutton-like items.
Returns whether the item is enabled or not.
Returns: | True if the item is enabled, False if it is disabled. |
---|
Returns whether the item is expanded or not.
Returns: | True if the item is expanded, False if it is collapsed. |
---|
Returns whether the item is hypetext or not.
Returns whether the item font is italic or not.
Returns: | True if the item has italic text, False otherwise. |
---|
Returns whether the item is ok or not.
Note
This method always returns True, it has been added for backward compatibility with the wxWidgets C++ implementation.
Returns whether the item is selected or not.
Returns: | True if the item is selected, False otherwise. |
---|
Returns whether the item is meant to be an horizontal line separator or not.
Returns: | True if this item is a separator, False otherwise. |
---|
Handles the EVT_SET_FOCUS event for the window associated with the item.
Parameters: | event – a FocusEvent event to be processed. |
---|
Sets whether the item has a 3-state value checkbox assigned to it or not.
Parameters: | allow (bool) – True to set an item as a 3-state checkbox, False to set it to a 2-state checkbox. |
---|---|
Returns: | True if the change was successful, False otherwise. |
Note
This method is meaningful only for checkbox-like items.
Sets the checkbox item to the given state.
Parameters: | state (integer) – can be one of: CHK_UNCHECKED (check is off), CHK_CHECKED (check is on) or CHK_UNDETERMINED (check is mixed). |
---|---|
Raise : | Exception when the item is not a 3-state checkbox item. |
Note
This method raises an exception when the checkbox item is a 2-state checkbox and setting the state to CHK_UNDETERMINED .
Note
This method is meaningful only for checkbox-like items.
Sets the item attributes (font, colours, etc...).
Parameters: | attr – an instance of TreeItemAttr. |
---|
Sets the item font bold.
Parameters: | bold (bool) – True to have a bold font item, False otherwise. |
---|
Sets the data associated to this item.
Parameters: | data (object) – can be any Python object. |
---|
Sets whether an item has the ‘plus’ button.
Parameters: | has (bool) – True to set the ‘plus’ button on the item, False otherwise. |
---|
Sets the item’s height.
Parameters: | h (integer) – an integer specifying the item’s height, in pixels. |
---|
Sets the item focus/unfocus.
Parameters: | set (bool) – True to set the focus to the item, False otherwise. |
---|
Sets whether the item is hypertext or not.
Parameters: | hyper (bool) – True to set hypertext behaviour, False otherwise. |
---|
Sets the item image.
Parameters: |
|
---|
See also
GetImage for a description of the which parameter.
Sets the item font italic.
Parameters: | italic (bool) – True to have an italic font item, False otherwise. |
---|
Sets the item leftmost image, i.e. the image associated to the item on the leftmost part of the CustomTreeCtrl client area.
Parameters: | image (integer) – an index within the left image list specifying the image to use for the item in the leftmost part of the client area. |
---|
Sets the item text.
Parameters: | text (string) – the new item label. |
---|---|
Raise : | Exception if the item is a separator. |
Sets the item type.
Parameters: | ct_type (integer) – may be one of the following integers:
|
---|
Note
Regarding radiobutton-type items (with ct_type = 2), the following approach is used:
Sets whether an hypertext item was visited or not.
Parameters: | visited (bool) – True to set a hypertext item as visited, False otherwise. |
---|
Sets the item’s width.
Parameters: | w (integer) – an integer specifying the item’s width, in pixels. |
---|
Sets the window associated to the item.
Parameters: | wnd – a non-toplevel window to be displayed next to the item, any subclass of Window. |
---|---|
Raise : | Exception if the input item is a separator and wnd is not None. |
Sets whether the associated window is enabled or not.
Parameters: | enable (bool) – True to enable the associated window, False to disable it. |
---|---|
Raise : | Exception when the item has no associated window. |
Sets the x position on an item, in logical coordinates.
Parameters: | x (integer) – an integer specifying the x position of the item. |
---|
Sets the y position on an item, in logical coordinates.
Parameters: | y (integer) – an integer specifying the y position of the item. |
---|