pdk.Gui.Widgets.Widgets ($Date: 2002/12/04 10:16:47 $)
index
pdk/Gui/Widgets/Widgets.py

Base widget classes.

FOG 10.2002

 
Classes
            
wxPython.lib.PyCrust.shell.Shell(wxPython.stc_.wxStyledTextCtrl)
pdkShell(wxPython.lib.PyCrust.shell.Shell, pdk.Gui.Widgets.CoreWidgets.pdkWidget)
pdk.ErrorClasses.pdkError(exceptions.StandardError)
NamedConfigurationManagerError
pdk.Gui.Widgets.CoreWidgets.pdkStaticBox(wxPython.windows.wxPanel, pdk.Gui.Widgets.CoreWidgets.pdkWidget)
NamedConfigurationManager
pdk.Gui.Widgets.CoreWidgets.pdkTreeCtrl(pdk.Gui.Widgets.CoreWidgets.pdkWidget, wxPython.controls2.wxTreeCtrl)
TreeShelfBrowser
pdk.Gui.Widgets.CoreWidgets.pdkWidget(pdk.Gui.WidgetStateManagers.StatefulWidget, pdk.Base.OptionHandler)
GaugeWithText(wxPython.windows.wxPanel, pdk.Gui.Widgets.CoreWidgets.pdkWidget)
pdkImageView(wxPython.windows.wxPanel, pdk.Gui.Widgets.CoreWidgets.pdkWidget)
pdkShell(wxPython.lib.PyCrust.shell.Shell, pdk.Gui.Widgets.CoreWidgets.pdkWidget)
wxPython.frames.wxFrame(wxPython.frames.wxFramePtr)
OutputWindow
wxPython.windows.wxPanel(wxPython.windows.wxPanelPtr)
GaugeWithText(wxPython.windows.wxPanel, pdk.Gui.Widgets.CoreWidgets.pdkWidget)
pdkImageView(wxPython.windows.wxPanel, pdk.Gui.Widgets.CoreWidgets.pdkWidget)
 
class pdkImageView(wxPython.windows.wxPanel, pdk.Gui.Widgets.CoreWidgets.pdkWidget)
     
Purpose:image viewing class for displaying wxImage instances
Detail:creates a memory DC and displays image data on the screen after conversion to a bitmap with a call to the .setImage method. Supports rescaling, although this is slow. When the widget option "enableStatusBar" is set, the current image position of the mouse cursor and the intensity in that point is reported in a separate status bar.

 
  
Method resolution order:
pdkImageView
wxPython.windows.wxPanel
wxPython.windows.wxPanelPtr
wxPython.windows.wxWindowPtr
wxPython.windows.wxEvtHandlerPtr
wxPython.misc.wxObjectPtr
pdk.Gui.Widgets.CoreWidgets.pdkWidget
pdk.Gui.WidgetStateManagers.StatefulWidget
pdk.Base.OptionHandler

Methods defined here:
OnIdle(self, ev)
OnLeaveWindow(self, ev)
OnMotion(self, ev)
OnPaint(self, ev)
OnSize(self, ev)
__init__(self, parent, id, **optionD)
convertToWxImage(self, image)
overwrite this for classes that use different image classes than wxImage.
getImage(self)
returns the image associated with the display.
getImageSize(self, image)
overwrite this for classes that use different image classes than wxImage.
getImageTitle(self)
returns the title of the image associcated with the display.
getPixelIntensity(self, wxImg, x, y)
overwrite this for classes that use different image classes than wxImage.
getView(self)
we might need a reference to the view widget for hooking up callbacks etc.
getViewSize(self)
returns the current size of the image view widget.
scaleImage(self, image, width, height)
overwrite this for classes that use different image classes than wxImage.
setImage(self, image, title='<No Title>')
associates image with the display. "title" can be used to set the title string shown at the top of the view widget.

Data and non-method functions defined here:
WIDGETOPTIONS = {'enableStatusBar': 0}
 
class pdkShell(wxPython.lib.PyCrust.shell.Shell, pdk.Gui.Widgets.CoreWidgets.pdkWidget)
       
  
Method resolution order:
pdkShell
wxPython.lib.PyCrust.shell.Shell
wxPython.stc_.wxStyledTextCtrl
wxPython.stc_.wxStyledTextCtrlPtr
wxPython.controls.wxControlPtr
wxPython.windows.wxWindowPtr
wxPython.windows.wxEvtHandlerPtr
wxPython.misc.wxObjectPtr
pdk.Gui.Widgets.CoreWidgets.pdkWidget
pdk.Gui.WidgetStateManagers.StatefulWidget
pdk.Base.OptionHandler

Methods defined here:
AddText(self, text)
# FIXME: this can go away once wxStyledTextCtrl supports line wrapping
OnSize(self, ev)
# FIXME: this can go away once wxStyledTextCtrl supports line wrapping
__init__(self, parent, wxId, **optionD)
deleteLocalvariable(self, variableName)
getLocalVariable(self, variableName)
getLocals(self)
push(self, command)
registerCommandCallback(self, patString, callbackF)
setLocalVariable(self, variableName, variableValue)
setLocals(self, localD)

Data and non-method functions defined here:
WIDGETOPTIONS = {'startupCode': None}
 
class GaugeWithText(wxPython.windows.wxPanel, pdk.Gui.Widgets.CoreWidgets.pdkWidget)
     
