Home       Trees       Index       Help   
Package gnue :: Package forms :: Package uidrivers :: Package _base :: Package widgets :: Module _base :: Class UIWidget
[show private | hide private]

Type UIWidget

GTriggerCore --+    
               |    
  object --+   |    
           |   |    
   ParserObj --+    
               |    
            GObj --+
                   |
                  UIWidget

Base class for user interface widgets.
Method Summary
  __init__(self, event)
  __check_bounding_box(self)
  __primary_init(self)
  _create_widget_(self, event, spacer)
  _request(self, name, **params)
Fire a request<name> event passing the GFObject and the GFObject's form as additional event parameters.
  create_widget(self, event, spacer)
  get_bounding_box(self)
Get the bounding box of the widget.
    Inherited from GObj
  __getitem__(self, key)
  __setitem__(self, key, value)
  _dumpXML_(self, lookupDict, treeDump, gap, xmlnamespaces, textEncoding, stripPrefixes, escape)
Dumps an XML representation of the object
  buildAndInitObject(self, **params)
This is a convenience function for applications NOT using GParser to load an object tree.
  buildObject(self, **params)
A convenience function for applications NOT using GParser to load an object tree.
string getXmlTag(self, stripPrefixes)
Returns the xml tag to be used to represent the object.
  iterator(self, test, types, includeSelf)
Return a python iterator of child objects.
  maxInits(self)
maxInits returns the maximum size of all the _inits list from this object or it's children
  phaseInit(self, iterations)
Starts GNUe's phased initialization system from this object down.
  showTree(self, indent)
A recusive function to print an indented text representation of the GObj tree from this object down.
  walk(self, function, *args, **parms)
Function that recursively walks down through a tree of ParserObj instances and applies a function to them.
  _buildObject(self)
This function is called after the parsers have completely constructed.
  _phaseInit(self, phase)
Used internally by phaseInit to walk through the object tree initializing objects.
  _setItemHook(self, key, value)
This bit of nastiness is here to let GNUe Designer capture the setting of GObject properties.
    Inherited from GTriggerCore
  __repr__(self)
  create_namespace_object(self, global_namespace, namespace_name)
Construct a namespace object tree from an XML (definitions.GObjects.GObj) object tree.
  get_namespace_object(self)
Return the namespace object that mirrors this object in the action/trigger namespace.
    Inherited from ParserObj
  _diffActionWalker_(self, obj, action)
Set the action attribute of a given object to the specified action.
  _getAsContents_(self)
Get the contents of this object.
  _id_(self, maxIdLength)
Return a compareable and identifying id of an object within a tree.
  _set_initial_attributes_(self, attributes)
Set attributes loaded by GParser.
  addChild(self, child)
Add an object to the list of children
  assign(self, source, recursive)
Assign all attributes from a given object to this one.
  diff(self, goal, maxIdLength)
Build an object tree representing the difference between two object trees.
  dumpXML(self, lookupDict, treeDump, gap, xmlnamespaces, textEncoding, stripPrefixes, escape)
Return a XML representation of the object.
  findChildNamed(self, name, childType)
Moves downward though the children of an object till it finds the child with the specified name.
  findChildOfType(self, childType, includeSelf, allowAllChildren)
Moves downward through the children of an object till it finds the child of the specified type.
  findChildrenOfType(self, childType, includeSelf, allowAllChildren)
Find all children of a specific type.
  findParentOfType(self, parentType, includeSelf)
Moves upward though the parents of an object till it finds the parent of the specified type.
  getChildrenAsContent(self)
Returns the content of any GContent objects that are children of this object.
  getDescription(self)
Return a useful description of the object.
any getParent(self)
Returns the immediate parent of an object instance in a GObj tree.
  merge(self, other, maxIdLength, overwrite)
Merge another object tree into this tree.
  setParent(self, newParent)
Set the immediate parent of an object instance in a GObj tree
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Instance Variable Summary
  _container: If this widget can contain other widgets then _container is the specific container children should use (as parent)
  _form: the GFForm instance owning this widget
  _gfObject: The GFObject for this UIWidget
  _uiDriver: the GFUserInterface instance of the current ui driver used to render the form
  _uiForm: the UIForm widget this widget is a child of
  bouding_boxes: is a list of tuples with the bounding boxes of all the widgets children.
  chr_h: height of the widgets in character-positions
  chr_pos: tuple of (chr_y, chr_x) defining the upper left corner
  chr_span: tuple of (chr_h, chr_w) defining the number of rows and columns the widget occupies
  chr_w: width of the widgets in character-positions
  chr_x: zero-based x coordinate of the widget
  chr_y: zero-based y coordinate of the widget
  managed: This boolean flag determines wether a widget is used in a managed layout or in a positioned one
  widgets: Sequence of ui driver specific widgets created for this UIWidget.
    Inherited from GTriggerCore
  _triggerFunctions: Dictionary defining the functions this object should present in action/trigger code.
  _triggerGet: Can be set to a method that returns the string value of the object.
  _triggerGlobal: If set to True, this object is added to the global namespace.
  _triggerProperties: Dictionary defining the properties this object should present in action/trigger code.
  _triggerSet: Can be set to a method that sets the value of this object.

Method Details

__init__(self, event)
(Constructor)

Overrides:
gnue.common.definitions.GObjects.GObj.__init__

__check_bounding_box(self)

__primary_init(self)

_create_widget_(self, event, spacer)

_request(self, name, **params)

Fire a request<name> event passing the GFObject and the GFObject's form as additional event parameters.
Parameters:
name - name of the event, i.e. a name of 'FOO' would fire a 'requestFOO' event.
params - dictionary with parameters passed with the event. this dictionary will always get the keys '_object' (with the GFObject of this widget) and '_form' (with the GFForm of this widget) set.

create_widget(self, event, spacer)

get_bounding_box(self)

Get the bounding box of the widget. For managed layouts this is always None. For positioned layouts it is a tuple of character-positions (left, top, right, bottom)
Returns:
bounding-box as (left, top, right, bottom)

Instance Variable Details

_container

If this widget can contain other widgets then _container is the specific container children should use (as parent)

_form

the GFForm instance owning this widget

_gfObject

The GFObject for this UIWidget

_uiDriver

the GFUserInterface instance of the current ui driver used to render the form

_uiForm

the UIForm widget this widget is a child of

bouding_boxes

is a list of tuples with the bounding boxes of all the widgets children. Such a tuple is made like (left, top, right, bottom, gfObject of the corresponding child).

chr_h

height of the widgets in character-positions

chr_pos

tuple of (chr_y, chr_x) defining the upper left corner

chr_span

tuple of (chr_h, chr_w) defining the number of rows and columns the widget occupies

chr_w

width of the widgets in character-positions

chr_x

zero-based x coordinate of the widget

chr_y

zero-based y coordinate of the widget

managed

This boolean flag determines wether a widget is used in a managed layout or in a positioned one

widgets

Sequence of ui driver specific widgets created for this UIWidget.

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Tue Jan 6 23:03:38 2009 http://epydoc.sf.net

GNUe Home

Private API

Developer's Corner