Home       Trees       Index       Help   
Package gnue :: Package forms :: Package GFObjects :: Module GFObj :: Class GFObj
[show private | hide private]

Type GFObj

 GTriggerCore --+    
                |    
   object --+   |    
            |   |    
    ParserObj --+    
                |    
             GObj --+
                    |
GTriggerExtension --+
                    |
                   GFObj

Known Subclasses:
GFContainer, GFField, GFLabel, GFLayout, GFLogic, GFOption, GFParameter, GFScrollBar, GFTabStop, GFCommander, GFMenu, GFToolbar
A GFObj is the base class for all objects of a GF object tree. It implements the GTriggerExtension interface, so all GF objects are capable of associating and calling triggers.
Method Summary
  __init__(self, parent, object_type)
  _is_navigable_(self, mode)
Return wether the object is currently navigable or not.
  _phase_1_init_(self)
Phase 1 initialization called after all objects of the XML tree were created.
  get_block(self)
Return the objects' block from the block mapping.
  get_field(self)
Returns the objects' field from the blocks' field mapping
  get_option(self, name)
Return the value of a given option of the object or None if no such option is present.
  is_navigable(self, mode)
Return wether the object is currently navigable or not.
  phase_1_init(self)
Phase 1 initialization called after all objects of the XML tree were created.
  __get_has_label(self)
    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)...
    Inherited from GTriggerExtension
  associateTrigger(self, key, function)
Associate a trigger with this object.
  processTrigger(self, key, ignoreAbort)
Fire the requested trigger if a trigger of that type has been associated with this object.

Property Summary
  has_label

Instance Variable Summary
    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.

Class Variable Summary
    Inherited from GTriggerExtension
dict _validTriggers: Dictionary with valid trigger names as keys.

Method Details

__init__(self, parent=None, object_type='GFObj')
(Constructor)

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

_is_navigable_(self, mode)

Return wether the object is currently navigable or not.

Descendants can overwrite this method to return either True or False. If this method is not overwritten it returns False.
Parameters:
mode - current state of the object. Can be 'edit', 'query' or 'new'

_phase_1_init_(self)

Phase 1 initialization called after all objects of the XML tree were created. Descendants can overwrite this function to perform actions after construction of the objects.

get_block(self)

Return the objects' block from the block mapping.
Returns:
the block of the current object or None if the current object does not support blocks.
Raises:
BlockNotFoundError - if the block specified by the object is not listed in the block mapping of the logic instance

get_field(self)

Returns the objects' field from the blocks' field mapping
Returns:
GFField instance or None if the object does not support fields
Raises:
FieldNotFoundError - if the field is not available through the block

get_option(self, name)

Return the value of a given option of the object or None if no such option is present.
Parameters:
name - name of the option to be queried
Returns:
the value of the requested option or None

is_navigable(self, mode='edit')

Return wether the object is currently navigable or not.
Parameters:
mode - current state of the object. Can be 'edit', 'query' or 'new'
Returns:
True or False

phase_1_init(self)

Phase 1 initialization called after all objects of the XML tree were created.

__get_has_label(self)


Property Details

has_label

Get Method:
__get_has_label(self)

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Tue Nov 18 23:03:30 2008 http://epydoc.sf.net

GNUe Home

Private API

Developer's Corner