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

A frame that fills top to bottom and is intended to be placed like columns on a page. More...

Inheritance diagram for dialog.frame.Column:
dialog.frame.Frame dialog.modelroot.ModelRoot dialog.widget.Widget dialog.builder.Builder dialog.item.Item

Methods defined here:

def __init__

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 EvaluateValid
def Find
def HasContext
def IsEnabled
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 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 default_color
def widget
 The main Tkinter widget for this item.

Data and other attributes inherited from dialog.widget.Widget:

 Enabled = True
 Extras = None

Methods inherited from dialog.builder.Builder:

def __initialize_lbl_width__
def __recalculate_lbl_width__
def button
def check
def checkbutton
def column
def column_group_begin
def column_group_end
def dim
def entry
def file
def file_save
def frame
def get_label_width
def group
def group_end
def group_title
def group_end
def image
def label
def lframe
def line
def listbox
def menu
def mtrl_browse
def radio
def scrollbar
def set_label_width
def tab
def table
def table_column
def table_end
def tabset_begin
def tabset_end
def text

Data descriptors inherited from dialog.builder.Builder:

def label_width

Data and other attributes inherited from dialog.builder.Builder:

list CurrentContainer = []
 InitializedLabelWidth = False
int Label_width = 0
 SB_Clear = False

Additional Inherited Members

- Public Member Functions inherited from dialog.frame.Frame
- Public Member Functions inherited from dialog.modelroot.ModelRoot
- Public Member Functions inherited from dialog.item.Item
- Public Member Functions inherited from dialog.widget.Widget
- Public Member Functions inherited from dialog.builder.Builder
- Static Public Attributes inherited from dialog.frame.Frame
 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
list CurrentContainer = []
 InitializedLabelWidth = False
int Label_width = 0
 SB_Clear = False
- 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>>),)
- Static Public Attributes inherited from dialog.builder.Builder
list CurrentContainer = []
 InitializedLabelWidth = False
int Label_width = 0
 SB_Clear = False

Detailed Description

A frame that fills top to bottom and is intended to be placed like columns on a page.

This will align your labeled fields directly under it as well.

Method resolution order

Column
Frame
dialog.modelroot.ModelRoot
dialog.item.Item
dialog.widget.Widget
dialog.builder.Builder
builtin.object

Constructor & Destructor Documentation

def dialog.frame.Column.__init__ (   args)
 __init__(args)

Reimplemented from dialog.frame.Frame.

Member Function Documentation

def dialog.frame.Column.__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.frame.Frame.

def dialog.frame.Column.__dict__ (   args)

dictionary for instance variables (if defined)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__empty_value__ (   args)
 __empty_value__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__get_children__ (   args)
 __get_children__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__get_controller__ (   args)
 __get_controller__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__get_dialog__ (   args)
 __get_dialog__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__get_display__ (   args)
 __get_display__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__get_model__ (   args)
 __get_model__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__get_root__ (   args)
 __get_root__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__get_widget__ (   args)
 __get_widget__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__getitem__ (   args)
 __getitem__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__getnopack__ (   args)
 __getnopack__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__getparent__ (   args)
 __getparent__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__getrules__ (   args)
 __getrules__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__getvalid__ (   args)
 __getvalid__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__initialize_lbl_width__ (   args)
 __initialize_lbl_width__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__pending__ (   args)
 __pending__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__recalculate_lbl_width__ (   args)
 __recalculate_lbl_width__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__set_controller__ (   args)
 __set_controller__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__set_model__ (   args)
 __set_model__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__set_widget__ (   args)
 __set_widget__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__setnopack__ (   args)
 __setnopack__(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.__weakref__ (   args)

list of weak references to the object (if defined)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.AddContext (   args)
 AddContext(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.AddRule (   args)
 AddRule(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.check (   args)
 check(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.child_added (   args)
 child_added(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.child_removed (   args)
 child_removed(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.children (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.column (   args)
 column(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.column_group_begin (   args)
 column_group_begin(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.column_group_end (   args)
 column_group_end(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.controller (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.default_color (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.Destroy (   args)
 Destroy(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.dialog (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.display (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.DoState (   args)
 DoState(args)

Reimplemented from dialog.frame.Frame.

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

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.file (   args)
 file(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.file_save (   args)
 file_save(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.foo (   args)
 Load = foo(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.foo (   args)
 Store = foo(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.foo (   args)
 __setup__ = foo(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.frame (   args)
 frame(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.get_label_width (   args)
 get_label_width(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.GetField (   args)
 This is intended as an internal function for the simulator

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.Grid (   args)
 Grid(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.group (   args)
 group(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.group_end (   args)
 group_end(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.group_end (   args)
 group_title_end = group_end(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.group_title (   args)
 group_title(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.HasContext (   args)
 HasContext(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

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

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.item_valid (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.label (   args)
 label(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.label_width (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.lframe (   args)
 lframe(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.line (   args)
 line(args)

Reimplemented from dialog.frame.Frame.

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

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.listbox (   args)
 listbox(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.model (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.mtrl_browse (   args)
 mtrl_browse(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.no_pack (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.parent (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

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

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.Revert (   args)
 Revert(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.run_pending (   args)
 run_pending(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.scrollbar (   args)
 scrollbar(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.Set (   args)
 this is intended as an internal function for fields to use

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.set_label_width (   args)
 set_label_width(args)

Reimplemented from dialog.frame.Frame.

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

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.size_info (   args)
 size_info(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.tab (   args)
 tab(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.table (   args)
 table(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.table_column (   args)
 table_column(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.table_end (   args)
 table_end(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.tabset_begin (   args)
 tabset_begin(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.tabset_end (   args)
 tabset_end(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.text (   args)
 text(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.Update (   args)
 Update(args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.valid (   args)

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

def dialog.frame.Column.widget (   args)

The main Tkinter widget for this item.

Reimplemented from dialog.frame.Frame.

def dialog.frame.Column.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.frame.Frame.

Member Data Documentation

dialog.frame.Column.__Load__ = None
staticprivate
dialog.frame.Column.__Store__ = None
staticprivate
dialog.frame.Column.Context = None
static
dialog.frame.Column.Controller = None
static
list dialog.frame.Column.CurrentContainer = []
static
dialog.frame.Column.CurrentlyEnabled = True
static
dialog.frame.Column.Display = None
static
dialog.frame.Column.DisplayModelFactory = None
static
dialog.frame.Column.Enabled = True
static
dialog.frame.Column.Extras = None
static
dialog.frame.Column.InitializedLabelWidth = False
static
int dialog.frame.Column.Label_width = 0
static
dialog.frame.Column.Model = None
static
dialog.frame.Column.Root = None
static
tuple dialog.frame.Column.RuleRegistry = ()
static
dialog.frame.Column.Rules = None
static
dialog.frame.Column.SB_Clear = False
static
dialog.frame.Column.Setup = False
static
dialog.frame.Column.Values = None
static
dialog.frame.Column.WatchChild = None
static