Table of Contents

Class: MegaArchetype bkchem/Pmw.py

Megawidget abstract root class.

Methods   
__init__
__setitem__
__str__
addoptions
cget
component
componentaliases
componentgroup
components
configure
createcomponent
createlabel
defineoptions
destroy
destroycomponent
hulldestroyed
initialiseoptions
interior
isinitoption
options
  __init__ 
__init__ (
        self,
        parent=None,
        hullClass=None,
        )

  __setitem__ 
__setitem__ (
        self,
        key,
        value,
        )

  __str__ 
__str__ ( self )

  addoptions 
addoptions ( self,  optionDefs )

Add additional options, providing the default value and the method to call when the value is changed. See "defineoptions" for more details

  cget 
cget ( self,  option )

Get current configuration setting.

Exceptions   
KeyError, 'Unknown option "' + option + '" for ' + self.__class__.__name__
  component 
component ( self,  name )

Return a component widget of the megawidget given the component's name This allows the user of a megawidget to access and configure widget components directly.

  componentaliases 
componentaliases ( self )

Return a list of all component aliases.

  componentgroup 
componentgroup ( self,  name )

  components 
components ( self )

Return a list of all components.

  configure 
configure (
        self,
        option=None,
        **kw,
        )

Query or configure the megawidget options.

If not empty, kw is a dictionary giving new values for some of the options of this megawidget or its components. For options defined for this megawidget, set the value of the option to the new value and call the configuration callback function, if any. For options of the form <component>_<option>, where <component> is a component of this megawidget, call the configure method of the component giving it the new value of the option. The <component> part may be an alias or a component group name.

If option is None, return all megawidget configuration options and settings. Options are returned as standard 5 element tuples

If option is a string, return the 5 element tuple for the given configuration option.

Exceptions   
KeyError, 'Cannot configure initialisation option "' + option + '" for ' + self.__class__.__name__
KeyError, 'Unknown option "' + option + '" for ' + self.__class__.__name__
  createcomponent 
createcomponent (
        self,
        componentName,
        componentAliases,
        componentGroup,
        widgetClass,
        *widgetArgs,
        *kw,
        )

Exceptions   
ValueError, 'Component "%s" already exists' % componentName
ValueError, 'Component name "%s" must not contain "_"' % componentName
  createlabel 
createlabel (
        self,
        parent,
        childCols=1,
        childRows=1,
        )

  defineoptions 
defineoptions (
        self,
        keywords,
        optionDefs,
        dynamicGroups=(),
        )

Create options, providing the default value and the method to call when the value is changed. If any option created by base classes has the same name as one in <optionDefs>, the base class's value and function will be overriden.

  destroy 
destroy ( self )

Clean up optionInfo in case it contains circular references in the function field, such as self._settitle in class MegaToplevel.

  destroycomponent 
destroycomponent ( self,  name )

Remove a megawidget component.

  hulldestroyed 
hulldestroyed ( self )

  initialiseoptions 
initialiseoptions ( self,  dummy=None )

Exceptions   
KeyError, text + string.join( unusedOptions, ', ' ) + '" for ' + self.__class__.__name__
  interior 
interior ( self )

  isinitoption 
isinitoption ( self,  option )

  options 
options ( self )


Table of Contents

This document was automatically generated on Wed Jun 1 11:05:30 2005 by HappyDoc version 2.1