Purpose:displays a progress gauge widget with text
Detail:meant for use in a status bar. Widget options: "messageText" -- the text to be displayed "gaugeRange" -- number of update intervals "shadowWidth" -- 3d shadow width for the gauge

 
  
Method resolution order:
GaugeWithText
wxPython.windows.wxPanel
wxPython.windows.wxPanelPtr
wxPython.windows.wxWindowPtr
wxPython.windows.wxEvtHandlerPtr
wxPython.misc.wxObjectPtr
pdk.Gui.Widgets.CoreWidgets.pdkWidget
pdk.Gui.WidgetStateManagers.StatefulWidget
pdk.Base.OptionHandler

Methods defined here:
Update(self, position)
this is called to set the position of the gauge to position (relative to the range specified with the gaugeRange constructor argument).
__init__(self, parent, wxId, **optionD)

Data and non-method functions defined here:
WIDGETOPTIONS = {'gaugeRange': 100, 'messageText': '', 'shadowWidth': 0}
 
class NamedConfigurationManager(pdk.Gui.Widgets.CoreWidgets.pdkStaticBox)
     
Purpose:generic class for managing the values of a widget collection
Detail:

provides savable named configurations for the values of a collection of widgets. For this to work, the configuration manager instance, its parent, and the widgets to be managed must be properly defined pdk widgets (i.e., have ID strings).

The widgets to be managed can be specified with the managedWidgets widget option (a list of pdk ID strings). If none are specified, the configuration manager`s siblings are managed. Note that it does not make much sense to use the standard widget state managing services with any widget controlled by a configuration manager (e.g. by using the registervalue XML option).


 
  
Method resolution order:
NamedConfigurationManager
pdk.Gui.Widgets.CoreWidgets.pdkStaticBox
wxPython.windows.wxPanel
wxPython.windows.wxPanelPtr
wxPython.windows.wxWindowPtr
wxPython.windows.wxEvtHandlerPtr
wxPython.misc.wxObjectPtr
pdk.Gui.Widgets.CoreWidgets.pdkWidget
pdk.Gui.WidgetStateManagers.StatefulWidget
pdk.Base.OptionHandler

Methods defined here:
OnButtonLoadConfiguration(self, ev)
OnButtonRemoveConfiguration(self, ev)
OnButtonSaveConfiguration(self, ev)
OnComboBoxFocus(self, ev)
OnComboBoxKey(self, ev)
OnComboBoxSelectConfiguration(self, ev)
OnIdle(self, ev)
__init__(self, parent, wxId, **optionD)
getState(self, stateType)
onInitWidgetData(self, stateType, data)
onInstantiate(self, *args)
setState(self, stateType, data)

Data and non-method functions defined here:
WIDGETOPTIONS = {'label': 'configurations', 'managedWidgets': None}
 
class NamedConfigurationManagerError(pdk.ErrorClasses.pdkError)
     
Purpose:specialized error class for NamedConfigurationManager

 
  
Method resolution order:
NamedConfigurationManagerError
pdk.ErrorClasses.pdkError
exceptions.StandardError
exceptions.Exception

Data and non-method functions defined here:
CODES = {'existing_statemethod': ('classes with ConfigurationManager among their ch...must not define getState() or setState() methods!', ''), 'parent_w/o_widgetid': ('a ConfigurationManger instance, its parent, and ... declared pdk widgets (i.e., have pdk ID strings)', '')}
DOMAIN = 'NamedConfigurationManager'
 
class OutputWindow(wxPython.frames.wxFrame)
     
Purpose:generic output window

 
  
Method resolution order:
OutputWindow
wxPython.frames.wxFrame
wxPython.frames.wxFramePtr
wxPython.frames.wxTopLevelWindowPtr
wxPython.windows.wxWindowPtr
wxPython.windows.wxEvtHandlerPtr
wxPython.misc.wxObjectPtr

Methods defined here:
__init__(self, parent, wxId, title, **optionD)
write(self, outputText)
 
class TreeShelfBrowser(pdk.Gui.Widgets.CoreWidgets.pdkTreeCtrl)
     
Purpose:a tree control that browses the entries of a pdk.DataClasses.TreeShelf
Details:all selections of non-leaf items are vetoed. To implement interactive access to the various values stored in the shelf being browsed, just hook up the EVT_TREE_ITEM_CHANGED event to the .GetValue method.

 
  
Method resolution order:
TreeShelfBrowser
pdk.Gui.Widgets.CoreWidgets.pdkTreeCtrl
pdk.Gui.Widgets.CoreWidgets.pdkWidget
pdk.Gui.WidgetStateManagers.StatefulWidget
pdk.Base.OptionHandler
wxPython.controls2.wxTreeCtrl
wxPython.controls2.wxTreeCtrlPtr
wxPython.controls.wxControlPtr
wxPython.windows.wxWindowPtr
wxPython.windows.wxEvtHandlerPtr
wxPython.misc.wxObjectPtr

Methods defined here:
GetValue(self)
returns the shelf content for the currently selected item.
OnItemCollapsed(self, ev)
OnItemExpanded(self, ev)
OnSelectionChanging(self, ev)
__init__(self, parent, wxId, **optionD)
browse(self, shelfFileName)
points the browser to the shelf file shelfFileName.

Data and non-method functions defined here:
WIDGETOPTIONS = {'rootLabel': <pdk.Base.Option object>, 'shelfFileName': None}
 
Author
            
$Author: gathmann $