Blame doc/man/man3/XmVaCreateSimpleRadioBox.3

Packit b099d7
'\" t
Packit b099d7
...\" VaCreF.sgm /main/9 1996/09/08 21:21:40 rws $
Packit b099d7
.de P!
Packit b099d7
.fl
Packit b099d7
\!!1 setgray
Packit b099d7
.fl
Packit b099d7
\\&.\"
Packit b099d7
.fl
Packit b099d7
\!!0 setgray
Packit b099d7
.fl			\" force out current output buffer
Packit b099d7
\!!save /psv exch def currentpoint translate 0 0 moveto
Packit b099d7
\!!/showpage{}def
Packit b099d7
.fl			\" prolog
Packit b099d7
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
Packit b099d7
\!!psv restore
Packit b099d7
.
Packit b099d7
.de pF
Packit b099d7
.ie     ?\\*(f1?? .ds f1 \\n(.f
Packit b099d7
.el .ie ?\\*(f2?? .ds f2 \\n(.f
Packit b099d7
.el .ie ?\\*(f3?? .ds f3 \\n(.f
Packit b099d7
.el .ie ?\\*(f4?? .ds f4 \\n(.f
Packit b099d7
.el .tm ? font overflow
Packit b099d7
.ft \\$1
Packit b099d7
..
Packit b099d7
.de fP
Packit b099d7
.ie     !?\\*(f4?? \{\
Packit b099d7
.	ft \\*(f4
Packit b099d7
.	ds f4\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f3?? \{\
Packit b099d7
.	ft \\*(f3
Packit b099d7
.	ds f3\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f2?? \{\
Packit b099d7
.	ft \\*(f2
Packit b099d7
.	ds f2\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f1?? \{\
Packit b099d7
.	ft \\*(f1
Packit b099d7
.	ds f1\"
Packit b099d7
'	br \}
Packit b099d7
.el .tm ? font underflow
Packit b099d7
..
Packit b099d7
.ds f1\"
Packit b099d7
.ds f2\"
Packit b099d7
.ds f3\"
Packit b099d7
.ds f4\"
Packit b099d7
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
Packit b099d7
.TH "XmVaCreateSimpleRadioBox" "library call"
Packit b099d7
.SH "NAME"
Packit b099d7
\fBXmVaCreateSimpleRadioBox\fP \(em A RowColumn widget convenience creation function
Packit b099d7
.iX "XmVaCreateSimpleRadioBox"
Packit b099d7
.iX "creation functions" "XmVaCreateSimpleRadioBox"
Packit b099d7
.SH "SYNOPSIS"
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
#include <Xm/RowColumn\&.h>
Packit b099d7
\fBWidget \fBXmVaCreateSimpleRadioBox\fP\fR(
Packit b099d7
\fBWidget \fBparent\fR\fR,
Packit b099d7
\fBString \fBname\fR\fR,
Packit b099d7
\fBint \fBbutton_set\fR\fR,
Packit b099d7
\fBXtCallbackProc \fBcallback\fR\fR);
Packit b099d7
.fi
Packit b099d7
.SH "DESCRIPTION"
Packit b099d7
.PP
Packit b099d7
\fBXmVaCreateSimpleRadioBox\fP creates an instance of a RowColumn widget
Packit b099d7
of type \fBXmWORK_AREA\fP and returns the associated widget ID\&.
Packit b099d7
This routine uses the ANSI C variable-length argument list (\fIvarargs\fP)
Packit b099d7
calling convention\&.
Packit b099d7
.PP
Packit b099d7
This routine creates a RadioBox and its ToggleButtonGadget children\&.
Packit b099d7
The name of each button is \fBbutton_\fP\fIn\fP, where \fIn\fP is an integer
Packit b099d7
from 0 (zero) to the number of buttons in the menu minus 1\&.
Packit b099d7
.IP "\fIparent\fP" 10
Packit b099d7
Specifies the parent widget ID\&.
Packit b099d7
.IP "\fIname\fP" 10
Packit b099d7
Specifies the name of the created widget\&.
Packit b099d7
.IP "\fIbutton_set\fP" 10
Packit b099d7
Specifies which button is initially set\&.
Packit b099d7
The value is the integer \fIn\fP in the button name \fBbutton_\fP\fIn\fP\&.
Packit b099d7
.IP "\fIcallback\fP" 10
Packit b099d7
Specifies a callback procedure to be called when a button\&'s value
Packit b099d7
changes\&.
Packit b099d7
This callback function is added to each button after creation as the
Packit b099d7
button\&'s \fBXmNvalueChangedCallback\fP\&.
Packit b099d7
The callback function is called when a button\&'s value changes, and the
Packit b099d7
button number is returned in the \fIclient_data\fP field\&.
Packit b099d7
.PP
Packit b099d7
The variable portion of the argument list consists of groups of
Packit b099d7
arguments\&.
Packit b099d7
The first argument in each group is a constant or a string and
Packit b099d7
determines which arguments follow in that group\&.
Packit b099d7
The last argument in the list must be NULL\&.
Packit b099d7
Following are the possible first arguments in each group of \fIvarargs\fP:
Packit b099d7
.IP "\fBXmVaRADIOBUTTON\fP" 10
Packit b099d7
This is followed by four additional arguments\&. The set specifies one
Packit b099d7
button in the RadioBox and some of its resource values\&. Following are
Packit b099d7
the additional four arguments, in order:
Packit b099d7
.RS
Packit b099d7
.IP "\fIlabel\fP" 10
Packit b099d7
The label string, of type \fBXmString\fR\&.
Packit b099d7
.IP "\fImnemonic\fP" 10
Packit b099d7
The mnemonic, of type \fBKeySym\fP\&. This is ignored in this release\&.
Packit b099d7
.IP "\fIaccelerator\fP" 10
Packit b099d7
The accelerator, of type \fBString\fR\&. This is ignored in this release\&.
Packit b099d7
.IP "\fIaccelerator_text\fP" 10
Packit b099d7
The accelerator text, of type \fBXmString\fR\&. This is ignored in this
Packit b099d7
release\&.
Packit b099d7
.RE
Packit b099d7
.IP "\fIresource_name\fP" 10
Packit b099d7
This is followed by one additional argument, the value of the resource,
Packit b099d7
of type \fBXtArgVal\fP\&. The pair specifies a resource and its value for the
Packit b099d7
RowColumn widget\&.
Packit b099d7
.IP "\fBXtVaTypedArg\fP" 10
Packit b099d7
This is followed by four additional arguments\&. The set specifies a
Packit b099d7
resource and its value for the RowColumn widget\&. A resource type
Packit b099d7
conversion is performed if necessary\&. Following are the additional four
Packit b099d7
arguments, in this order:
Packit b099d7
.RS
Packit b099d7
.IP "\fIname\fP" 10
Packit b099d7
The resource name, of type \fBString\fR
Packit b099d7
.IP "\fItype\fP" 10
Packit b099d7
The type of the resource value supplied, of type \fBString\fR
Packit b099d7
.IP "\fIvalue\fP" 10
Packit b099d7
The resource value (or a pointer to the resource value, depending on the
Packit b099d7
type and size of the value), of type \fBXtArgVal\fP
Packit b099d7
.IP "\fIsize\fP" 10
Packit b099d7
The size of the resource value in bytes, of type \fIint\fP
Packit b099d7
.RE
Packit b099d7
.IP "\fBXtVaNestedList\fP" 10
Packit b099d7
This is followed by one additional argument of type \fBXtVarArgsList\fP\&. This
Packit b099d7
argument is a nested list of \fIvarargs\fP returned by
Packit b099d7
\fBXtVaCreateArgsList\fP\&.
Packit b099d7
.PP
Packit b099d7
For more information on variable-length argument lists, see the X
Packit b099d7
Toolkit Intrinsics documentation\&.
Packit b099d7
.PP
Packit b099d7
A number of resources exist specifically for use with this and
Packit b099d7
other simple menu creation routines\&.
Packit b099d7
For a complete definition of RowColumn and its associated resources, see
Packit b099d7
\fBXmRowColumn\fP(3)\&.
Packit b099d7
.SH "RETURN"
Packit b099d7
.PP
Packit b099d7
Returns the RowColumn widget ID\&.
Packit b099d7
.SH "RELATED"
Packit b099d7
.PP
Packit b099d7
\fBXmCreateRadioBox\fP(3),
Packit b099d7
\fBXmCreateRowColumn\fP(3),
Packit b099d7
\fBXmCreateSimpleCheckBox\fP(3),
Packit b099d7
\fBXmCreateSimpleRadioBox\fP(3),
Packit b099d7
\fBXmRowColumn\fP(3), and
Packit b099d7
\fBXmVaCreateSimpleCheckBox\fP(3),
Packit b099d7
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:36