Manual Pages for UNIX Darwin command on man iwidgets

Manual Pages for UNIX Darwin command on man iwidgets_toolbar

iwidgets::toolbar(1) [incr Widgets] iwidgets::toolbar(1)

NAME

iiwwiiddggeettss::::ttoooollbbaarr - Create and manipulate a tool bar

SYNOPSIS

iiwwiiddggeettss::::ttoooollbbaarr pathName ?options? IINNHHEERRIITTAANNCCEE

itk::Widget <- iwidgets::Toolbar

SSTTAANNDDAARRDD OOPPTTIIOONNSS aaccttiivveeBBaacckkggrroouunndd aaccttiivveeFFoorreeggrroouunndd bbaacckkggrroouunndd bboorrddeerrWWiiddtthh ccuurrssoorr ddiissaabblleeddFFoorreeggrroouunndd ffoonntt ffoorreeggrroouunndd hhiigghhlliigghhttBBaacckkggrroouunndd hhiigghhlliigghhttCCoolloorr hhiigghhlliigghhttTThhiicckknneessss iinnsseerrttBBaacckkggrroouunndd iinnsseerrttFFoorreeggrroouunndd oorriieenntt sseelleeccttBBaacckkggrroouunndd sseelleeccttBBoorrddeerrWWiiddtthh sseelleeccttFFoorreeggrroouunndd ssttaattee ttrroouugghhCCoolloorr See the "options" manual entry for details on the standard options. For widgets added to the toolbar, these options will be propogated if the widget supports the option. For example, all widgets that support a

font option will be changed if the the toolbar's font option is config-

ured.

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS

Name: bbaalllloooonnBBaacckkggrroouunndd Class: BBaalllloooonnBBaacckkggrroouunndd

Command-Line Switch: -bbaalllloooooonnbbaacckkggrroouunndd

Specifies the background color of the balloon help displayed at the bottom center of a widget on the toolbar that has a non empty string for its balloonStr option. The default color is yellow. Name: bbaalllloooonnDDeellaayy11 Class: BBaalllloooonnDDeellaayy11

Command-Line Switch: -bbaalllloooonnddeellaayy11

Specifies the length of time (in milliseconds) to wait before initially posting a balloon help hint window. This delay is in effect whenever 1) the mouse leaves the toolbar, or 2) a toolbar item is selected with the mouse button. Name: bbaalllloooonnDDeellaayy22 Class: BBaalllloooonnDDeellaayy22

Command-Line Switch: -bbaalllloooonnddeellaayy22

Specifies the length of time (in milliseconds) to wait before continuing to post balloon help hint windows. This delay is in effect after the first time a balloon hint window is activated. It remains in effect until 1) the mouse leaves the toolbar, or 2) a toolbar item is selected with the mouse button. Name: bbaalllloooonnFFoonntt Class: BBaalllloooonnFFoonntt

Command-Line Switch: -bbaalllloooonnffoonntt

Specifies the font of the balloon help text displayed at the bottom center of a widget on the toolbar that has a non empty string for its balloonStr option. The default font is 6x10. Name: bbaalllloooonnFFoorreeggrroouunndd Class: BBaalllloooonnFFoorreeggrroouunndd

Command-Line Switch: -bbaalllloooooonnffoorreeggrroouunndd

Specifies the foreground color of the balloon help displayed at the bottom center of a widget on the toolbar that has a non empty string for its balloonStr option. The default color is black. Name: hheellppVVaarriiaabbllee Class: HHeellppVVaarriiaabbllee

Command-Line Switch: -hheellppvvaarriiaabbllee

Specifies the global variable to update whenever the mouse is in motion over a toolbar widget. This global variable is updated with the current value of the active widget's helpStr. Other widgets can "watch" this variable with the trace command, or as is the case with entry or label widgets, they can set their

textVariable to the same global variable. This allows for a sim-

ple implementation of a help status bar. Whenever the mouse leaves a menu entry, the helpVariable is set to the empty string {}. Name: oorriieenntt Class: OOrriieenntt

