SDS2 Parametric API
 All Classes Namespaces Functions Variables Pages
List of all members
dialog.choose_file.ChooseFile Class Reference

A field which allows a user to pick a file in the filesystem. More...

Inheritance diagram for dialog.choose_file.ChooseFile:
dialog.choose_file.Choose dialog.entry.Entry dialog.labeledfield.Labeled dialog.widget.Widget dialog.item.Item

Methods defined here:

def RunDialog
def __init__

Methods inherited from dialog.entry.Entry:

def func
def AddRule
def func
def func
def func
def func
def func
def func
def func
def func
def __get_entry__
def func
def func

Data descriptors inherited from dialog.entry.Entry:

def affected
def entry
def kind
def mixed
def name
def read_only
def screen_only
def show_affects
def valid
def width

Methods inherited from dialog.labeledfield.Labeled:

def __get_label__
def __set_label__

Data descriptors inherited from dialog.labeledfield.Labeled:

def label
def label_widget

Methods inherited from dialog.widget.Widget:

def Destroy
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 __dict__
 dictionary for instance variables (if defined)
def __weakref__
 list of weak references to the object (if defined)
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
tuple RuleRegistry = ((<function <lambda>>, <function <lambda>>),)

Methods inherited from dialog.item.Item:

def AddContext
def AddStateFunction
def DisableIf
def EnableIf
def EvaluateValid
def Find
def HasContext
def IsEnabled
def RemoveStateFunction
def SetValid
def Update
def __delitem__
def __get_children__
def __get_dialog__
def __get_root__
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 children
def dialog
def item_valid
def no_pack
def parent
def root
 This actually searches up the tree for a model root because this can change as the dialog is being built.
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
 Rules = None
 WatchChild = None
 __Load__ = None
 __Store__ = None

Additional Inherited Members

- Public Member Functions inherited from dialog.choose_file.Choose
def foo
- Public Member Functions inherited from dialog.entry.Entry
- Public Member Functions inherited from dialog.labeledfield.Labeled
- Public Member Functions inherited from dialog.widget.Widget
- Public Member Functions inherited from dialog.item.Item
- Static Public Attributes inherited from dialog.choose_file.Choose
 Enabled = True
 Extras = None
tuple RuleRegistry = ((<function <lambda>>, <function <lambda>>),)
 Context = None
 CurrentlyEnabled = True
 Rules = None
 WatchChild = None
- Static Public Attributes inherited from dialog.entry.Entry
 Enabled = True
 Extras = None
tuple RuleRegistry = ((<function <lambda>>, <function <lambda>>),)
 Context = None
 CurrentlyEnabled = True
 Rules = None
 WatchChild = None
- Static Public Attributes inherited from dialog.labeledfield.Labeled
 Enabled = True
 Extras = None
tuple RuleRegistry = ((<function <lambda>>, <function <lambda>>),)
 Context = None
 CurrentlyEnabled = True
 Rules = None
 WatchChild = None
- Static Public Attributes inherited from dialog.widget.Widget
 Enabled = True
 Extras = None
tuple RuleRegistry = ((<function <lambda>>, <function <lambda>>),)
- Static Public Attributes inherited from dialog.item.Item
 Context = None
 CurrentlyEnabled = True
tuple RuleRegistry = ()
 Rules = None
 WatchChild = None

Detailed Description

A field which allows a user to pick a file in the filesystem.

Method resolution order

ChooseFile
Choose
dialog.entry.Entry
dialog.labeledfield.Labeled
dialog.widget.Widget
dialog.item.Item
builtin.object

Constructor & Destructor Documentation

def dialog.choose_file.ChooseFile.__init__ (   args)
 @param label The label text to put next to the entry
 @param save True if you want this to be a save mode, False for open mode.
 @param default The starting path if no model is provided.

Reimplemented from dialog.choose_file.Choose.

Member Function Documentation

def dialog.choose_file.ChooseFile.__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.choose_file.Choose.

def dialog.choose_file.ChooseFile.__dict__ (   args)

dictionary for instance variables (if defined)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__get_children__ (   args)
 __get_children__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__get_dialog__ (   args)
 __get_dialog__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__get_entry__ (   args)
 __get_entry__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__get_label__ (   args)
 __get_label__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__get_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.choose_file.Choose.

def dialog.choose_file.ChooseFile.__get_widget__ (   args)
 __get_widget__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__getnopack__ (   args)
 __getnopack__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__getparent__ (   args)
 __getparent__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__getrules__ (   args)
 __getrules__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__getvalid__ (   args)
 __getvalid__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__pending__ (   args)
 __pending__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__set_label__ (   args)
 __set_label__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__set_widget__ (   args)
 __set_widget__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__setnopack__ (   args)
 __setnopack__(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.__weakref__ (   args)

list of weak references to the object (if defined)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.AddContext (   args)
 AddContext(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.AddRule (   args)
 AddRule(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.affected (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.child_added (   args)
 child_added(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.child_removed (   args)
 child_removed(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.children (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.default_color (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.Destroy (   args)
 Destroy(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.dialog (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.DoState (   args)
 DoState(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.EnableIf (   args)
 Same as DisableIf, except that the result is reversed.

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.entry (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.EvaluateValid (   args)
 override this to do something when your widget becomes invalid
 by proxy via an item under it which is invalid

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 AddAffect = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 DisableOtherIf = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 EnableOtherIf = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 Get = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 OnChange = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 PopupValidate = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 Set = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 Validate = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 ValidateRange = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 nudge = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.func (   args)
 read = func(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.Grid (   args)
 Grid(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.HasContext (   args)
 HasContext(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.IsEnabled (   args)
 @return True if this Item is currently enabled.

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.item_valid (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.kind (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.label (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.label_widget (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.list_widgets (   args)
 For debugging, this function gives you a list
 of names to pass to GetWidget.

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.mixed (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.name (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.no_pack (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.parent (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.read_only (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.RemoveStateFunction (   args)
 Remove a function (by python reference) from the current list.

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.RunDialog (   args)
 RunDialog(args)
def dialog.choose_file.ChooseFile.screen_only (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.SetEnabled (   args)
 Used to enable/disable these widgets.  This is for internal use.

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.show_affects (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.Update (   args)
 Update(args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.valid (   args)

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.widget (   args)

The main Tkinter widget for this item.

Reimplemented from dialog.choose_file.Choose.

def dialog.choose_file.ChooseFile.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.choose_file.Choose.

def dialog.choose_file.ChooseFile.width (   args)

Reimplemented from dialog.choose_file.Choose.

Member Data Documentation

dialog.choose_file.ChooseFile.__Load__ = None
staticprivate
dialog.choose_file.ChooseFile.__Store__ = None
staticprivate
dialog.choose_file.ChooseFile.Context = None
static
dialog.choose_file.ChooseFile.CurrentlyEnabled = True
static
dialog.choose_file.ChooseFile.Enabled = True
static
dialog.choose_file.ChooseFile.Extras = None
static
tuple dialog.choose_file.ChooseFile.RuleRegistry = ((<function <lambda>>, <function <lambda>>),)
static
dialog.choose_file.ChooseFile.Rules = None
static
dialog.choose_file.ChooseFile.WatchChild = None
static