Module Hierarchy

• forms: Form management.
  • GFConfig: Valid configuration options for forms (appears under [forms] section in gnue.conf)
  • GFObjects
    • GFBlock: Classes making up the Block object.
    • GFBox: Logical box support
    • GFButton: Logical button support
    • GFComponent: Component support (bonobo for gtk2, ole for win32, etc.)
    • GFContainer: A base class for all GFObjects that can be containers
    • GFDataSource: Logical datasource support
    • GFEntry: The primary data entry widget in forms
    • GFField: Fields of a block, representing database columns.
    • GFGrid: Logical box support
    • GFGridLine: Logical box support
    • GFHBox: Logical box support
    • GFImage: Wrapper class for image objects
    • GFLabel: A class wrapping static text objects
    • GFLayout: Handles the <layout> tag.
    • GFLogic: Handles the <logic> tag.
    • GFObj: Base class for all objects represented by an XML tag in a GFD tree.
    • GFOption: Option support
    • GFOptions: Options container support
    • GFPage: Logical page support
    • GFParameter: Parameter support.
    • GFScrollBar: Class implementing scrollbars for controlling record positions within blocks
    • GFTabStop: Base class for all objects that can receive the keyboard focus on the UI.
    • GFVBox: Logical box support
    • commanders: Classes for all the visible objects that call actions: Menus and Toolbars
  • input
    • GFKeyMapper: Handles physical to logical key mapping for GNUe Forms.
    • displayHandlers
      • Checkbox: Display handler for entries of type checkbox
      • Component: DisplayHandler classes for Forms input validation
      • Cursor: The base display handler for entries that deal with cursor based input (aka text).
      • Dropdown: DisplayHandler classes for Forms input validation
      • Image: Display handler responsible for handling image style entries.
      • Listbox: DisplayHandler classes for Forms input validation
      • Numeric: DisplayHandler classes for Forms input validation
      • Password: DisplayHandler classes for Forms input validation
      • Text: Text display handler
      • datehandler: DisplayHandler classes for input validation of date, time and datetime values
  • uidrivers
    • _base
      • Exceptions: Common exceptions
      • widgets
        • _base: Base class for UIwidgets used by specific UI drivers to subclass their widgets from.

Class Hierarchy

