Package nMOLDYN :: Package GUI :: Module Widgets |
[hide private]
[frames] | no frames]

# Module Widgets

source code

    This module implements all classes used for the generation of combo widgets.

    A combo widget can be defined as a label frame encapsulating several other Tkinter widgets.

    Classes:
        * ValidatingEntry   : sets up a Tkinter Entry widget that checks its contents whenever it is changed.
        * IntegerEntry      : sets up a Tkinter Entry widget that checks that the input is an integer.
        * FloatEntry        : sets up a Tkinter Entry widget that checks that the input is a float.
        * StringEntry       : sets up a Tkinter Entry widget that checks that the input is a string matching a given pattern.
        * ComboLabelEntry   : sets up a combo widget made of a Tkinter Label widget embedded in a Tkinter LabelFrame widget.
        * ComboIntegerEntry : sets up a combo widget made of a Tkinter Label widget and IntegerEntry combo widget embedded
          in a Tkinter LabelFrame widget.
        * ComboFloatEntry   : sets up a combo widget made of a Tkinter Label widget and FloatEntry embedded in a Tkinter
          LabelFrame widget.
        * ComboStringEntry  : sets up a combo widget made of a Tkinter Label widget and StringEntry embedded in a Tkinter
          LabelFrame widget.
        * ComboRadiobutton  : sets up a combo widget made of a Tkinter Label widget and a set of Tkinter RadioButton widgets
          embedded in a Tkinter LabelFrame widget.
        * ComboCheckbutton  : sets up a combo widget made of a Tkinter Label widget and a Tkinter CheckButton widget embedded
          in a Tkinter LabelFrame widget.
        * ComboOptionMenu   : sets up a combo widget made of a Tkinter Label widget and a Tkinter OptionMenu widget embedded
          in a Tkinter LabelFrame widget.
        * ComboSpinbox      : sets up a combo widget made of a Tkinter Label widget and a Tkinter Spinbox widget embedded in
          a Tkinter LabelFrame widget.
        * ComboScale        : sets up a combo widget made of a Tkinter Label widget and a Tkinter Scale widget embedded in
          a Tkinter LabelFrame widget.
        * ComboButton       : sets up a combo widget made of a Tkinter Button widget and optionnally a Tkinter Entry widget embedded
          in a Tkinter LabelFrame widget.
        * ComboFileBrowser  : sets up a combo widget made of a Tkinter Label widget, a StringEntry widget and a Tkinter Button
          widget for file browsing embedded in a Tkinter LabelFrame widget.
        * ComboText         : sets up a combo widget made of a Tkinter Text and a vertical Tkinter Scrollbar widget widget embedded in a
          Tkinter LabelFrame widget.
        * ComboListbox      : sets up a combo widget made of a Tkinter Listbox widget and a vertical Tkinter Scrollbar widget embedded
          in a Tkinter LabelFrame widget.
        * StatusBar         : sets up a combo widget made of a Tkinter Scale widget embedded in a Tkinter Frame
          widget.

    The following classes were adapted from the implementation of Frederic Lundh:
        - ValidatingEntry
        - IntegerEntry
        - FloatEntry

Classes | [hide private]
| ValidatingEntry Base class for |IntegerEntry|, |FloatEntry| and |StringEntry| widgets
| IntegerEntry Sets up a Tkinter Entry widget that accepts only integer values.
| FloatEntry Sets up a Tkinter Entry widget that accepts only float values.
| StringEntry Sets up a Tkinter Entry widget that accepts only string values.
| ComboFrame Sets up a Tkinter LabelFrame widget.
| ComboLabel Sets up a combo widget made of a Tkinter Label widget embedded in a Tkinter LabelFrame widget.
| ComboIntegerEntry Sets up a combo widget made of a Tkinter Label widget and a IntegerEntry widget embedded in a Tkinter LabelFrame widget.
| ComboFloatEntry Sets up a combo widget made of a Tkinter Label widget and a FloatEntry widget embedded in a Tkinter LabelFrame widget.
| ComboStringEntry Sets up a combo widget made of a Tkinter Label widget and a StringEntry widget embedded in a Tkinter LabelFrame widget.
| ComboRadiobutton Sets up a combo widget made of a Tkinter Label widget and a set of Tkinter RadioButton widgets embedded in a Tkinter LabelFrame widget.
| ComboCheckbutton Sets up a combo widget made of a Tkinter Label widget and a set of Tkinter Checkbutton widget embedded in a Tkinter LabelFrame widget.
| ComboOptionMenu Sets up a combo widget made of a Tkinter Label widget and a Tkinter OptionMenu widget embedded in a Tkinter LabelFrame widget.
| ComboSpinbox Sets up a combo widget made of a Tkinter Label widget and a Tkinter Spinbox widget embedded in a Tkinter LabelFrame widget.
| ComboScale Sets up a combo widget made of a Tkinter Label widget and a Tkinter Scale widget embedded in a Tkinter LabelFrame widget.
| ComboButton Sets up a combo widget made of a Tkinter Button widget and optionnally a Tkinter Entry widget embedded in a Tkinter LabelFrame widget.
| ComboFileBrowser Sets up a combo widget made of a Tkinter Label widget, a StringEntry widget and a Tkinter Button widget for file browsing embedded in a Tkinter LabelFrame widget.
| ComboText Sets up a combo widget made of a Tkinter Text widget and a vertical Tkinter Scrollbar widget embedded in a Tkinter LabelFrame widget.
| ComboListbox Sets up a combo widget made of a Tkinter Listbox widget and a vertical Tkinter Scrollbar widget embedded in a Tkinter LabelFrame widget.
| StatusBar Sets up a combo widget made of a Tkinter Scale widget embedded in a Tkinter Frame widget.

Functions | [hide private]
changeMouseCursor(event, cursor) Changes the mouse cursor aspect. | source code
loadHelpTree() This method will load the XML file that stores the pdf and html links for the help file and store its contents into the _helptree nMOLDYN global variables.. | source code
informationAboutWidget(event) Checks the label of the Tkinter LabelFrame of a combo widget and displays the corresponding informations documented in nMOLDYN users guide. | source code

Variables | [hide private]
| nmoldyn_package_path = `os.path.dirname(os.path.split(__file__)`...``
| nmoldyn_xml_tree = `{}`

Function Details | [hide private]

### changeMouseCursor(event, cursor) | source code
Changes the mouse cursor aspect. Parameters: `event` (a Tkinter.Event object) - the event triggering the change of mouse cursor. `cursor` (string) - the Tkinter name of the mouse cursor.

### informationAboutWidget(event) | source code
Checks the label of the Tkinter LabelFrame of a combo widget and displays the corresponding informations documented in nMOLDYN users guide. Parameters: `event` (a Tkinter.Event object) - the event triggering the request for information about the combo widget.

Variables Details | [hide private]

  ### nmoldyn_package_path Value:
      os.path.dirname(os.path.split(__file__) [0])