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.

'\"

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

'/"

.so man.macros

.HS buttonbox iwid

.BS

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

.SH NAME

buttonbox \- Create and manipulate a manager widget for buttons

.SH SYNOPSIS

\fBbuttonbox\fI \fIpathName \fR?\fIoptions\fR?

.SH "INHERITANCE"

itk::Widget <- buttonbox

.SH "STANDARD OPTIONS"

.LP

.nf

.ta 4c 8c 12c

\fBbackground\fR        \fBcursor\fR

.fi

.LP

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

.SH "WIDGET-SPECIFIC OPTIONS"

.ta 4c 8c 12c

.LP

.nf

Name:   \fBorient\fR

Class:  \fBOrient\fR

Command-Line Switch:    \fB-orient\fR

.fi

.IP

Orientation of the button box: \fBhorizontal\fR or \fBvertical\fR.  The default

is horizontal.

.LP

.nf

Name:   \fBpadX\fR

Class:  \fBPadX\fR

Command-Line Switch:    \fB-padx\fR

.fi

.IP

Specifies a non-negative padding distance to leave between the button group and

the outer edge of the button box in the x direction.  The value may be

given in any of the forms acceptable to \fBTk_GetPixels\fR.  The default

is 5 pixels.

.LP

.nf

Name:   \fBpadY\fR

Class:  \fBPadY\fR

Command-Line Switch:    \fB-pady\fR

.fi

.IP

Specifies a non-negative padding distance to leave between the button group and

the outer edge of the button box in the y direction.  The value may be given

in any of the forms acceptable to \fBTk_GetPixels\fR.  The default is 5 pixels.

.LP

.BE

.SH DESCRIPTION

.PP

The \fBbuttonbox\fR command creates a manager widget for controlling

buttons.  The button box also supports the display and invocation

of a default button.  The button box can be configured either horizontally

or vertically.

.SH "METHODS"

.PP

The \fBbuttonbox\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 C

\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 the buttonbox take as one argument an

indicator of which button of the button box to operate on.  These

indicators are called \fIindexes\fR and allow reference and manipulation

of buttons regardless of their current map state.  buttonbox indexes

may be specified in any of the following forms:

.TP 12

\fInumber\fR

Specifies the button numerically, where 0 corresponds to the

left/top-most button of the button box.

.TP 12

\fBend\fR

Indicates the right/bottom-most button of the button box.

.TP 12

\fBdefault\fR

Indicates the current default button of the button box.  This is the

button with the default ring displayed.

.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 tag of

each button in the button box, in order from left/top to right/left,

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

are used.

.SH "WIDGET-SPECIFIC METHODS"

.TP

\fIpathName \fBadd\fR \fItag\fR \fIargs\fR

Add a button distinguished by \fItag\fR to the end of the button box.

If additional arguments are present they specify options to be applied

to the button.  See \fBPushButton\fR for information on the options

available.

.TP

\fIpathName \fBbuttonconfigure\fR \fIindex\fR ?\fIoptions\fR?

This command is similar to the \fBconfigure\fR command, except that

it applies to the options for an individual button,

whereas \fBconfigure\fR applies to the options for the button box as a whole.

\fIOptions\fR may have any of the values accepted by the \fBPushButton\fR

command.  If \fIoptions\fR are specified, options are modified

as indicated in the command and the command returns an empty string.

If no \fIoptions\fR are specified, returns a list describing

the current options for entry \fIindex\fR (see \fBTk_ConfigureInfo\fR for

information on the format of this list).

.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 \fBbuttonbox\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 \fBbuttonbox\fR

command.

.TP

\fIpathName \fBdefault\fR \fIindex\fR

Sets the default button to the button given by \fIindex\fR.  This causes

the default ring to appear arround the specified button.

.TP

\fIpathName \fBdelete\fR \fIindex\fR

Deletes the button given by \fIindex\fR from the button box.

.TP

\fIpathName \fBhide\fR \fIindex\fR

Hides the button denoted by \fIindex\fR.  This doesn't remove the button

permanently, just inhibits its display.

.TP

\fIpathName \fBindex \fIindex\fR

Returns the numerical index corresponding to \fIindex\fR.

.TP

\fIpathName \fBinsert \fIindex\fR \fItag\fR ?\fIoption value option value ...\fR?

Same as the \fBadd\fR command except that it inserts the new

button just before the one given by \fIindex\fR, instead of appending

to the end of the button box.  The \fIoption\fR, and \fIvalue\fR

arguments have the same interpretation as for the \fBadd\fR widget

command.

.TP

\fIpathName \fBinvoke\fR \fI?index?\fR

Invoke the command associated with a button.  If no arguments

are given then the current default button is invoked, otherwise the argument

is expected to be a button \fIindex\fR.

.TP

\fIpathName \fBshow\fR \fIindex\fR

Display a previously hidden button denoted by \fIindex\fR.

.SH EXAMPLE

.DS

 buttonbox .bb

 .bb add Yes -text Yes -command "puts Yes"

 .bb add No -text No -command "puts No"

 .bb add Maybe -text Maybe -command "puts Maybe"

 .bb default Yes

 pack .bb -expand yes -fill both

.DE

.SH AUTHOR

Bret A. Schuhmacher

.DE

Mark L. Ulferts

.SH KEYWORDS

buttonbox, pushbutton, button, widget