• __builtin__.object: The most base type
  • gnue.common.events.EventAware.EventAware: The base class for an object that sends and receives events
    • gnue.forms.GFObjects.GFBlock.GFBlock: A block in a form definition.
    • gnue.forms.input.displayHandlers.Cursor.BaseCursor: The base display handler for entries that deal with cursor based input (aka text).
      • gnue.forms.input.displayHandlers.Checkbox.Checkbox
      • gnue.forms.input.displayHandlers.Component.Component
      • gnue.forms.input.displayHandlers.Dropdown.Dropdown
      • gnue.forms.input.displayHandlers.Listbox.Listbox
      • gnue.forms.input.displayHandlers.Numeric.Numeric: Class to handle the display and entry of numeric fields.
      • gnue.forms.input.displayHandlers.Password.Password
      • gnue.forms.input.displayHandlers.Text.Text
      • gnue.forms.input.displayHandlers.datehandler.DateRelated: Base class for all date- and time-related displayhandler
        • gnue.forms.input.displayHandlers.datehandler.Date: Display handler for date values.
        • gnue.forms.input.displayHandlers.datehandler.DateTime: Class to handle the display and entry of date based fields.
        • gnue.forms.input.displayHandlers.datehandler.Time: Display handler for time values.
      • gnue.forms.input.displayHandlers.Image.Image: Display handler responsible for handling image style entries.
  • gnue.common.definitions.GParserHelpers.ParserObj: Base class for objects handled by a gnue.common.definitions.GParser.
    • gnue.common.definitions.GObjects.GObj: The base class for almost all GNUe objects.
      • gnue.common.datasources.GConditions.GCondition: A GCondition instance is allways the root node of a condition tree.
        • gnue.common.datasources.GConditions.GConditionElement: Abstract base class for all condition elements.
          • gnue.common.datasources.GConditions.GCParam: Abstract class for parameters.
            • gnue.forms.GFObjects.GFParameter.GFCParam: Parameter used in conditions.
      • gnue.common.datasources.GDataSource.GDataSource: Class that handles DataSources.
        • gnue.forms.GFObjects.GFDataSource.GFDataSource: A GFDataSource wrapps a gnue.common.datasources.GDataSource object
      • gnue.forms.GFObjects.GFObj.GFObj: A GFObj is the base class for all objects of a GF object tree.
        • gnue.forms.GFObjects.GFContainer.GFContainer: A base class for all GFObjects that can be containers
          • gnue.forms.GFObjects.GFBlock.GFBlock: A block in a form definition.
          • gnue.forms.GFObjects.GFBox.GFBox
          • gnue.forms.GFObjects.GFGrid.GFGrid
          • gnue.forms.GFObjects.GFGridLine.GFGridLine
          • gnue.forms.GFObjects.GFHBox.GFHBox
          • gnue.forms.GFObjects.GFPage.GFPage: Implementation of the <page> tag
          • gnue.forms.GFObjects.GFVBox.GFVBox
        • gnue.forms.GFObjects.GFField.GFField: A field manages a database column, possibly with foreign key lookup.
        • gnue.forms.GFObjects.GFLabel.GFLabel
        • gnue.forms.GFObjects.GFLayout.GFLayout: Implementation of the <layout> tag
        • gnue.forms.GFObjects.GFLogic.GFLogic: The logic tag is a container for all business logic elements like, blocks, fields, block-level and field-level triggers.
        • gnue.forms.GFObjects.GFOption.GFOption
        • gnue.forms.GFObjects.GFParameter.GFParameter: A parameter defined in a form.
        • gnue.forms.GFObjects.GFScrollBar.GFScrollBar
        • gnue.forms.GFObjects.GFTabStop.GFTabStop: A base class for all GFObjects that can receive focus on the UI.
          • gnue.forms.GFObjects.GFButton.GFButton
          • gnue.forms.GFObjects.GFTabStop.GFFieldBound
            • gnue.forms.GFObjects.GFComponent.GFComponent
            • gnue.forms.GFObjects.GFEntry.GFEntry
            • gnue.forms.GFObjects.GFImage.GFImage
        • gnue.forms.GFObjects.commanders.GFCommander: Any object that is bound to an action.
          • gnue.forms.GFObjects.commanders.GFMenuItem: An item in a menu that fires an action when selected.
          • gnue.forms.GFObjects.commanders.GFToolButton: A button in a toolbar that fires an action when selected.
        • gnue.forms.GFObjects.commanders.GFMenu: A Menu that can either be the menu bar, a context menu, or a submenu.
        • gnue.forms.GFObjects.commanders.GFToolbar: A Toolbar containing GFToolButton buttons.
      • gnue.forms.GFObjects.GFOptions.GFOptions
      • gnue.forms.uidrivers._base.widgets._base.UIWidget: Base class for user interface widgets.
  • __builtin__.type: type(object) -> the object's type type(name, bases, dict) -> a new type
