This is a special kind of dialog. More...
Methods defined here: | |
def | Back |
def | Forward |
def | Open |
def | Page |
def | __init__ |
def | done |
Methods inherited from DialogBase: | |
def | AddIdle |
def | AddStartup |
def | AddTask |
def | AssertNotDestroyed |
def | CancelIdle |
def | Destroy |
def | EvaluateValid |
def | IsBuilding |
def | IsEnabled |
def | IsRunning |
def | Quit |
def | RememberWindowPosition |
def | Reset |
def | Run |
def | SetButtons |
def | __getmemoize__ |
def | __new_field__ |
def | __setmemoize__ |
def | add_after |
def | after |
def | get_read_only |
def | hide |
def | set_read_only |
def | show |
Data descriptors inherited from DialogBase: | |
def | Memoize |
Set to True if you'd like to be able to call done, or Run, more than once on this Dialog. | |
def | default_focus_window |
def | grab |
def | read_only |
Data and other attributes inherited from DialogBase: | |
Building = True | |
ButtonDown = False | |
Buttons = None | |
dictionary | Buttons_dict = {} |
DefaultFocusWindow = None | |
Running = False | |
Startups = None | |
StartupsStop = False | |
list | Tasks = [] |
UsedButtons = None | |
WaitingToShow = False | |
exit_status = False | |
tk = None | |
window = None | |
__Cancel__ = None | |
__Okay__ = None | |
__Reset__ = None |
Methods inherited from dialog.modelroot.ModelRoot: | |
def | AddRule |
def | GetField |
def | foo |
def | Revert |
def | Set |
def | foo |
def | __empty_value__ |
def | __get_controller__ |
def | __get_display__ |
def | __get_model__ |
def | __get_root__ |
def | __getitem__ |
def | __set_controller__ |
def | __set_model__ |
def | foo |
def | run_pending |
def | size_info |
Data descriptors inherited from dialog.modelroot.ModelRoot: | |
def | controller |
def | display |
def | model |
def | root |
This actually searches up the tree for a model root because this can change as the dialog is being built. | |
def | valid |
Data and other attributes inherited from dialog.modelroot.ModelRoot: | |
Controller = None | |
Display = None | |
DisplayModelFactory = None | |
Model = None | |
Root = None | |
Setup = False | |
Values = None |
Methods inherited from dialog.item.Item: | |
def | AddContext |
def | AddStateFunction |
def | DisableIf |
def | EnableIf |
def | Find |
def | HasContext |
def | RemoveStateFunction |
def | SetValid |
def | Update |
def | __delitem__ |
def | __get_children__ |
def | __get_dialog__ |
def | __getnopack__ |
def | __getparent__ |
def | __getrules__ |
def | __getvalid__ |
def | __pending__ |
def | __setnopack__ |
def | child_added |
def | child_removed |
def | find_type |
Data descriptors inherited from dialog.item.Item: | |
def | __dict__ |
dictionary for instance variables (if defined) | |
def | __weakref__ |
list of weak references to the object (if defined) | |
def | children |
def | dialog |
def | item_valid |
def | no_pack |
def | parent |
def | rules |
Returns a list of all of the current rule skeletons. |
Data and other attributes inherited from dialog.item.Item: | |
Context = None | |
CurrentlyEnabled = True | |
tuple | RuleRegistry = () |
Rules = None | |
WatchChild = None | |
__Load__ = None | |
__Store__ = None |
Methods inherited from dialog.widget.Widget: | |
def | DoState |
def | GetWidget |
def | Grid |
def | Pack |
def | PackForget |
def | PackInfo |
def | PackSlaves |
def | SetEnabled |
def | SetWidget |
def | WatchState |
def | WidgetExists |
def | __get_widget__ |
def | __set_widget__ |
def | list_widgets |
Data descriptors inherited from dialog.widget.Widget: | |
def | default_color |
def | widget |
The main Tkinter widget for this item. |
Data and other attributes inherited from dialog.widget.Widget: | |
Enabled = True | |
Extras = None |
Additional Inherited Members | |
Public Member Functions inherited from dialog.dialog.DialogBase | |
Public Member Functions inherited from dialog.modelroot.ModelRoot | |
Public Member Functions inherited from dialog.item.Item | |
Public Member Functions inherited from dialog.widget.Widget | |
Static Public Attributes inherited from dialog.dialog.DialogBase | |
Building = True | |
ButtonDown = False | |
Buttons = None | |
dictionary | Buttons_dict = {} |
DefaultFocusWindow = None | |
Running = False | |
Startups = None | |
StartupsStop = False | |
list | Tasks = [] |
UsedButtons = None | |
WaitingToShow = False | |
exit_status = False | |
tk = None | |
window = None | |
Controller = None | |
Display = None | |
DisplayModelFactory = None | |
Model = None | |
Root = None | |
Setup = False | |
Values = None | |
Context = None | |
CurrentlyEnabled = True | |
tuple | RuleRegistry = () |
Rules = None | |
WatchChild = None | |
Enabled = True | |
Extras = None | |
Static Public Attributes inherited from dialog.modelroot.ModelRoot | |
Controller = None | |
Display = None | |
DisplayModelFactory = None | |
Model = None | |
Root = None | |
Setup = False | |
Values = None | |
Context = None | |
CurrentlyEnabled = True | |
tuple | RuleRegistry = () |
Rules = None | |
WatchChild = None | |
Static Public Attributes inherited from dialog.item.Item | |
Context = None | |
CurrentlyEnabled = True | |
tuple | RuleRegistry = () |
Rules = None | |
WatchChild = None | |
Static Public Attributes inherited from dialog.widget.Widget | |
Enabled = True | |
Extras = None | |
tuple | RuleRegistry = ((<function <lambda>>, <function <lambda>>),) |
This is a special kind of dialog.
It's intended to help you build wizards in a standard and useful way.
The interface works just like tabs. Make a wizard dialog. Then make pages as the children of the wizard dialog. Wizards only allow pages as their children! And Pages only allow Wizards as their parents.
wzd = Wizard( ) p = Page( wzd, "first page", "you should do this, then this, then this" ) p.entry( "name1", 5 )
wzd.done()
If you don't add the 'finish' button then the 'next' button will act in its place when the wizard is on the last page.
Wizard
DialogBase
dialog.modelroot.ModelRoot
dialog.item.Item
dialog.widget.Widget
builtin.object
def dialog.dialog.Wizard.__init__ | ( | args | ) |
__init__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__delitem__ | ( | args | ) |
This function actually destroys the child and all of its children. All tk widgets will be destroyed. All items are removed from the tree and destroyed as soon as possible.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__dict__ | ( | args | ) |
dictionary for instance variables (if defined)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__empty_value__ | ( | args | ) |
__empty_value__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__get_children__ | ( | args | ) |
__get_children__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__get_controller__ | ( | args | ) |
__get_controller__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__get_dialog__ | ( | args | ) |
__get_dialog__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__get_display__ | ( | args | ) |
__get_display__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__get_model__ | ( | args | ) |
__get_model__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__get_root__ | ( | args | ) |
__get_root__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__get_widget__ | ( | args | ) |
__get_widget__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__getitem__ | ( | args | ) |
__getitem__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__getmemoize__ | ( | args | ) |
__getmemoize__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__getnopack__ | ( | args | ) |
__getnopack__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__getparent__ | ( | args | ) |
__getparent__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__getrules__ | ( | args | ) |
__getrules__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__getvalid__ | ( | args | ) |
__getvalid__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__new_field__ | ( | args | ) |
__new_field__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__pending__ | ( | args | ) |
__pending__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__set_controller__ | ( | args | ) |
__set_controller__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__set_model__ | ( | args | ) |
__set_model__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__set_widget__ | ( | args | ) |
__set_widget__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__setmemoize__ | ( | args | ) |
__setmemoize__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__setnopack__ | ( | args | ) |
__setnopack__(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.__weakref__ | ( | args | ) |
list of weak references to the object (if defined)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.add_after | ( | args | ) |
add_after(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.AddContext | ( | args | ) |
AddContext(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.AddIdle | ( | args | ) |
AddIdle(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.AddRule | ( | args | ) |
AddRule(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.AddStartup | ( | args | ) |
Startups are startup items. They're not things to be deferred, but startup startups. So they're run everytime done is called, and they're never removed from the list. The list must be complete the first time done is called, adding more startups later results in an error
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.AddStateFunction | ( | args | ) |
Append a function to the list of functions used to evaluate the current state (enabled/disabled) of this widget. Functions will be passed no arguments and should return True if this Item should be enabled. False if it should be disabled.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.AddTask | ( | args | ) |
Tasks are run at startup and then forgotten This is more efficient than adding something to the idle loop, and you know when it'll happen.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.after | ( | args | ) |
after(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.AssertNotDestroyed | ( | args | ) |
AssertNotDestroyed(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Back | ( | args | ) |
Back(args)
def dialog.dialog.Wizard.CancelIdle | ( | args | ) |
CancelIdle(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.child_added | ( | args | ) |
child_added(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.child_removed | ( | args | ) |
child_removed(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.children | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.controller | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.default_color | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.default_focus_window | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Destroy | ( | args | ) |
Call this function after you are finished using your Dialog if you've set Memoize to True. This will destroy the tk window and associated widgets, freeing up window handles for other things. If you have no set Memoize this will be called for you at the end of the done, or Run, call.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.dialog | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.DisableIf | ( | args | ) |
Disable this item if expression is True @param expression Must be a string representing a python expression which returns True or False. True indicating that you should disable the item for now. False indicating that you shouldn't. You may use, as variable names, any field name within the model. Example: dlg = Dialog() e = dlg.entry( 'name', 5 ) e2 = dlg.entry( 'other', 6 ) e2.DisableIf( 'other < 6 and name > 5', [e, e2] ) @param depends a list of dialog fields that should trigger this to be re-evaluated. Generally, any name you use in your expression should be represented by the field object (such as Entry) that corresponds to that name in the depends list. Failing to do so will cause this disabler to be re-evaluated less often than it should and it may not appear disabled/enabled at all of the appropriate times.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.display | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.done | ( | args | ) |
done(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.DoState | ( | args | ) |
DoState(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.EnableIf | ( | args | ) |
Same as DisableIf, except that the result is reversed.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.EvaluateValid | ( | args | ) |
EvaluateValid(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Find | ( | args | ) |
This recursively searches the tree, from here down for things which match query. @param query A function which returns True or False It is passed on argument, which is an Item @note Example use is find_type
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.find_type | ( | args | ) |
This recursively searches the tree, from here down, for a type t. Example, to find all Fields: item.find_type( Field )
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.foo | ( | args | ) |
Load = foo(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.foo | ( | args | ) |
Store = foo(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.foo | ( | args | ) |
__setup__ = foo(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Forward | ( | args | ) |
Forward(args)
def dialog.dialog.Wizard.get_read_only | ( | args | ) |
get_read_only(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.GetField | ( | args | ) |
This is intended as an internal function for the simulator
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.GetWidget | ( | args | ) |
Use this function to retrive tk widgets created by this object with the name 'name'. Use `list_widgets` to get a list of names for this object.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.grab | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Grid | ( | args | ) |
Grid(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.HasContext | ( | args | ) |
HasContext(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.hide | ( | args | ) |
hide(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.IsBuilding | ( | args | ) |
IsBuilding(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.IsEnabled | ( | args | ) |
IsEnabled(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.IsRunning | ( | args | ) |
IsRunning(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.item_valid | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.list_widgets | ( | args | ) |
For debugging, this function gives you a list of names to pass to GetWidget.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Memoize | ( | args | ) |
Set to True if you'd like to be able to call done, or Run, more than once on this Dialog.
If True, you must call Destroy to cleanup the dialog. Design Data recommends not using this in most cases. Setting this to True will cause your dialog to hold Window handles until Destroy is called. Each Windows system has a limited and small number of these available, and dialogs can use a deceptively large number of them.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.model | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.no_pack | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Open | ( | args | ) |
Open(args)
def dialog.dialog.Wizard.Pack | ( | args | ) |
The same as ".widget.pack( ... )" Prefer using this function as it's compatibility with the no_pack option avoids breaking others use of grid with your widget.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.PackForget | ( | args | ) |
The same as ".widget.pack_forget()" Prefer using this function as it's compatibility wi th the no_pack option avoids breaking others use of grid with your widget.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.PackInfo | ( | args | ) |
The same as ".widget.pack_info()" Prefer using this function as it's compatibility wi th the no_pack option avoids breaking others use of grid with your widget.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.PackSlaves | ( | args | ) |
The same as ".widget.pack_slaves()" Prefer using this function as it's compatibility wi th the no_pack option avoids breaking others use of grid with your widget.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Page | ( | args | ) |
Page(args)
def dialog.dialog.Wizard.parent | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Quit | ( | args | ) |
Cause the dialog to withdraw and done to return. This ends this run of the dialog, you will be able to run the dialog again, however.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.read_only | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.RememberWindowPosition | ( | args | ) |
Call this function once before you call done and your screen location will be remembered and recalled from one run of SDS/2 to another. guid should be a unique string. We recommend looking for a guid generator online and hard coding the result into your code. The purpose of this guid is to make your dialog unique from other dialogs. You could simply pick a rational name (like the title), however, someone else is likely to use this name for their own, different, dialog. In which case one screen may tend to get pushed partially off the users monitor.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.RemoveStateFunction | ( | args | ) |
Remove a function (by python reference) from the current list.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Reset | ( | args | ) |
Reset(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Revert | ( | args | ) |
Revert(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.root | ( | args | ) |
This actually searches up the tree for a model root because this can change as the dialog is being built.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.rules | ( | args | ) |
Returns a list of all of the current rule skeletons.
These will be tuples of types and arguments intended for constructing each type. Generally intended for internal use.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Run | ( | args | ) |
Run(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.run_pending | ( | args | ) |
run_pending(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Set | ( | args | ) |
this is intended as an internal function for fields to use
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.set_read_only | ( | args | ) |
set_read_only(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.SetButtons | ( | args | ) |
This allows you to set what buttons the dialog will give the user. Give it a list. The options are: 'okay' 'cancel' 'reset'
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.SetEnabled | ( | args | ) |
Used to enable/disable these widgets. This is for internal use.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.SetValid | ( | args | ) |
Call this to set invalid or valid this Item. It will keep count of valid=True and valid=False. So, if you call this 3 times with valid=False and 1 time with valid=True it will still be invalid. It is up to the caller to make sure they even those calls out. Consider your default state to be valid=True. Calling valid=True, then valid=False will yield valid. @param valid True or False "True" meaning that we are currently in a valid state. "False" meaning invalid. @warning This is intended for class implementors. There are Modified and Validate rules for dialog creators.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.SetWidget | ( | args | ) |
This is really an internal function, but, if you're careful not to use already existing names you can use it to store widgets you've added to this object to customize it. Beware that future changes to SDS/2 could use the same name you've chosen.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.show | ( | args | ) |
show(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.size_info | ( | args | ) |
size_info(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.Update | ( | args | ) |
Update(args)
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.valid | ( | args | ) |
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.WatchState | ( | args | ) |
Have this function called when this widget is enabled/disabled. @param foo This is a function which takes one argument, 'enabled'
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.widget | ( | args | ) |
The main Tkinter widget for this item.
Reimplemented from dialog.dialog.DialogBase.
def dialog.dialog.Wizard.WidgetExists | ( | args | ) |
This is useful if you're having problems with accessing widgets that have been deleted. It's for debugging purposes. @return True if the widget (.widget) does exist in the interpreter.
Reimplemented from dialog.dialog.DialogBase.
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |