Subversion Repositories or1k

'\"

'\" Copyright (c) 1995 DSC Technologies Corporation

'\"

'\" See the file "license.terms" for information on usage and redistribution

'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.

'\"

'\" @(#) optionmenu.n 1.21 94/12/17 16:04:44

'/"

.so man.macros

.HS optionmenu iwid

.BS

'\" Note:  do not modify the .SH NAME line immediately below!

.SH NAME

optionmenu \- Create and manipulate a option menu widget

.SH SYNOPSIS

\fBoptionmenu\fI \fIpathName \fR?\fIoptions\fR?

.SH "INHERITANCE"

itk::Widget <- Labeledwidget <- optionmenu

.SH "STANDARD OPTIONS"

.LP

.nf

.ta 4c 8c 12c

\fBactiveBackground\fR  \fBactiveBorderWidth\fR \fBactiveForeground\fR  \fBbackground\fR

\fBborderWidth\fR       \fBcursor\fR    \fBdisabledForeground\fR        \fBfont\fR

\fBforeground\fR        \fBhighlightColor\fR    \fBhighlightThickness\fR        \fBrelief\fR

.fi

.LP

See the "options" manual entry for details on the standard options.

.SH "INHERITED OPTIONS"

.LP

.nf

.ta 4c 8c 12c

\fBdisabledForeground\fR        \fBlabelBitmap\fR       \fBlabelFont\fR \fBlabelImage\fR

\fBlabelMargin\fR       \fBlabelPos\fR  \fBlabelText\fR \fBlabelVariable\fR

\fBstate\fR

.fi

.LP

See the "LabeledWidget" manual entry for details on the inherited options.

.SH "WIDGET-SPECIFIC OPTIONS"

.LP

.nf

Name:   \fBclickTime\fR

Class:  \fBClickTime\fR

Command-Line Switch:    \fB-clicktime\fR

.fi

.IP

Interval time, in msec, used to determine that a single mouse

click has occurred. Used to post menu on a "quick" mouse click.

\fBNote\fR: changing this value may cause the sigle-click

functionality to not work properly.  The default is 150 msec.

.LP

.nf

Name:   \fBcommand\fR

Class:  \fBCommand\fR

Command-Line Switch:    \fB-command\fR

.fi

.IP

Specifies a Tcl command procedure to be evaluated following a  change in

the current option menu selection.

.LP

.nf

Name:   \fBcyclicOn\fR

Class:  \fBCyclicOn\fR

Command-Line Switch:    \fB-cyclicon\fR

.fi

.IP

Turns on/off the 3rd mouse button capability. The value may be specified

in any of the forms acceptable to \fBTcl_GetBoolean\fR.  This feature

allows the right mouse button to cycle through the popup

menu list without poping it up. The right mouse button cycles through

the menu in reverse order.  The default is true.

.LP

.nf

Name:   \fBpopupCursor\fR

Class:  \fBCursor\fR

Command-Line Switch:    \fB-popupcursor\fR

.fi

.IP

Specifies  the mouse cursor to be used for the popup menu.  The value may

have any of the  forms  acceptable to \fBTk_GetCursor\fR.

.LP

.nf

Name:   \fBstate\fR

Class:  \fBState\fR

Command-Line Switch:    \fB-state\fR

.fi

.IP

Specified one of two states for the optionmenu: \fBnormal\fR, or

\fBdisabled\fR.  If the optionmenu is disabled, then option menu

selection is ignored.

.LP

.nf

Name:   \fBwidth\fR

Class:  \fBWidth\fR

Command-Line Switch:    \fB-width\fR

.fi

.IP

Specifies a fixed size for the menu button label in any of the forms

acceptable to \Tk_GetPixels\fR.  If the text

is too small to fit in the label, the text is clipped.

Note: Normally, when a new list is created, or new items are

added to an existing list, the menu button label is resized

automatically.  Setting this option overrides that functionality.

.LP

.BE

.SH DESCRIPTION

.PP

The \fBoptionmenu\fR command creates an option menu widget with options

to manage it.  An option menu displays a frame containing a label and a button.

A pop-up menu will allow for the value of the button to change.

.SH "METHODS"

.PP

The \fBoptionmenu\fR command creates a new Tcl command whose

name is \fIpathName\fR.  This

command may be used to invoke various

operations on the widget.  It has the following general form:

.DS

\fIpathName option \fR?\fIarg arg ...\fR?

.DE

\fIOption\fR and the \fIarg\fRs

determine the exact behavior of the command.

.PP

Many of the widget commands for an optionmenu take as one argument an

