Package topo :: Package param :: Module tk :: Class ParametersFrameWithApply

Class ParametersFrameWithApply

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

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

Changes made to Parameter representations in the GUI are not applied to the underlying object until Apply is pressed.

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, **params)
Construct a widget with the parent widget MASTER, a name WIDGETNAME and appropriate options.

source code

_create_string_widget(self, frame, name, widget_options)
Return a Tkinter.Entry to represent parameter 'name'.

source code

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

source code

has_unapplied_change(self)
Return True if any one of the packed parameters' displayed values is different from that on the object.

source code

_indicate_tkvar_status(self, param_name, status=None)
blue if the GUI value differs from that set on the object

source code

_handle_gui_set(self, p_name, force=False)
The callback to use for all GUI variable traces/binds *

source code

_close_button(self)
See Close parameter.

source code

update_parameters(self)

source code

_apply_button(self)

source code

_refresh_value(self, param_name)

source code

_refresh_button(self, overwrite_error=True)
See Refresh parameter.

source code

_defaults_button(self)
See Defaults parameter.

source code

Inherited from ParametersFrame: hidden_param, pack_displayed_params, repack_param

Inherited from ParametersFrame (private): _create_selector_widget, _wipe_currently_displaying

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_widget, _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]

Apply = Button(doc= """Set object's Parameters to displayed va...
Set object's Parameters to displayed values.

Inherited from ParametersFrame: Close, Defaults, Refresh, display_threshold

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, **params)
(Constructor)

source code

Construct a widget with the parent widget MASTER, a name WIDGETNAME and appropriate options.

Overrides: Tkinter.BaseWidget.__init__: (inherited documentation)

_create_string_widget(self, frame, name, widget_options)

source code

Return a Tkinter.Entry to represent parameter 'name'.

Overrides: TkParameterized._create_string_widget: (inherited documentation)

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

source code

Overrides: ParametersFrame.set_PO: (inherited documentation)

_indicate_tkvar_status(self, param_name, status=None)

source code

Set the parameter's label to:

blue if the GUI value differs from that set on the object
red if the text doesn't translate to a correct value
black if the GUI and object have the same value

Overrides: TkParameterized._indicate_tkvar_status: (inherited documentation)

_handle_gui_set(self, p_name, force=False)

source code

The callback to use for all GUI variable traces/binds *

Overrides: TkParameterizedBase._handle_gui_set: (inherited documentation)

_close_button(self)

source code

See Close parameter.

Overrides: ParametersFrame._close_button: (inherited documentation)

_refresh_value(self, param_name)

source code

Overrides: ParametersFrame._refresh_value

_refresh_button(self, overwrite_error=True)

source code

See Refresh parameter.

Overrides: ParametersFrame._refresh_button: (inherited documentation)

_defaults_button(self)

source code

See Defaults parameter.

Overrides: ParametersFrame._defaults_button

Class Variable Details

[hide private]

Apply

Set object's Parameters to displayed values.

When editing a class, sets the class defaults (i.e. acts on the class object).

Value:

Button(doc= """Set object's Parameters to displayed values.\n
                          When editing a class, sets the class defaults
                          (i.e. acts on the class object).""")

Class ParametersFrameWithApply

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

_create_string_widget(self, frame, name, widget_options)

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

_indicate_tkvar_status(self, param_name, status=None)

_handle_gui_set(self, p_name, force=False)

_close_button(self)

_refresh_value(self, param_name)

_refresh_button(self, overwrite_error=True)

_defaults_button(self)

Apply

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