Command-Line Switch: -oorriieenntt

Specifies the orientation of the toolbar. Must be either hori-

zontal or vertical.

DESCRIPTION

The iiwwiiddggeettss::::ttoooollbbaarr command creates a new window (given by the path-

Name argument) and makes it into a ttoooollbbaarr widget. Additional options, described above may be specified on the command line or in the option database to configure aspects of the toolbar such as its colors, font, and orientation. The iiwwiiddggeettss::::ttoooollbbaarr command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist. A ttoooollbbaarr is a widget that displays a collection of widgets arranged

either in a row or a column (depending on the value of the -orient

option). This collection of widgets is usually for user convenience to give access to a set of commands or settings. Any widget may be placed

on a toolbar. However, command or value-oriented widgets (such as but-

ton, radiobutton, etc.) are usually the most useful kind of widgets to appear on a toolbar. In addition, the toolbar adds two new options to all widgets that are

added to it. These are the hheellppSSttrr and bbaalllloooonnSSttrr options. See the dis-

cussion for the widget command add below.

WWIIDDGGEETT-SSPPEECCIIFFIICC MMEETTHHOODDSS

The iwidgets::toolbar command creates a new Tcl command whose name is pathName. This command may be used to invoke various operations on the widget. It has the following general form: pathName option ?arg arg ...? Option and args determine the exact behavior of the command.

Many of the widget commands for a toolbar take as one argument an indi-

cator of which widget item of the toolbar to operate on. The indicator is called an iinnddeexx and may be specified in any of the following forms: number Specifies the widget numerically, where 0 corresponds to the first widget in the notebook, 1 to the second, and so on. (For horizontal, 0 is the leftmost; for vertical, 0 is the topmost). eenndd Specifes the last widget in the toolbar's index. If the toolbar

is empty this will return -1.

llaasstt Same as end. pattern If the index doesn't satisfy any of the above forms, then this

form is used. Pattern is pattern-matched against the widgetName

of each widget in the toolbar, in order from the first to the last widget, until a matching entry is found. An exact match must occur. The following commands are possible for toolbar widgets: pathName aadddd widgetCommand widgetName ?option value?

Adds a widget with the command widgetCommand whose name is wid-

getName to the toolbar. If widgetCommand is radiobutton or

checkbutton, its packing is slightly padded to match the geome-

try of button widgets. In addition, the indicatorOn option is false by default and the selectColor is that of the toolbar background by default. This allows Radiobutton and Checkbutton widgets to be added as icons by simply setting their bitmap or image options. If additional arguments are present, they are the set of available options that the widget type of widgetCommand supports. In addition they may also be one of the following options:

-hheellppssttrr value

Specifes the help string to associate with the widget. When the mouse moves over the widget, the variable denoted by hheellppVVaarriiaabbllee is set to hheellppSSttrr. Another widget can bind to the helpVariable and thus track status help.

-bbaalllloooonnssttrr value

Specifes the string to display in a balloon window for this widget. A balloon window is a small popup window

centered at the bottom of the widget. Usually the bbaall-

lloooonnSSttrr value is the name of the item on the toolbar. It is sometimes known as a hint window. When the mouse moves into an item on the toolbar, a timer is set based on the value of bbaalllloooonnDDeellaayy11. If the mouse

stays inside the item for bbaalllloooonnDDeellaayy11, the balloon win-

dow will pop up displaying the bbaalllloooonnSSttrr value. Once the

balloon window is posted, a new timer based on bbaalllloooonnDDee-

llaayy22 is set. This is typically a shorter timer. If the mouse is moved to another item, the window is unposted and a new window will be posted over the item if the shorter delay time is satisfied. While the balloon window is posted, it can also be unposted if the item is selected. In this case the timer is reset to bbaalllloooonnDDeellaayy11. Whenever the mouse leaves the toolbar, the timer is also reset to bbaalllloooonnDDeellaayy11. This window posting/unposting model is the same model used in the Windows95 environment. pathName ccggeett option Returns the current value of the configuration option given by option. pathName ccoonnffiigguurree ?option value? Query or modify the configuration options of the widget. If no

