TABLE OF CONTENTS

• 1. ::guib/simpleTplwGUI
• 2. ::guib/embedGUI
• 3. ::guib/menuOpen
• 4. moduleObj/makeSimpleTplwGUI
• 5. ::guib/GUI

::guib/simpleTplwGUI

NAME

    ::guib::simpleTplwGUI -- loads a module-definition file and constructs simple stand-alone GUI

USAGE

    simpleTplwGUI moduleFile

DESCRIPTION

    Makes a complete stand-alone Simple-GUI in its own toplevel-window 
    with a menubar. It works as follows:
    
       1. loads a module-definition file (a moduleObj is created)
       2. create a simple toplevel- GUI by calling the moduleObj's
          makeSimpleTplwGUI method

RETURN VALUE

    Returns the name of moduleObj object.

EXAMPLE

    simpleTplwGUI examples/my_gui.tcl

::guib/embedGUI

NAME

    ::guib::embedGUI --  makes a GUI into the $containerWidget

USAGE

    embedGUI moduleFile containerWidget

DESCRIPTION

    Makes a non stand-alone GUI in $containerWidget
    It works as follows:
    
       1. reads a module-definition file (a moduleObj is created)
       2. create an embedded GUI by calling the moduleObj's
          makeEmbedGUI method

RETURN VALUE

    Returns the name of moduleObj object.

EXAMPLE

    embedGUI examples/my_gui.tcl $containerWidget

::guib/menuOpen

NAME

    ::guib::menuOpen -- function used by "Open" file-menu

USAGE

    menuOpen moduleFile

DESCRIPTION

    This proc is used by the "Open" file-menu of makeSimpleTplwGUI
 method to open input files. The proc first queries for the input
 filename and then opens it.

RETURN VALUE

    Returns the name of moduleObj object or an empty string if WRONG_FORMAT.

EXAMPLE

    menuOpen examples/my_gui.tcl

moduleObj/makeSimpleTplwGUI

NAME

    ::guib::moduleObj::makeSimpleTplwGUI -- method used by ::guib::simpleTplwGUI proc (actually constructs the GUI)

USAGE

    makeSimpleTplwGUI

DESCRIPTION

    This method is used by ::guib::simpleTplwGUI proc and actually
 constructs the GUI, that is, it creates a main-window with File menu and
 GUI based on the moduleFile definition.

RETURN VALUE

    None.

EXAMPLE

    $obj makeSimpleTplwGUI

::guib/GUI

NAME

    ::guib::GUI -- a class for constructing a complex GUI for the real applications

USAGE

    ::guib::GUI $objname \
               -title   "title that appears in the mainwondow" \
               -appname "short name of application"
 
    $objname addModule module ident modulename moduleFile fileTypes
    $objname addHelp   help   helpName helpEntrymenuText helpFile
 
    Where the fileTypes if of form: 
 
      set fileTypes {  
         {{X input file} {*.x.inp}  }  
         {{description}  {extension}}  
         {{...}          {...}
      }

DESCRIPTION

    This class is used by real applications to construct the GUI's
 main window with menu, toolbar, etc...

METHODS

   1. Public methods
      activate  -- 
      addModule -- 
      addHelp   -- 
      newGUI    -- 
      component -- 
      extra     -- 
 
   2. Protected/Private methods
      2.1 Menu methods
         _newInput    -- 
         _openInput   -- 
         _save        -- 
         _saveAs      -- 
         _closeTab    -- 
         _closeWindow -- 
         _help        --
 
      2.2 Toolbar methods    
         _toolbarNew      -- 
         _toolbarOpen     -- 
         __toolbarNewOpen -- 
         _toolbarCmd      -- 
 
      2.3 Other methods (state of the menus, tabs ...)
         _toplevelTitle      --
         _mainwindowState    --
         _selectedTab        --
         __createNotebook    --
         __setCurrentTabName --