TABLE OF CONTENTS

keywordObj

NAME

::guib::keywordObj -- a base class for the GUIB

DESCRIPTION

This is a base class for the GUIB. All the GUIB objects (i.e. moduleObj, nameObj, and voidObj) inherit it.

The GUIB script is a Tcl script which is encapsulated inside the "module" keyword and contains GUIB keywords (plus all Tcl stuff). These keywords are methods of moduleObj class (expect "module" which is a proc). Some of this keywords create new objects (page, namelist, optional, required, line, group) and then the script belonging to such a keyword is executed within that object scope (i.e. this is how the nesting of the object-keywords is managed). The keywords belonging to a given keywordObj's object are sequentially labeled with an ID. Here an example of how the hierarchy of keywordObj is handled. Consider the following script:

module \#auto -title "Testing" -script { 

     page p1 -name "Page No.1" {
       line l1st -name "1st line" {
           var title -label "Title:"
           var code  -label "Code:"
       }
       line l2nd -name "2nd line" {
           var description -label "Description:"
       }
     }
     line llast -name "last line" {
       var conclusion -label "Conclusion:"
     }

}

The corresponding hierarchy tree is the following:

moduleObj[module] | +--(ID=0)--keywordObj[page] (p1) | | | +--ID=0--keywordObj[line] (l1st) | | | | | +--ID=0--item[var] (title) | | +--ID=1--item[var] (code) | | | +--ID=1--keywordObj[line] (l2nd) | | | +--ID=0--item[var] (description) | +--(ID=1)--keywordObj[line] (llast) 

               |
               +--ID=0--item[var] (conclusion)

METHODS

getID -- keywords within a keywordObj object are sequentially 

                      labeled (1st item's ID==0), this method returns the 
                      current value of the counter, which equals to the 
                      number of items within a given keywordObj object

incrID -- increases the current counter value and returns its 

                      new value

setKey -- stores the current keyword setChild -- stores the name of the newly created keywordObj object setOptions -- merges a default and parsed option values of a keyword 

                      and stores them

getKey -- returns the keyword which has the requested ID getChild -- returns the child keywordObj object which has the requested ID getOptions -- returns all the options of the ID-th keyword 

                      (i.e. result has the form of [arrey get arrayName])

getOptionValue -- return the ID-th option value getIdFromVarname -- returns the ID of the keyword which contains the 

                         requested variable (i.e. -variable option)

getIdFromVarident -- returns the ID of the keyword which contains the 

                         requested variable's identifier (i.e. -variable option)

getOutFmt -- returns the output-format getInFmt -- returns the input-format