gnue.forms Private API - GNU Enterprise

Package gnue :: Package forms :: Package GFObjects :: Module commanders :: Class GFCommander

[show private | hide private]

Type GFCommander

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

Known Subclasses:: GFMenuItem, GFToolButton

Any object that is bound to an action.

A commander can either be linked to a single action, in which case the action is executed whenever the commander is fired, or it can be linked to an action and an action_off, in which case the commander is a toggle and the action is executed when the toggle is switched on and the action_off is fired when the toggle is switched off.

For toggles, the action determines icon, label, and description, rather than the action_off.

Method Summary
	`__init__(self, parent, object_type)` Create a GFCommander instance.
	`__fire(self)`
	`__trigger_get_enabled(self)`
	`__trigger_get_state(self)`
	`__trigger_set_enabled(self, value)`
	`__trigger_set_state(self, value)`
	`_event_fire(self)` Fire the commander.
	`_get_icon_file(self, size, format)` Return the file with the icon bound to this action.
	`_phase_2_init_(self)`
	`update_status(self)` Update the enabled/disabled status of the commander.
Inherited from GFObj
	`_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.
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
Inherited from GFObj
	`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
`NoneType`	`action` = None
`NoneType`	`action_off` = None
`NoneType`	`description` = None
`bool`	`enabled` = `True`
`NoneType`	`icon` = None
`NoneType`	`label` = None
`NoneType`	`name` = None
`bool`	`state` = `False`
Inherited from GTriggerExtension
`dict`	`_validTriggers`: Dictionary with valid trigger names as keys.

Method Details

init(self, parent, object_type)
(Constructor)

Create a GFCommander instance.

Overrides:: gnue.forms.GFObjects.GFObj.GFObj.__init__

__fire(self)

__trigger_get_enabled(self)

__trigger_get_state(self)

__trigger_set_enabled(self, value)

__trigger_set_state(self, value)

_event_fire(self)

Fire the commander.

This function is executed when the user clicks on the menu item or the toolbar button.

If the commander is bound to a single action, this action is executed.

If the commander is bound to two actions (i.e. it is a toggle), the state of the toggle is changed, and the corresponding action is executed.

_get_icon_file(self, size='32x32', format='png')

Return the file with the icon bound to this action.

Parameters:: size - Image size, like "16x16" or "24x24".; format - Image format, like "png" or "bmp".

Returns:: Filename.

_phase_2_init_(self)

update_status(self)

Update the enabled/disabled status of the commander.

The attached action calls this function whenever its enabled/disabled status changes, so the commander can adjust the status of the user interface element.

Class Variable Details

action

Type:

NoneType

Value:

None

action_off

Type:

NoneType

Value:

None

description

Type:

NoneType

Value:

None

enabled

Type:

bool

Value:

True

icon

Type:

NoneType

Value:

None

label

Type:

NoneType

Value:

None

name

Type:

NoneType

Value:

None

state

Type:

bool

Value:

False

Type GFCommander

init(self, parent, object_type)
(Constructor)

__fire(self)

__trigger_get_enabled(self)

__trigger_get_state(self)

__trigger_set_enabled(self, value)

__trigger_set_state(self, value)

_event_fire(self)

_get_icon_file(self, size='32x32', format='png')

_phase_2_init_(self)

update_status(self)

action

action_off

description

enabled

icon

label

name

state

GNUe Home

Private API

Developer's Corner

Type GFCommander

__init__(self, parent, object_type) (Constructor)

__fire(self)

__trigger_get_enabled(self)

__trigger_get_state(self)

__trigger_set_enabled(self, value)

__trigger_set_state(self, value)

_event_fire(self)

_get_icon_file(self, size='32x32', format='png')

_phase_2_init_(self)

update_status(self)

action

action_off

description

enabled

icon

label

name

state

GNUe Home

Private API

Developer's Corner

init(self, parent, object_type)
(Constructor)