Module p.u.r.util

Part of pida.utils.rat

No module docstring
Line # Kind Name Docs
11 Class NotFoundError This is raised when an element is not found
14 Class ListSpec This class is used to help the manipulation of C{gtk.ListStore}s.
83 Function _simple_iterate_widget_children This function iterates all over the widget children.
104 Class _IterateWidgetChildren This iterator class is used to recurse to child widgets, it uses
130 Function iterate_widget_children This function is used to iterate over the children of a given widget.
147 Function iterate_widget_parents Iterate over the widget's parents.
160 Function find_parent_widget Finds a widget by name upwards the tree, by searching self and its parents
182 Function find_child_widget Finds the widget by name downwards the tree, by searching self and its
208 Function get_root_parent Returns the first widget of a tree. If this widget has no children
def _simple_iterate_widget_children(widget):
This function iterates all over the widget children.
def iterate_widget_children(widget, recurse_children=False):
This function is used to iterate over the children of a given widget.
You can recurse to all the widgets contained in a certain widget.

@param widget: The base widget of iteration
@param recurse_children: Wether or not to iterate recursively, by iterating
    over the children's children.

@return: an iterator
@rtype: C{GeneratorType}
def iterate_widget_parents(widget):
Iterate over the widget's parents.

@param widget: The base widget of iteration @return: an iterator @rtype: C{GeneratorType}

def find_parent_widget(widget, name, find_self=True):
Finds a widget by name upwards the tree, by searching self and its parents

@return: C{None} when it didn't find it, otherwise a C{gtk.Container} @rtype: C{gtk.Container} @param find_self: Set this to C{False} if you want to only find on the parents @param name: The name of the widget @param widget: The widget where this function will start searching

def find_child_widget(widget, name, find_self=True):
Finds the widget by name downwards the tree, by searching self and its children.

@return: C{None} when it didn't find it, otherwise a C{gtk.Widget} @rtype: C{gtk.Widget} @param find_self: Set this to L{False} if you want to only find on the children @param name: The name of the widget @param widget: The widget where this function will start searching

def get_root_parent(widget):
Returns the first widget of a tree. If this widget has no children it will return C{None}

@return: C{None} when there is no parent widget, otherwise a C{gtk.Container} @rtype: C{gtk.Container}

API Documentation for PIDA, generated by pydoctor.