option is specified, returns a list describing all of the avail-

able options for pathName (see TkConfigureInfo for information on the format of this list). If option is specified with no value, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified). If one or more

option-value pairs are specified, then the command modifies the

given widget option(s) to have the given value(s); in this case the command returns an empty string. pathName ddeelleettee index ?index2?

This command deletes all items between index and index2 inclu-

sive. If index2 is omitted then it defaults to index. Returns an empty string. pathName iinnddeexx index Returns the widget's numerical index for the entry corresponding

to index. If index is not found, -1 is returned.

pathName iinnsseerrtt beforeIndex widgetCommand widgetName ?option value? Insert a new item named widgetName with the command widgetCommand before the item specified by beforeIndex. If widgetCommand is rraaddiioobbuuttttoonn or cchheecckkbbuuttttoonn, its packing is slightly padded to match the geometry of button widgets. In addition, the iinnddiiccaattoorrOOnn option is ffaallssee by default and the sseelleeccttCCoolloorr is that of the toolbar background by default. This allows RRaaddiioobbuuttttoonn and CChheecckkbbuuttttoonn widgets to be added as icons by simply setting their bbiittmmaapp or iimmaaggee options. The set of available options is the same as specified in the aadd command. pathName iitteemmccggeett index option Returns the current value of the configuration option given by option for index. The item type of index determines the valid available options. pathName iitteemmccoonnffiigguurree index ?option value? Query or modify the configuration options of the widget of the toolbar specified by index. If no option is specified, returns a list describing all of the available options for index (see TTkkCCoonnffiigguurreeIInnffoo for information on the format of this list). If option is specified with no value, then the command returns a

list describing the one named option (this list will be identi-

cal to the corresponding sublist of the value returned if no

option is specified). If one or more option-value pairs are

specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an

empty string. The item type of index determines the valid avail-

able options. The set of available options is the same as speci-

fied in the aadd command. EEXXAAMMPPLLEE package require Iwidgets 4.0

iwidgets::toolbar .tb -helpvariable statusVar

.tb add button item1 \

-helpstr "Save It" -bitmap @./icons/Tool32box.xbm \

-balloonstr "Save" -command {puts 1}

.tb add button item2 \

-helpstr "Save It" -bitmap @./icons/Tool32brush.xbm \

-balloonstr "Save" -command {puts 1}

.tb add button item3 \

-helpstr "Save It" -bitmap @./icons/Tool32cut.xbm \

-balloonstr "Save" -command {puts 1}

.tb add button item4 \

-helpstr "Save It" -bitmap @./icons/Tool32draw.xbm \

-balloonstr "Save" -command {puts 1}

.tb add button item5 \

-bitmap @./icons/Tool32erase.xbm -helpstr "Play It" \

-command {puts 2}

.tb add frame filler \

-borderwidth 1 -width 10 -height 10

.tb add radiobutton item6 \

-bitmap @./icons/Tool32oval.xbm -command {puts 4} \

-variable result -value OPEN -helpstr "Radio Button # 1" \

-balloonstr "Radio"

.tb add radiobutton item7 \

-bitmap @./icons/Tool32line.xbm -command {puts 5} \

-variable result -value CLOSED

.tb add checkbutton item8 \

-bitmap @./icons/Tool32text.xbm -command {puts 6} \

-variable checkit -onvalue yes -offvalue no

.tb add checkbutton check2 \

-bitmap @./icons/Tool32points.xbm -command {puts 7} \

-variable checkit2 -onvalue yes -offvalue no

pack .tb -side top -anchor nw

AUTHOR Bill Scott KKEEYYWWOORRDDSS toolbar, button, radiobutton, checkbutton, iwidgets, widget Tk iwidgets::toolbar(1)