Data descriptors inherited from dialog.dialog.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 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.widget.Widget: |
| | Enabled = True |
| | Extras = None |
Data descriptors inherited from dialog.builder.Builder: |
| def | label_width |
Detailed Description
Constructor & Destructor Documentation
| def dialog.pmdialog.PMDialog.__init__ |
( |
|
args | ) |
|
Member Function Documentation
| def dialog.pmdialog.PMDialog.__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.pmdialog.PMDialog.__dict__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__empty_value__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__get_children__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__get_controller__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__get_dialog__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__get_display__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__get_model__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__get_root__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__get_widget__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__getitem__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__getmemoize__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__getnopack__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__getparent__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__getrules__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__getvalid__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__initialize_lbl_width__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__new_field__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__pending__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__recalculate_lbl_width__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__set_controller__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__set_model__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__set_widget__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__setmemoize__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__setnopack__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.__weakref__ |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.add_after |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.AddContext |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.AddIdle |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.AddRule |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.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.pmdialog.PMDialog.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.pmdialog.PMDialog.after |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.AssertNotDestroyed |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.button |
( |
|
args | ) |
|
Creates a button widget
@param label The text on the button
@param command A callable object taking no arguments which will be
called when the button is clicked/activated
@return the button.Button object
Reimplemented from dialog.builder.Builder.
| def dialog.pmdialog.PMDialog.CancelIdle |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.check |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.checkbutton |
( |
|
args | ) |
|
This method is deprecated
It exists for compatibility with older code.
You should look into the "check" method. It
creates checkbuttons one at a time.
Reimplemented from dialog.builder.Builder.
| def dialog.pmdialog.PMDialog.child_added |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.child_removed |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.children |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.column |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.column_group_begin |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.column_group_end |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.controller |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.default_color |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.default_focus_window |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.dialog |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.dim |
( |
|
args | ) |
|
Create a dimension field which is a label to the left of an entry
widget and displays dimensions as strings and floats.
@param name The name of this field
@param initial_value This is the default value to start with
if a model is not provided to the dialog.
@param label a string to display in a label to the left of
the entry box
@param width
@param length
@param style The style of the dimension. @see dimension.DimensionStyled
Reimplemented from dialog.builder.Builder.
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.display |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.done |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.DoState |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.EnableIf |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.entry |
( |
|
args | ) |
|
@param name The name of this field
@param initial_value This is the default value to start with
if a model is not provided to the dialog.
@param label a string to display in a label to the left of
the entry box
@param width
@param length
@param kind If you do not provide an initial_value then you
must provide this. @see kind module documentation
@return the entry.Entry object
Reimplemented from dialog.builder.Builder.
| def dialog.pmdialog.PMDialog.EvaluateValid |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.file |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.file_save |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.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.pmdialog.PMDialog.foo |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.foo |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.foo |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.frame |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.get_label_width |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.get_read_only |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.GetField |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.grab |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.Grid |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.group |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.group_end |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.group_end |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.group_title |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.HasContext |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.hide |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.image |
( |
|
args | ) |
|
Add an image object.
@param path should be the path to an existing image in the filesystem.
@return the image.Image object
Reimplemented from dialog.builder.Builder.
| def dialog.pmdialog.PMDialog.IsBuilding |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.IsEnabled |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.IsRunning |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.item_valid |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.label |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.label_width |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.lframe |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.line |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.list_widgets |
( |
|
args | ) |
|
For debugging, this function gives you a list
of names to pass to GetWidget.
Reimplemented from dialog.dialog.DialogBase.
| def dialog.pmdialog.PMDialog.listbox |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.menu |
( |
|
args | ) |
|
Creates a combobox widget
@param name The name of this field
@param values The list of items in the checkbox, these will
be displayed to the user.
@param initial_value This should be a list of strings or indexes to
be checked on corresponding to the values list.
@param label a string to display in a label to the left of
the entry box
@param editable If this is True the menu will allow the user to type
in strings that do not match any strings in your list.
@return the combobox.Combobox object
Reimplemented from dialog.builder.Builder.
| def dialog.pmdialog.PMDialog.model |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.mtrl_browse |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.no_pack |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.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.pmdialog.PMDialog.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.pmdialog.PMDialog.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.pmdialog.PMDialog.parent |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.preview_update |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.radio |
( |
|
args | ) |
|
Creates a set of radio buttons.
@param name The name of this field
@param values The list of items in the radio button, these will
be displayed to the user.
@param initial_value This should be a list of strings or indexes to
be checked on corresponding to the values list.
@param label a string to display in a label to the left of
the entry box
@return the radio.Radio object
Reimplemented from dialog.builder.Builder.
| def dialog.pmdialog.PMDialog.read_only |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.RemoveStateFunction |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.Reset |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.Revert |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.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.pmdialog.PMDialog.Run |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.run_pending |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.scrollbar |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.Set |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.set_label_width |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.set_read_only |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.SetEnabled |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.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.pmdialog.PMDialog.show |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.size_info |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.tab |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.table |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.table_column |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.table_end |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.tabset_begin |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.tabset_end |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.text |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.Update |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.valid |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.pmdialog.PMDialog.widget |
( |
|
args | ) |
|
| def dialog.pmdialog.PMDialog.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.
Member Data Documentation
| dialog.pmdialog.PMDialog.__Cancel__ = None |
|
staticprivate |
| dialog.pmdialog.PMDialog.__Load__ = None |
|
staticprivate |
| dialog.pmdialog.PMDialog.__Okay__ = None |
|
staticprivate |
| dialog.pmdialog.PMDialog.__Reset__ = None |
|
staticprivate |
| dialog.pmdialog.PMDialog.__Store__ = None |
|
staticprivate |
| dialog.pmdialog.PMDialog.Building = True |
|
static |
| dialog.pmdialog.PMDialog.ButtonDown = False |
|
static |
| dialog.pmdialog.PMDialog.Buttons = None |
|
static |
| dictionary dialog.pmdialog.PMDialog.Buttons_dict = {} |
|
static |
| dialog.pmdialog.PMDialog.Context = None |
|
static |
| dialog.pmdialog.PMDialog.Controller = None |
|
static |
| list dialog.pmdialog.PMDialog.CurrentContainer = [] |
|
static |
| dialog.pmdialog.PMDialog.CurrentlyEnabled = True |
|
static |
| dialog.pmdialog.PMDialog.DefaultFocusWindow = None |
|
static |
| dialog.pmdialog.PMDialog.Display = None |
|
static |
| dialog.pmdialog.PMDialog.DisplayModelFactory = None |
|
static |
| dialog.pmdialog.PMDialog.Enabled = True |
|
static |
| dialog.pmdialog.PMDialog.exit_status = False |
|
static |
| dialog.pmdialog.PMDialog.Extras = None |
|
static |
| dialog.pmdialog.PMDialog.InitializedLabelWidth = False |
|
static |
| int dialog.pmdialog.PMDialog.Label_width = 0 |
|
static |
| dialog.pmdialog.PMDialog.Model = None |
|
static |
| dialog.pmdialog.PMDialog.Root = None |
|
static |
| tuple dialog.pmdialog.PMDialog.RuleRegistry = () |
|
static |
| dialog.pmdialog.PMDialog.Rules = None |
|
static |
| dialog.pmdialog.PMDialog.Running = False |
|
static |
| dialog.pmdialog.PMDialog.SB_Clear = False |
|
static |
| dialog.pmdialog.PMDialog.Setup = False |
|
static |
| dialog.pmdialog.PMDialog.Startups = None |
|
static |
| dialog.pmdialog.PMDialog.StartupsStop = False |
|
static |
| list dialog.pmdialog.PMDialog.Tasks = [] |
|
static |
| dialog.pmdialog.PMDialog.tk = None |
|
static |
| dialog.pmdialog.PMDialog.UsedButtons = None |
|
static |
| dialog.pmdialog.PMDialog.Values = None |
|
static |
| dialog.pmdialog.PMDialog.WaitingToShow = False |
|
static |
| dialog.pmdialog.PMDialog.WatchChild = None |
|
static |
| dialog.pmdialog.PMDialog.window = None |
|
static |
Public Member Functions inherited from dialog.dialog.DialogBase
1.8.1.2