Generated from ./../src/widgets.itcl with ROBODoc v4.0.18 on Mon Sep 20 17:39:12 2004

TABLE OF CONTENTS


::guib/widgets

FUNCTION

    The widgets module is used for managing the GUIB widgets. The GUIB
 widgets are mega-widgets built by using the [Incr Tk] and Iwidgets framework.
 
 We have the following GUIB mega-widget:
 
     ::guib::widgets::toplevel                 pathName ?option value?  ?...?
     ::guib::widgets::entrybutton              pathName ?option value?  ?...? 
     ::guib::widgets::entryfileselect          pathName ?option value?  ?...? 
     ::guib::widgets::entryfileselectquote     pathName ?option value?  ?...?
     ::guib::widgets::entrydirselect           pathName ?option value?  ?...? 
     ::guib::widgets::entrydirselectquote      pathName ?option value?  ?...? 
     ::guib::widgets::entryhelp                pathName ?option value?  ?...? 
     ::guib::widgets::entrybuttonhelp          pathName ?option value?  ?...? 
     ::guib::widgets::entryfileselecthelp      pathName ?option value?  ?...? 
     ::guib::widgets::entryfileselectquotehelp pathName ?option value?  ?...? 
     ::guib::widgets::entrydirselecthelp       pathName ?option value?  ?...? 
     ::guib::widgets::entrydirselectquotehelp  pathName ?option value?  ?...? 
     ::guib::widgets::comboboxhelp             pathName ?option value?  ?...? 
     ::guib::widgets::optionmenuhelp           pathName ?option value?  ?...? 
     ::guib::widgets::radioboxhelp             pathName ?option value?  ?...? 
     ::guib::widgets::texthelp                 pathName ?option value?  ?...?
     ::guib::widgets::displayhelp              varName helpFmt helpText

widgets/messageAspect

NAME

    ::guib::widgets::messageAspec -- configures message-widgets using a "reasonable" width vs. height aspect

USAGE

    messageAspect widget

RETURN VALUE

    None.

widgets/toplevel

NAME

    ::guib::widgets::toplevel -- toplevel widget

USAGE

    toplevel pathName ?option value?  ?...?

OPTIONS

    -title     -- title of toplevel
    -iconname  -- name of icon, i.e,  the window manager should display 
                  the name inside the icon associated with toplevel-window
    -geometry  -- geometry of toplevel in format of "wm geometry", i.e., 
                  widthxheight±x±y
    -transient -- make a transient toplevel (0|1)
    -class     -- class of the toplevel-window

RETURN VALUE

    Returns the path of a toplevel, i.e., pathName.

widgets/Toplevel

NAME

    ::guib::widgets::Toplevel -- a class for toplevel widget

PURPOSE

    This is a class for toplevel widget. Is is more convinient to use
 than generic Tk's toplevel widget, as it has additional options,
 such as "-title", "-geometry", ...

widgets/entrybutton

NAME

    ::guib::widgets::entrybutton -- entrybutton megawidget

USAGE

    entrybutton pathName ?option value?  ?...?

DESCRIPTION

    The entrybutton is a megawidget with label on the left, entry on
 the middle, and command button on the right.

OPTIONS

    Special OPTIONS
      -buttoncommand -- the command for the "button" widget 
      -validate      -- the validate command for the entry widget (choose
                        among supported validate_functions)

RETURN VALUE

    Returns the path of the entrybutton, i.e., pathName.

widgets/Entrybutton

NAME

    ::guib::widgets::Entrybutton -- a class for entrybutton megawidget

widgets/entryfileselect

NAME

    ::guib::widgets::entryfileselect -- entryfileselect megawidget

USAGE

    entryfileselect pathName ?option value?  ?...?

DESCRIPTION

    The entryfileselect is a megawidget with left aligned label,
 entry, and fileselect button. This megawidget is meant for
 specifying filenames.

OPTIONS

    Special OPTIONS
      -quote -- quote the selected filename (0|1); (example: 'myfile')

RETURN VALUE

    Returns the path of the entryfileselect, i.e., pathName.

widgets/entryfileselectquote

NAME

    ::guib::widgets::entryfileselectquote -- entryfileselectquote megawidget

USAGE

    entryfileselectquote pathName ?option value?  ?...?

DESCRIPTION

    The entryfileselectquote is a entryfileselect-type megawidget,
 but the selected filename will be quoted (i.e. -quote 1).

RETURN VALUE

    Returns the path of the entryfileselectquote, i.e., pathName.

widgets/Entryfileselect

NAME

    ::guib::widgets::Entryfileselect -- a class for entryfileselect megawidget

widgets/entrydirselect

NAME

    ::guib::widgets::entrydirselect -- entrydirselect megawidget

USAGE

    entrydirselect pathName ?option value?  ?...?

DESCRIPTION

    The entrydirselect is a megawidget with left aligned label,
 entry, and dirselect button. This megawidget is meant for specifying
 directory names.

OPTIONS

    Special OPTIONS
      -quote -- quote the selected dirname (0|1); (example: 'mydir')

RETURN VALUE

    Returns the path of the entrydirselect, i.e., pathName.

widgets/entrydirselectquote

NAME

    ::guib::widgets::entrydirselectquote -- entrydirselectquote megawidget

USAGE

    entrydirselectquote pathName ?option value?  ?...?

DESCRIPTION

    The entrydirselectquote is a entrydirselect-type megawidget,
 but the selected dirname will be quoted (i.e. -quote 1).

RETURN VALUE

    Returns the path of the entrydirselectquote, i.e., pathName.

