Package schrodinger :: Package application :: Package desmond :: Module guide :: Class Guide

Class Guide

ui.widget.tkinterwidget.schroWidget --+    
                                      |    
           Tkinter.Misc --+           |    
                          |           |    
         Tkinter.BaseWidget --+       |    
                              |       |    
               Tkinter.Pack --+       |    
                              |       |    
              Tkinter.Place --+       |    
                              |       |    
               Tkinter.Grid --+       |    
                              |       |    
                 Tkinter.Widget --+   |    
                                  |   |    
                      Tkinter.Frame --+    
                                      |    
          ui.widget.tkinterwidget.Frame --+
                                          |
                                         Guide

This class provides a primitive workflow widget.

An object of this class has two public attributes:

curr_step : Points to the '_Step' object of the current step.
step : A dictionary with keys to be the names of the steps and values to be '_Step' objects.

Nested Classes

[hide private]

Inherited from Tkinter.Misc: getdouble, getint

Instance Methods

[hide private]

__init__(self, master, step=[], sep_pos='top')
Constructor.

step_config(self, step, **kw)
Configures a few steps.

step_configure(self, **kw)
Just an alias of the step_config method.

step_hide(self, step, should_hide=True)
Hides a few steps as given by the 'step' argument, which is a list of _Step objects.

add_step(self, step)
Adds a step to the end of the guide widget.

enable_next(self, should_enable=True)
Enables the next step.

enter_next(self)
Enters the next step.

reset(self)
Resets the guide widget to its original state.

Inherited from ui.widget.tkinterwidget.schroWidget: grid, pack

Inherited from ui.widget.tkinterwidget.schroWidget (private): _getDflts, _retrieveDflts, _update_placement

Inherited from Tkinter.BaseWidget: destroy

Inherited from Tkinter.BaseWidget (private): _do, _setup

Inherited from Tkinter.Misc: __contains__, __getitem__, __setitem__, __str__, after, after_cancel, after_idle, bbox, bell, bind, bind_all, bind_class, bindtags, cget, clipboard_append, clipboard_clear, clipboard_get, colormodel, columnconfigure, config, configure, deletecommand, event_add, event_delete, event_generate, event_info, focus, focus_displayof, focus_force, focus_get, focus_lastfor, focus_set, getboolean, getvar, grab_current, grab_release, grab_set, grab_set_global, grab_status, grid_bbox, grid_columnconfigure, grid_location, grid_propagate, grid_rowconfigure, grid_size, grid_slaves, image_names, image_types, keys, lift, lower, mainloop, nametowidget, option_add, option_clear, option_get, option_readfile, pack_propagate, pack_slaves, place_slaves, propagate, quit, register, rowconfigure, selection_clear, selection_get, selection_handle, selection_own, selection_own_get, send, setvar, size, slaves, tk_bisque, tk_focusFollowsMouse, tk_focusNext, tk_focusPrev, tk_menuBar, tk_setPalette, tk_strictMotif, tkraise, unbind, unbind_all, unbind_class, update, update_idletasks, wait_variable, wait_visibility, wait_window, waitvar, winfo_atom, winfo_atomname, winfo_cells, winfo_children, winfo_class, winfo_colormapfull, winfo_containing, winfo_depth, winfo_exists, winfo_fpixels, winfo_geometry, winfo_height, winfo_id, winfo_interps, winfo_ismapped, winfo_manager, winfo_name, winfo_parent, winfo_pathname, winfo_pixels, winfo_pointerx, winfo_pointerxy, winfo_pointery, winfo_reqheight, winfo_reqwidth, winfo_rgb, winfo_rootx, winfo_rooty, winfo_screen, winfo_screencells, winfo_screendepth, winfo_screenheight, winfo_screenmmheight, winfo_screenmmwidth, winfo_screenvisual, winfo_screenwidth, winfo_server, winfo_toplevel, winfo_viewable, winfo_visual, winfo_visualid, winfo_visualsavailable, winfo_vrootheight, winfo_vrootwidth, winfo_vrootx, winfo_vrooty, winfo_width, winfo_x, winfo_y

Inherited from Tkinter.Misc (private): _bind, _configure, _displayof, _getboolean, _getconfigure, _getconfigure1, _getdoubles, _getints, _grid_configure, _gridconvvalue, _nametowidget, _options, _register, _report_exception, _root, _substitute

Inherited from Tkinter.Pack: forget, info, pack_configure, pack_forget, pack_info

Inherited from Tkinter.Place: place, place_configure, place_forget, place_info

Inherited from Tkinter.Grid: grid_configure, grid_forget, grid_info, grid_remove, location

Class Variables

[hide private]

Inherited from Tkinter.Misc: _noarg_

Inherited from Tkinter.Misc (private): _subst_format, _subst_format_str, _tclCommands

Properties

[hide private]

Inherited from Tkinter.Misc (private): _windowingsystem

Method Details

[hide private]

init(self, master, step=`[]`, sep_pos=`'top'`)
(Constructor)

Constructor.

Parameters:

master - The frame on which this widget will be built.
step - A list of tuples and/or strings. If the element is a tuple, it must have two elements: the first one is the name of the step in the code, the 2nd one is the text shown in the button. If the element of 'step' is a string, then this string will be used as both the name of the step in the code,
sep_pos - This argument indicates where to place a separator line and recoginizes the following values: 'TOP', 'BOTTOM', 'BOTH', and None.

Overrides: Tkinter.BaseWidget.__init__

step_config(self, step, **kw)

Configures a few steps.

Parameters:

step - Must be a list of _Step objects or the constant 'ALL'.

step_hide(self, step, should_hide=True)

Hides a few steps as given by the 'step' argument, which is a list of _Step objects. If 'should_hide' is True, then reveal these steps.

add_step(self, step)

Adds a step to the end of the guide widget.

Parameters:

step - Can be either a string or a tuple of two strings. If it is a string, this string will be used as both the name of the step in the code and the text displayed for the button; if it is a tuple, the first string will be the name of the step in the code, and the 2nd string will be the text displayed for the button.

enable_next(self, should_enable=True)

Enables the next step. If 'should_enable' is False, then it will disable the next step.

reset(self)

Resets the guide widget to its original state.

Normally, the original state is this: the first step is enabled but not yet entered, and the other steps are in the disabled state.

Class Guide

__init__(self, master, step=[], sep_pos='top') (Constructor)

step_config(self, step, **kw)

step_hide(self, step, should_hide=True)

add_step(self, step)

enable_next(self, should_enable=True)

reset(self)

init(self, master, step=`[]`, sep_pos=`'top'`)
(Constructor)