Package topo :: Package param :: Module tk :: Class ParametersFrame

Class ParametersFrame

                 object --+            
                          |            
parameterized.Parameterized --+        
                              |        
            TkParameterizedBase --+    
                                  |    
                    TkParameterized --+
                                      |
           Tkinter.Misc --+           |
                          |           |
         Tkinter.BaseWidget --+       |
                              |       |
               Tkinter.Pack --+       |
                              |       |
              Tkinter.Place --+       |
                              |       |
               Tkinter.Grid --+       |
                              |       |
                 Tkinter.Widget --+   |
                                  |   |
                      Tkinter.Frame --+
                                      |
                                     ParametersFrame

Known Subclasses:

ParametersFrameWithApply

Displays and allows instantaneous editing of the Parameters of a supplied Parameterized.

Changes made to Parameter representations on the GUI are immediately applied to the underlying object.

Nested Classes

[hide private]

Inherited from parameterized.Parameterized: __metaclass__

Inherited from Tkinter.Misc: getdouble, getint

Instance Methods

[hide private]

__init__(self, master, parameterized_object=None, on_change=None, on_modify=None, msg_handler=None, **params)
Create a ParametersFrame with the specifed master, and representing the Parameters of parameterized_object.

source code

hidden_param(self, name)
Return True if a parameter's precedence is below the display threshold.

source code

__create_button_panel(self)
Add the buttons in their own panel (frame).

source code

_refresh_button(self)
See Refresh parameter.

source code

_defaults_button(self)
See Defaults parameter.

source code

_close_button(self)
See Close parameter.

source code

set_PO(self, parameterized_object, on_change=None, on_modify=None)

source code

_wipe_currently_displaying(self)
Wipe old labels and widgets from screen.

source code

__grid_param(self, parameter_name, row)

source code

__make_representation(self, name, on_change=None, on_modify=None)

source code

pack_displayed_params(self, on_change=None, on_modify=None)

source code

_create_selector_widget(self, frame, name, widget_options)
As for the superclass, but binds <<right-click>> event for opening menu.

source code

__right_click(self, event, widget)
Popup the right-click menu.

source code

__edit_PO_in_currently_selected_widget(self)
Open a new window containing a ParametersFrame (actually, a type(self)) for the PO in __currently_selected_widget.

source code

repack_param(self, param_name)

source code

_refresh_value(self, param_name)

source code

Inherited from TkParameterized: gui_get_param, gui_set_param, hide_param, pack_param, unhide_param, unpack_param, update_selector

Inherited from TkParameterized (private): _X, _create_boolean_widget, _create_button_widget, _create_number_widget, _create_string_widget, _create_widget, _handle_gui_set, _indicate_tkvar_status, _param_right_click, _post_add_param, _set_widget_status, _switch_dynamic, _tkvar_set, _update_param_from_tkvar

Inherited from TkParameterizedBase: __getattribute__, __repr__, __setattr__, change_PO, get_parameter_object, get_parameter_value, get_source_po, set_parameter_value

Inherited from TkParameterizedBase (private): _create_tkvar, _create_translator, _init_tkvars, _object2string, _setup_params, _source_POs, _string2object, _tkvar_changed, _tkvar_get

Inherited from parameterized.Parameterized: __getstate__, __setstate__, __str__, debug, defaults, force_new_dynamic_value, get_param_values, get_value_generator, inspect_value, message, print_param_values, script_repr, set_dynamic_time_fn, state_pop, state_push, verbose, warning

Inherited from parameterized.Parameterized (private): _check_params, _instantiate_param, _set_name

Inherited from object: __delattr__, __hash__, __new__, __reduce__, __reduce_ex__

Inherited from Tkinter.BaseWidget: destroy

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

Inherited from Tkinter.Misc: __getitem__, __setitem__, 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, _getdoubles, _getints, _grid_configure, _nametowidget, _options, _register, _report_exception, _root, _substitute

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

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

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

Class Methods

[hide private]

Inherited from parameterized.Parameterized: params, print_param_defaults

Class Variables

[hide private]

Defaults = Button(doc= """Return values to class defaults.""")
Return values to class defaults.

Refresh = Button(doc= "Return values to those currently set on...
Return values to those currently set on the object (or, if editing a class, to those currently set on the class).

Close = Button(doc= "Close the window. (If applicable, asks if...
Close the window.

display_threshold = Number(default= 0, precedence=-10, doc= "P...
Parameters with precedence below this value are not displayed.

Inherited from TkParameterized: pretty_parameters

Inherited from TkParameterizedBase (private): _extraPO

Inherited from parameterized.Parameterized: name, print_level

Inherited from Tkinter.Misc: _noarg_

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, master, parameterized_object=None, on_change=None, on_modify=None, msg_handler=None, **params)
(Constructor)

source code

Create a ParametersFrame with the specifed master, and representing the Parameters of parameterized_object.

on_change is an optional function to call whenever any of the GUI variables representing Parameter values is set() by the GUI (i.e. by the user). Since a variable's value is not necessarily changed by such a set(), on_modify is another optional function to call only when a GUI variable's value actually changes. (See TkParameterized for more detail.)

Overrides: Tkinter.BaseWidget.__init__

_create_selector_widget(self, frame, name, widget_options)

source code

As for the superclass, but binds <<right-click>> event for opening menu.

Overrides: TkParameterized._create_selector_widget

repack_param(self, param_name)

source code

Overrides: TkParameterized.repack_param

Class Variable Details

[hide private]

Refresh

Return values to those currently set on the object (or, if editing a class, to those currently set on the class).

Value:

Button(doc= "Return values to those currently set on the object (or, if editing a 
class, to those currently set on the class).")

Close

Close the window. (If applicable, asks if unsaved changes should be saved).

Value:

Button(doc= "Close the window. (If applicable, asks if unsaved changes should be s
aved).")

display_threshold

Parameters with precedence below this value are not displayed.

Value:

Number(default= 0, precedence=-10, doc= "Parameters with precedence below this val
ue are not displayed.")

Class ParametersFrame

__init__(self, master, parameterized_object=None, on_change=None, on_modify=None, msg_handler=None, **params) (Constructor)

_create_selector_widget(self, frame, name, widget_options)

repack_param(self, param_name)

Refresh

Close

display_threshold

init(self, master, parameterized_object=None, on_change=None, on_modify=None, msg_handler=None, **params)
(Constructor)