widgets/Entrydirselect

NAME

    ::guib::widgets::Entrydirselect -- a class for entrydirselect megawidget

widgets/entryhelp

NAME

    ::guib::widgets::entryhelp -- entryhelp megawidget

USAGE

    entryhelp pathName ?option value?  ?...?

DESCRIPTION

    The entryhelp is a megawidget with left aligned label,
 entry, and help button.

OPTIONS

    Special OPTIONS
      -helpcommand -- command for the help button
      -helppadx    -- "padx" for the help button
      -helppady    -- "pady" for the help button
      -validate    -- the validate command for the entry widget (choose
                      among supported validate_functions)

RETURN VALUE

    Returns the path of the entryhelp, i.e., pathName.

widgets/Entryhelp

NAME

    ::guib::widgets::Entryhelp -- a class for entryhelp megawidget

widgets/entrybuttonhelp

NAME

    ::guib::widgets::entrybuttonhelp -- entrybuttonhelp megawidget

USAGE

    entrybuttonhelp pathName ?option value?  ?...?

DESCRIPTION

    entrybuttonhelp = entrybutton + help-button

OPTIONS

    Special OPTIONS
      -buttoncommand -- the command for the "button" widget 
      -helpcommand -- command for the help button
      -helppadx    -- "padx" for the help button
      -helppady    -- "pady" for the help button
      -validate    -- the validate command for the entry widget (choose
                      among supported validate_functions)

RETURN VALUE

    Returns the path of the entrybuttonhelp, i.e., pathName.

widgets/Entrybuttonhelp

NAME

    ::guib::widgets::Entrybuttonhelp -- a class for entrybuttonhelp megawidget

widgets/entryfileselecthelp

NAME

    ::guib::widgets::entryfileselecthelp -- entryfileselecthelp megawidget

USAGE

    entryfileselecthelp pathName ?option value?  ?...?

DESCRIPTION

    entryfileselecthelp = entryfileselect + help-button

OPTIONS

    Special OPTIONS
      -quote       -- quote the selected filename (0|1); (example: 'myfile')
      -helpcommand -- command for the help button
      -helppadx    -- "padx" for the help button
      -helppady    -- "pady" for the help button

RETURN VALUE

    Returns the path of the entryfileselecthelp, i.e., pathName.

widgets/entryfileselectquotehelp

NAME

    ::guib::widgets::entryfileselectquotehelp -- entryfileselectquotehelp megawidget

USAGE

    entryfileselectquotehelp pathName ?option value?  ?...?

DESCRIPTION

    The entryfileselectquotehelp is a entryfileselecthelp-type megawidget,
 but the selected filename will be quotehelpd (i.e. -quote 1).

RETURN VALUE

    Returns the path of the entryfileselectquotehelp, i.e., pathName.

widgets/Entryfileselecthelp

NAME

    ::guib::widgets::Entryfileselecthelp -- a class for entryfileselecthelp megawidget

widgets/entrydirselecthelp

NAME

    ::guib::widgets::entrydirselecthelp -- entrydirselecthelp megawidget

USAGE

    entrydirselecthelp pathName ?option value?  ?...?

DESCRIPTION

    entrydirselecthelp = entrydirselect + help-button

OPTIONS

    Special OPTIONS
      -quote       -- quote the selected dirname (0|1); (example: 'mydir')
      -helpcommand -- command for the help button
      -helppadx    -- "padx" for the help button
      -helppady    -- "pady" for the help button

RETURN VALUE

    Returns the path of the entrydirselecthelp, i.e., pathName.

widgets/entrydirselectquotehelp

NAME

    ::guib::widgets::entrydirselectquotehelp -- entrydirselectquotehelp megawidget

USAGE

    entrydirselectquotehelp pathName ?option value?  ?...?

DESCRIPTION

    The entrydirselectquotehelp is a entrydirselecthelp-type megawidget,
 but the selected dirname will be quotehelpd (i.e. -quote 1).

RETURN VALUE

    Returns the path of the entrydirselectquotehelp, i.e., pathName.

widgets/Entrydirselecthelp

NAME

    ::guib::widgets::Entrydirselecthelp -- a class for entrydirselecthelp megawidget

widgets/comboboxhelp

NAME

    ::guib::widgets::comboboxhelp -- comboboxhelp megawidget

USAGE

    comboboxhelp pathName ?option value?  ?...?

DESCRIPTION

    comboboxhelp = combobox + help-button

OPTIONS

    Special OPTIONS
      -helpcommand -- command for the help button
      -helppadx    -- "padx" for the help button
      -helppady    -- "pady" for the help button

METHODS

    Widget METHODS
      (see [Incr Tcl]'s Combobox documentation)

RETURN VALUE

    Returns the path of the comboboxhelp, i.e., pathName.

widgets/Comboboxhelp

NAME

    ::guib::widgets::Comboboxhelp -- a class for comboboxhelp megawidget

widgets/texthelp

NAME

    ::guib::widgets::texthelp -- texthelp megawidget

USAGE

    texthelp pathName ?option value?  ?...?

DESCRIPTION

    The texthelp is a megawidget with left aligned label,
 text, and help button.

OPTIONS

    Special OPTIONS
      -helpcommand -- command for the help button
      -helppadx    -- "padx" for the help button
      -helppady    -- "pady" for the help button

RETURN VALUE

    Returns the path of the texthelp, i.e., pathName.

widgets/Texthelp

NAME

    ::guib::widgets::Texthelp -- a class for texthelp megawidget