indicator of which entry of the option menu to operate on.  These

indicators are called \fIindex\fRes and may be specified in

any of the following forms:

.TP 12

\fInumber\fR

Specifies the entry numerically, where 0 corresponds

to the top-most entry of the option menu, 1 to the entry below it, and

so on.

.TP 12

\fBend\fR

Indicates the bottommost entry in the menu.  If there are no

entries in the menu then zero is returned.

.TP 12

\fBselect\fR

Returns the numerical index of the currently selected option menu entry.

If no entries exist in the menu, then -1 is returned.

.TP 12

\fIpattern\fR

If the index doesn't satisfy one of the above forms then this

form is used.  \fIPattern\fR is pattern-matched against the label of

each entry in the option menu, in order from the top down, until a

matching entry is found.  The rules of \fBTcl_StringMatch\fR

are used.

.PP

The following widget commands are possible for optionmenu widgets:

.SH "WIDGET-SPECIFIC METHODS"

.TP

\fIpathName \fBcget\fR \fIoption\fR

Returns the current value of the configuration option given

by \fIoption\fR.

\fIOption\fR may have any of the values accepted by the \fBoptionmenu\fR

command.

.TP

\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?

Query or modify the configuration options of the widget.

If no \fIoption\fR is specified, returns a list describing all of

the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for

information on the format of this list).  If \fIoption\fR is specified

with no \fIvalue\fR, 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 \fIoption\fR is specified).  If

one or more \fIoption\-value\fR 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.

\fIOption\fR may have any of the values accepted by the \fBoptionmenu\fR

command.

.TP

\fIpathName \fBdelete \fIfirst\fR ?\fIlast\fR?

Delete all of the option menu entries between \fIfirst\fR and

\fIlast\fR inclusive.  If \fIlast\fR is omitted then it defaults

to \fIfirst\fR.

.TP

\fIpathName \fBdisable \fIindex\fR

Disable the option menu entry specified by \fIindex\fR.

Disabling a menu item will prevent the user from being able to select

this item from the menu.  This only effects the state of the item

in the menu, in other words, should the item be the currently

selected item, the programmer is responsible for determining this condition

and taking appropriate action.

.TP

\fIpathName \fBenable \fIindex\fR

Enable the option menu entry specified by \fIindex\fR.

Enabling a menu item allows the user to select this item from the menu.

.TP

\fIpathName \fBget\fR ?\fIfirst\fR? ?\fIlast\fR?

If no arguments are specified, this operation returns the currently

selected option menu item.  Otherwise, it returns the name of the

option at index \fIfirst\fR, or a range of options between \fIfirst\fR

and \fIlast\fR.

.TP

\fIpathName \fBindex \fIindex\fR

Returns the numerical index corresponding to \fIindex\fR.

.TP

\fIpathName \fBinsert \fIindex string\fR ?\fIstring\fR?

Insert an item, or list of items, into the menu at location \fIindex\fR.

.TP

\fIpathName \fBselect \fIindex\fR

Select an item from the option menu to be displayed as the currently

selected item.

.TP

\fIpathName \fBsort \fImode\fR

Sort the current menu in either \fBascending\fR, or \fBdescending\fR order.

The values \fBincreasing\fR, or \fBdecreasing\fR are also accepted.

.SH "COMPONENTS"

.LP

.nf

Name:   \fBmenuBtn\fR

Class:  \fBMenubutton\fR

.fi

.IP

The menuBtn component is the option menu button which displays the current

choice from the popup menu.  See the "menubutton" widget manual entry

for details on the menuBtn component item.

.LP

.nf

Name:   \fBpopupMenu\fR

Class:  \fBMenu\fR

.fi

.IP

The popupMenu component is menu displayed upon selection of the menu button.

The menu contains the choices for the option menu.  See the "menu" widget

manual entry for details on the popupMenu component item.

.fi

.SH EXAMPLE

.DS

 optionmenu .om -labelmargin 5 \\

     -labelon true -labelpos w -labeltext "Operating System :"

 .om insert end Unix VMS Linux OS/2 {Windows NT} DOS

 .om sort ascending

 .om select Linux

 pack .om  -padx 10 -pady 10

.DE

.SH ACKNOWLEDGEMENTS:

Michael J. McLennan

.IP

Borrowed some ideas (next & previous) from OptionButton class.

.LP

Steven B. Jaggers

.IP

Provided an initial prototype in [incr Tcl].

.LP

Bret Schuhmacher

.IP

Helped with popup menu functionality.

.LP

.SH AUTHOR

Alfredo Jahn

.SH KEYWORDS

optionmenu, widget