• exceptions.Exception: Common base class for all exceptions.
  • exceptions.StandardError: Base class for all standard Python exceptions.
    • gnue.forms.uidrivers._base.Exceptions.UIException
      • gnue.forms.uidrivers._base.Exceptions.DriverNotSupported
  • gnue.common.base.errors.Error: The same as the builtin python Exception, but can handle messages that are unicode strings.
    • gnue.common.base.errors.AdminError: This exception class should be used for exceptions indicating a misconfiguration in a widest sense.
      • gnue.forms.input.displayHandlers.Image.NeedsPilForImages: Python Imaging (PIL) is required but not installed.
    • gnue.common.base.errors.ApplicationError: This class should be used for errors caused by applications like a corrupt trigger code, or a misformed xml-file and so on.
      • gnue.forms.GFObjects.GFField.InvalidDBValueError: The database has returned an invalid value for a field.
      • gnue.common.definitions.GParser.MarkupError
        • gnue.forms.GFObjects.GFObj.BlockNotFoundError: Element references non-existent block
        • gnue.forms.GFObjects.GFBlock.DatasourceNotFoundError: This block references a non-existant datasource.
        • gnue.forms.GFObjects.GFField.DataSourceNotFoundError
        • gnue.forms.GFObjects.GFObj.FieldNotFoundError: Element refernces non-existent field
        • gnue.forms.GFObjects.GFField.FKeyMissingError
        • gnue.forms.GFObjects.GFField.InvalidDefaultValueError: The field definition contains an invalid default value or default query value for a field.
        • gnue.forms.GFObjects.GFLayout.LayoutConceptError: Element not allowed in a managed/positioning layout
        • gnue.forms.GFObjects.GFField.LengthNotAllowedError
        • gnue.forms.GFObjects.GFParameter.UndefinedParameterError: A parameter referenced in a condition is not defined.
        • gnue.forms.uidrivers._base.widgets._base.InvalidBoundingBoxError: Element A overlaps Element B
        • gnue.forms.uidrivers._base.widgets._base.InvalidSpanError: An element has an invalid width or height
        • gnue.forms.GFObjects.GFField.MinimumLengthNotAllowedError
      • gnue.forms.GFObjects.GFParameter.ParameterValueError: A parameter has been assigned a value that can not be converted into the parameter's datatype.
      • gnue.forms.GFObjects.GFField.InvalidPropertyValueError: An invalid value is assigned to a property.
    • gnue.common.base.errors.SystemError: This exception class should be used for exceptions indicating a bug in GNUe.
      • gnue.forms.input.GFKeyMapper.InvalidKeystrokeName: This class is used for exceptions indicating that a keystroke that was received was not valid.
    • gnue.common.base.errors.UserError: This class should be used for exceptions where a user did something wrong, or a situation has occured which isn't dramatic, but the user has to be informed of.
      • gnue.forms.GFObjects.GFField.InvalidFieldValueError: The user has provided an invalid value for a field.
      • gnue.forms.input.displayHandlers.datehandler.InvalidDateLiteral
      • gnue.forms.input.displayHandlers.datehandler.InvalidTimeLiteral
      • gnue.forms.GFObjects.GFField.MinimumLengthError
• gnue.common.logic.GTrigger.GTriggerExtension: Base class for all objects that can fire triggers.
  • gnue.forms.GFObjects.GFObj.GFObj: A GFObj is the base class for all objects of a GF object tree.
    • gnue.forms.GFObjects.GFContainer.GFContainer: A base class for all GFObjects that can be containers
      • gnue.forms.GFObjects.GFBlock.GFBlock: A block in a form definition.
      • gnue.forms.GFObjects.GFBox.GFBox
      • gnue.forms.GFObjects.GFGrid.GFGrid
      • gnue.forms.GFObjects.GFGridLine.GFGridLine
      • gnue.forms.GFObjects.GFHBox.GFHBox
      • gnue.forms.GFObjects.GFPage.GFPage: Implementation of the <page> tag
      • gnue.forms.GFObjects.GFVBox.GFVBox
    • gnue.forms.GFObjects.GFField.GFField: A field manages a database column, possibly with foreign key lookup.
    • gnue.forms.GFObjects.GFLabel.GFLabel
    • gnue.forms.GFObjects.GFLayout.GFLayout: Implementation of the <layout> tag
    • gnue.forms.GFObjects.GFLogic.GFLogic: The logic tag is a container for all business logic elements like, blocks, fields, block-level and field-level triggers.
    • gnue.forms.GFObjects.GFOption.GFOption
    • gnue.forms.GFObjects.GFParameter.GFParameter: A parameter defined in a form.
    • gnue.forms.GFObjects.GFScrollBar.GFScrollBar
    • gnue.forms.GFObjects.GFTabStop.GFTabStop: A base class for all GFObjects that can receive focus on the UI.
      • gnue.forms.GFObjects.GFButton.GFButton
      • gnue.forms.GFObjects.GFTabStop.GFFieldBound
        • gnue.forms.GFObjects.GFComponent.GFComponent
        • gnue.forms.GFObjects.GFEntry.GFEntry
        • gnue.forms.GFObjects.GFImage.GFImage
    • gnue.forms.GFObjects.commanders.GFCommander: Any object that is bound to an action.
      • gnue.forms.GFObjects.commanders.GFMenuItem: An item in a menu that fires an action when selected.
      • gnue.forms.GFObjects.commanders.GFToolButton: A button in a toolbar that fires an action when selected.
    • gnue.forms.GFObjects.commanders.GFMenu: A Menu that can either be the menu bar, a context menu, or a submenu.
    • gnue.forms.GFObjects.commanders.GFToolbar: A Toolbar containing GFToolButton buttons.
