File 'gui/ui.tcl' (part of 'Pool_GuiBase')


Home | Packages | Files | Procedures | Classes | Keywords | External packages


Written by
Andreas Kupries
Description
Helper procedures for manipulation of user interfaces.
Depends on
Tcl
Keywords
User interface manipulation, interface manipulation, manipulation of user interfaces, window hierarchy traversal, scan windows, traverse window hierarchy, window traversal, synchronous scrolling, separator bars, not-yet-implemented dialog, under construction, incompletion hints

::pool::ui::MsConvertDirection (dir)

Converts the specified direction into the subcommand to use for scrolling (either xscrollcommand or yscrollcommand).
Argument: dirThe scroll direction, possible values are 'x', 'y', 'horizontal', 'vertical' and all unique prefixes.
Returns: The unique prefix of the scrollcommand to give to the scrollbar widget, i.e. 'x' or 'y'.

::pool::ui::MsHandleScrollbar (widgets dir args)

Scrollbar callback. Just propagates the given scroll data (in args) to the associated widgets.
Argument: widgetsList of synchronized widgets.
Argument: dirScroll direction.
Argument: argsScroll information, as given by tk.

::pool::ui::MsHandleWidget (scrollbar widgets dir first last)

Callback for listboxes bound to scrollbar. Updates the scrollbar and all widgets connected to it.
Notes: This code doesn't care to exclude the invoking widget from the update. It assumes that the invoker detects and aborts the possible looping.
Argument: scrollbarScrollbar widget connected to all widgets.
Argument: widgetsList of widgets synchronized by scrollbar.
Argument: dirScroll direction.
Argument: firstStandard scroll parameter, as given by Tk.
Argument: lastStandard scroll parameter, as given by Tk.

::pool::ui::appendBindTag (w tag)

Add the tag to the binding tags of w. The new tag is added behind the end of the current tag-list.
Argument: wThe widget to add the tag to.
Argument: tagThe name of the tag to add to widget w.

::pool::ui::bool2state (booleanValue)

Converts a boolean value as accepted by 'expr', 'if', etc. into a state value as accepted by most widgets (option -state). True is equivalent to 'normal', false means 'disabled'.
Argument: booleanValueThe value to convert.
Returns: is one of 'normal' and 'disabled'.

::pool::ui::center (w)

Centers the widget w on the screen.
Notes: Does not work for the main window ('.').
Argument: wThe path of the window to center on the screen.

::pool::ui::centerMain (w h)

Centers the main window on the screen. Uses information from `wm geometry` to calculate the positioning.
Argument: wRequested width of the main window.
Argument: hRequested height of the main window.

::pool::ui::gridSeparator (w args)

Generates a horizontal/vertical separator bar named w. The separator is actually a frame, but forced into a thin line by the 'grid' geometry manager.
Argument: wName of the separator window.
Argument: argsList of <option,value>-pairs. Accepts '-orientation', '-in', '-row', '-column', '-span' and all unique prefixes.

::pool::ui::mapWindow (w args)

Executes the partial command stored in args for window w and all its children.
Argument: wtop of window hierarchy to traverse
Argument: argspartial command to execute

::pool::ui::multiScroll (scrollbar dir args)

Essentially the same as ::pool::ui::multiScrollList. The difference: The widgets to scroll as unit are specified by a variable number of arguments, instead of a list.
Argument: scrollbarScrollbar to manipulate all widgets in args.
Argument: dirScroll direction
Argument: argsList of widgets to synchronize via scrollbar.

::pool::ui::multiScrollList (scrollbar dir widgets)

Binds the scrollbar to all specified widgets to let them scroll together.
Argument: scrollbarScrollbar to manipulate all widgets
Argument: dirScroll direction.
Argument: widgetsList of widgets to synchronize via scrollbar.

::pool::ui::nyi (args)

Shows a modal dialog warning the user about entering a missing part of the application.
Argument: argsAdditional to text to display in the dialog.

::pool::ui::orientation (o v)

Type checker procedure. Accepts only the keys of 'scrollcmd' as directional values.
Argument: oThe name of the option to check.
Argument: vThe value to check
Returns: A boolean value. True signal acceptance of v.

::pool::ui::packSeparator (w args)

Generates a horizontal/vertical separator bar named w. The separator is actually a frame, but forced into a thin line by the 'pack' geometry manager.
Argument: wname of the separator window.
Argument: argsList of <option,value>-pairs. Accepts '-orientation', '-in' and all unique prefixes.

::pool::ui::prependBindTag (w tag)

Add the tag to the binding tags of w. The new tag is added at the front of the current tag-list.
Argument: wThe widget to add the tag to.
Argument: tagThe name of the tag to add to widget w.

::pool::ui::relief (o v)

Type checker procedure. Accepts only the standard relief codes.
Argument: oThe name of the option to check.
Argument: vThe value to check
Returns: A boolean value. True signal acceptance of v.

::pool::ui::ymOrder (o v)

Type checker procedure. Accepts the order codes used by monthBrowserTixB.
Argument: oThe name of the option to check.
Argument: vThe value to check
Returns: A boolean value. True signal acceptance of v.

::pool::ui::ymdOrder (o v)

Type checker procedure. Accepts the order codes used by calendarTix.
Argument: oThe name of the option to check.
Argument: vThe value to check
Returns: A boolean value. True signal acceptance of v.


Generated by AutoDoc 2.1 at 02/20/1999, invoked by Andreas Kupries