Package wx :: Package lib :: Package agw :: Module hypertreelist :: Class TreeListMainWindow

[frames | no frames]

## Type TreeListMainWindow

    object --+
             |
        Object --+
                 |
        EvtHandler --+
                     |
                Window --+
                         |
                     Panel --+
                             |
                ScrolledWindow --+
                                 |
                  PyScrolledWindow --+
                                     |
                        CustomTreeCtrl --+
                                         |
                                        TreeListMainWindow

Method Summary
| `__init__(self, parent, id, pos, size, style, validator, name)`
| ``AddRoot`(self, text, ct_type, wnd, image, selImage, data)` Adds a root to the HyperTreeList.
| ``AdjustMyScrollbars`(self)` Adjust the wx.ScrolledWindow scrollbars.
| `CalculateLevel(self, item, dc, level, y, x_colstart)`
| ``CalculatePositions`(self)` Calculates all the positions of the visible items.
| `CalculateSize(self, item, dc)`
| ``ChildrenClosing`(self, item)` We are about to destroy the item children.
| ``Delete`(self, item)` Delete an item.
| ``DeleteAllItems`(self)` Delete all items in the CustomTreeCtrl.
| `DeleteRoot(self)`
| ``DoInsertItem`(self, parent, previous, text, ct_type, wnd, image, selImage, data)` Actually inserts an item in the tree.
| ``EditLabel`(self, item)` Starts editing an item label.
| ``EnableItem`(self, item, enable, torefresh)` Enables/disables an item.
| `GetBestColumnWidth(self, column, parent)`
| `GetColumnCount(self)`
| `GetFirstExpandedItem(self)`
| `GetFirstVisibleItem(self, fullRow)`
| `GetItemImage(self, item, column, which)`
| ``GetItemText`(self, item)` Returns the item text.
| `GetItemWidth(self, column, item)`
| ``GetItemWindow`(self, item, column)` Returns the window associated to the item (if any).
| ``GetItemWindowEnabled`(self, item, column)` Returns whether the window associated to the item is enabled.
| `GetMainColumn(self)`
| `GetNextExpanded(self, item)`
| `GetPrevChild(self, item, cookie)`
| `GetPrevExpanded(self, item)`
| ``GetPrevVisible`(self, item)` Returns the previous visible item.
| `HideItem(self, item, hide)`
| ``HideWindows`(self)` Hides the windows associated to the items.
| ``HitTest`(self, point, flags)` Calculates which (if any) item is under the given point, returning the tree item at this point plus extra information flags.
| ``IsItemEnabled`(self, item)` Returns whether an item is enabled or disabled.
| ``IsItemVisible`(self, item)` Returns whether the item is visible or not.
| `IsVirtual(self)`
| ``OnMouse`(self, event)` Handles a bunch of wx.EVT_MOUSE_EVENTS events.
| ``OnPaint`(self, event)` Handles the wx.EVT_PAINT event.
| `OnRenameAccept(self, value)`
| ``OnRenameCancelled`(self)` Called by TreeTextCtrl, to cancel the changes and to send the EVT_TREE_END_LABEL_EDIT event.
| ``OnRenameTimer`(self)` The timer for renaming has expired.
| `OnScroll(self, event)`
| `PaintItem(self, item, dc)`
| `PaintLevel(self, item, dc, level, y, x_maincol)`
| ``ScrollTo`(self, item)` Scrolls the specified item into view.
| `SetDragItem(self, item)`
| `SetItemImage(self, item, image, column, which)`
| ``SetItemText`(self, item, text)` Sets the item text.
| ``SetItemWindow`(self, item, window, column)` Sets the window associated to the item.
| ``SetItemWindowEnabled`(self, item, enable, column)` Enables/disables the window associated to the item.
| `SetMainColumn(self, column)`

Property Summary

Instance Method Details

### AddRoot(self, text, ct_type=0, wnd=None, image=-1, selImage=-1, data=None)