• gnue.common.logic.GTriggerCore.GTriggerCore: Base class for all objects that can be exported to action/trigger namespace.
  • gnue.common.definitions.GObjects.GObj: The base class for almost all GNUe objects.
    • gnue.common.datasources.GConditions.GCondition: A GCondition instance is allways the root node of a condition tree.
      • gnue.common.datasources.GConditions.GConditionElement: Abstract base class for all condition elements.
        • gnue.common.datasources.GConditions.GCParam: Abstract class for parameters.
          • gnue.forms.GFObjects.GFParameter.GFCParam: Parameter used in conditions.
    • gnue.common.datasources.GDataSource.GDataSource: Class that handles DataSources.
      • gnue.forms.GFObjects.GFDataSource.GFDataSource: A GFDataSource wrapps a gnue.common.datasources.GDataSource object
    • gnue.forms.GFObjects.GFObj.GFObj: A GFObj is the base class for all objects of a GF object tree.
      • gnue.forms.GFObjects.GFContainer.GFContainer: A base class for all GFObjects that can be containers
        • gnue.forms.GFObjects.GFBlock.GFBlock: A block in a form definition.
        • gnue.forms.GFObjects.GFBox.GFBox
        • gnue.forms.GFObjects.GFGrid.GFGrid
        • gnue.forms.GFObjects.GFGridLine.GFGridLine
        • gnue.forms.GFObjects.GFHBox.GFHBox
        • gnue.forms.GFObjects.GFPage.GFPage: Implementation of the <page> tag
        • gnue.forms.GFObjects.GFVBox.GFVBox
      • gnue.forms.GFObjects.GFField.GFField: A field manages a database column, possibly with foreign key lookup.
      • gnue.forms.GFObjects.GFLabel.GFLabel
      • gnue.forms.GFObjects.GFLayout.GFLayout: Implementation of the <layout> tag
      • gnue.forms.GFObjects.GFLogic.GFLogic: The logic tag is a container for all business logic elements like, blocks, fields, block-level and field-level triggers.
      • gnue.forms.GFObjects.GFOption.GFOption
      • gnue.forms.GFObjects.GFParameter.GFParameter: A parameter defined in a form.
      • gnue.forms.GFObjects.GFScrollBar.GFScrollBar
      • gnue.forms.GFObjects.GFTabStop.GFTabStop: A base class for all GFObjects that can receive focus on the UI.
        • gnue.forms.GFObjects.GFButton.GFButton
        • gnue.forms.GFObjects.GFTabStop.GFFieldBound
          • gnue.forms.GFObjects.GFComponent.GFComponent
          • gnue.forms.GFObjects.GFEntry.GFEntry
          • gnue.forms.GFObjects.GFImage.GFImage
      • gnue.forms.GFObjects.commanders.GFCommander: Any object that is bound to an action.
        • gnue.forms.GFObjects.commanders.GFMenuItem: An item in a menu that fires an action when selected.
        • gnue.forms.GFObjects.commanders.GFToolButton: A button in a toolbar that fires an action when selected.
      • gnue.forms.GFObjects.commanders.GFMenu: A Menu that can either be the menu bar, a context menu, or a submenu.
      • gnue.forms.GFObjects.commanders.GFToolbar: A Toolbar containing GFToolButton buttons.
    • gnue.forms.GFObjects.GFOptions.GFOptions
    • gnue.forms.uidrivers._base.widgets._base.UIWidget: Base class for user interface widgets.
• gnue.forms.input.GFKeyMapper.BaseKeyMapper: A basic key mapper.
• gnue.forms.input.GFKeyMapper._VirtualKeys: A container class for the Virtual Key definitions.