Python: module pyui.tree

pyui.tree | index c:\ninja\projects\pyui\pyui\tree.py

`# PyUI
# Copyright (C) 2001-2002 Sean C. Riley
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of version 2.1 of the GNU Lesser General Public
# License as published by the Free Software Foundation.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA`

Modules
`` |  |
pyui |  |  |

Classes
`` |  | pyui.widgets.Base Tree TreeNode
class Tree(pyui.widgets.Base)
`` | `A tree widget. Has a built-in tree node, plus user added nodes. The built-in top node is not drawn, only children of it are drawn. Nodes can be added at any time to the tree.`
| Methods defined here: __init__(self) addNode(self, node) countNodes(self) `Count the number of visible nodes. used for the scroll bar.` destroy(self) draw(self, renderer) `Draw all the top-level nodes.` findNode(self, posY) findSelected(self, node) `help method to recursively find the selected node.` getSelectedNode(self) onMouseDown(self, event) onScrollPos(self, event) resize(self, w, h) Data and non-method functions defined here: CLOSED = 2 `int(x[, base]) -> integer Convert a string or number to an integer, if possible. A floating point argument will be truncated towards zero (this does not include a string representation of a floating point number!) When converting a string, use the optional base. It is an error to supply a base when converting a non-string.` OPEN = 1 `int(x[, base]) -> integer Convert a string or number to an integer, if possible. A floating point argument will be truncated towards zero (this does not include a string representation of a floating point number!) When converting a string, use the optional base. It is an error to supply a base when converting a non-string.` __doc__ = 'A tree widget. Has a built-in tree node, plus us...es can be added at any time to\n the tree.\n ' `str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.` __module__ = 'pyui.tree' `str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.` closedButton = 'closed.png' `str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.` default = 'folder.png' `str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.` emptyButton = 'empty.png' `str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.` openButton = 'open.png' `str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.` Methods inherited from pyui.widgets.Base: __del__(self) addChild(self, child) `Add a child widget.` addPopup(self, popup) calcSize(self) `This sets up self.rect to be absolute co-ordinates. also sets up self.windowRect to be relative to the upper left of the parent Window` checkHit(self, pos) clearDirty(self) `Clears this widgets dirty flag.` getFocus(self) `Acquire the gui system's focus. only one Base may have the focus` getToolTipInfo(self, pos) `return a tuple of the text and rectangle for the tooltip for when the mouse is in <pos> within the window. This uses the member variable toolTipInfo if it is populated.` handleEvent(self, event) `event processing for base objects` hasFocus(self) hit(self, pos) `Check for a hit using absolute coordinates.` loseFocus(self) `lose the gui system's focus.` move(self, dx, dy) `move relative to current position.` moveto(self, x, y) `move to absolute position.` pack(self) `used by panels & layout managers` postEvent(self, eventType) `Post an event to be processed next time through the event loop` registerEvent(self, eventType, handler) `Setup handler for an event` removeChild(self, child) setDirty(self, collide=1) `Sets this widget to redraw itself and notifies window.` setParent(self, parent) `Set the parent of this widget` setShow(self, value) setWindow(self, window) unregisterEvent(self, eventType) `Remove handler for an event` Data and non-method functions inherited from pyui.widgets.Base: canTab = 0 `int(x[, base]) -> integer Convert a string or number to an integer, if possible. A floating point argument will be truncated towards zero (this does not include a string representation of a floating point number!) When converting a string, use the optional base. It is an error to supply a base when converting a non-string.`
class TreeNode
`` | `A Node in the Tree widgets. Can be open or closed. Uses a default icon of a folder.`
| Methods defined here: __init__(self, title, icon='folder.png') addNode(self, node) checkY(self, y) countNodes(self) destroy(self) draw(self, renderer, x, y) `draw the node and it's sub-nodes and return the height it required to draw, and the number of nodes drawn.` drawSubNodes(self, renderer, x, y) findNode(self, y) Data and non-method functions defined here: __doc__ = 'A Node in the Tree widgets. Can be open or closed. Uses a default icon of a folder.\n ' `str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.` __module__ = 'pyui.tree' `str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.`

Functions
`` |  | init()

Data
`` |  | __file__ = r'.\pyui\tree.pyc' __name__ = 'pyui.tree' itemHeight = 18