Adds a root to the HyperTreeList. Only one root must exist.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.AddRoot`

### AdjustMyScrollbars(self)

Adjust the wx.ScrolledWindow scrollbars.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.AdjustMyScrollbars` (inherited documentation)

### CalculatePositions(self)

Calculates all the positions of the visible items.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.CalculatePositions` (inherited documentation)

### ChildrenClosing(self, item)

We are about to destroy the item children.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.ChildrenClosing`

### Delete(self, item)

Delete an item.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.Delete`

### DeleteAllItems(self)

Delete all items in the CustomTreeCtrl.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.DeleteAllItems`

### DoInsertItem(self, parent, previous, text, ct_type=0, wnd=None, image=-1, selImage=-1, data=None)

Actually inserts an item in the tree.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.DoInsertItem`

### EditLabel(self, item, column=None)

Starts editing an item label.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.EditLabel` (inherited documentation)

### EnableItem(self, item, enable=True, torefresh=True)

Enables/disables an item.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.EnableItem`

### GetItemText(self, item, column=None)

Returns the item text.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.GetItemText` (inherited documentation)

### GetItemWindow(self, item, column=None)

Returns the window associated to the item (if any).

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.GetItemWindow`

### GetItemWindowEnabled(self, item, column=None)

Returns whether the window associated to the item is enabled.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.GetItemWindowEnabled`

### GetPrevVisible(self, item, fullRow=True)

Returns the previous visible item.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.GetPrevVisible` (inherited documentation)

### HideWindows(self)

Hides the windows associated to the items. Used internally.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.HideWindows`

### HitTest(self, point, flags=0)

Calculates which (if any) item is under the given point, returning the tree item at this point plus extra information flags. Flags is a bitlist of the following:

TREE_HITTEST_ABOVE above the client area TREE_HITTEST_BELOW below the client area TREE_HITTEST_NOWHERE no item has been hit TREE_HITTEST_ONITEMBUTTON on the button associated to an item TREE_HITTEST_ONITEMICON on the icon associated to an item TREE_HITTEST_ONITEMCHECKICON on the check/radio icon, if present TREE_HITTEST_ONITEMINDENT on the indent associated to an item TREE_HITTEST_ONITEMLABEL on the label (string) associated to an item TREE_HITTEST_ONITEMRIGHT on the right of the label associated to an item TREE_HITTEST_TOLEFT on the left of the client area TREE_HITTEST_TORIGHT on the right of the client area TREE_HITTEST_ONITEMUPPERPART on the upper part (first half) of the item TREE_HITTEST_ONITEMLOWERPART on the lower part (second half) of the item TREE_HITTEST_ONITEM anywhere on the item

Note: both the item (if any, None otherwise) and the flag are always returned as a tuple.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.HitTest` (inherited documentation)

### IsItemEnabled(self, item)

Returns whether an item is enabled or disabled.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.IsItemEnabled` (inherited documentation)

### IsItemVisible(self, item)

Returns whether the item is visible or not.

### OnMouse(self, event)

Handles a bunch of wx.EVT_MOUSE_EVENTS events.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.OnMouse` (inherited documentation)

### OnPaint(self, event)

Handles the wx.EVT_PAINT event.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.OnPaint` (inherited documentation)

### OnRenameCancelled(self)

Called by TreeTextCtrl, to cancel the changes and to send the EVT_TREE_END_LABEL_EDIT event.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.OnRenameCancelled`

### OnRenameTimer(self)

The timer for renaming has expired. Start editing.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.OnRenameTimer` (inherited documentation)

### ScrollTo(self, item)

Scrolls the specified item into view.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.ScrollTo` (inherited documentation)

### SetItemText(self, item, text, column=None)

Sets the item text.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.SetItemText` (inherited documentation)

### SetItemWindow(self, item, window, column=None)

Sets the window associated to the item.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.SetItemWindow`

### SetItemWindowEnabled(self, item, enable=True, column=None)

Enables/disables the window associated to the item.

  Overrides:
    `wx.lib.agw.customtreectrl.CustomTreeCtrl.SetItemWindowEnabled`

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:52:14 2009 | http://epydoc.sf.net