<!-- $XConsortium: VaCreA.sgm /main/9 1996/09/08 21:21:01 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMMA.MAN564.rsml.1">
<RefMeta>
<RefEntryTitle>XmVaCreateSimpleCheckBox</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmVaCreateSimpleCheckBox</Function></RefName>
<RefPurpose>A RowColumn widget convenience creation function
<IndexTerm>
<Primary>XmVaCreateSimpleCheckBox</Primary>
</IndexTerm><IndexTerm>
<Primary>creation functions</Primary>
<Secondary>XmVaCreateSimpleCheckBox</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- -->
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/RowColumn.h>
</FuncSynopsisInfo>
<FuncDef>Widget <Function>XmVaCreateSimpleCheckBox</Function></FuncDef>
<!--<ParamDef><Replaceable>parent, name, callback, arg...</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
<ParamDef>String <Parameter>name</Parameter></ParamDef>
<ParamDef>XtCallbackProc <Parameter>callback</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmVaCreateSimpleCheckBox</Function> creates an instance of a RowColumn widget
of type <SystemItem Class="Constant">XmWORK_AREA</SystemItem> and returns the associated widget ID.
This routine uses the ANSI C variable-length argument list (<Symbol Role="Variable">varargs</Symbol>)
calling convention.
</Para>
<Para>This routine creates a CheckBox and its ToggleButtonGadget children.
A CheckBox is similar to a RadioBox, except that more than one button
can be selected at a time.
The name of each button is <Literal>button_</Literal><Symbol Role="Variable">n</Symbol>, where <Symbol Role="Variable">n</Symbol> is an integer
from 0 (zero) to the number of buttons in the menu minus 1.
Buttons are named and created in the order in which they are specified
in the variable portion of the argument list.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">parent</Symbol></Term>
<ListItem>
<Para>Specifies the parent widget ID.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">name</Symbol></Term>
<ListItem>
<Para>Specifies the name of the created widget.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">callback</Symbol></Term>
<ListItem>
<Para>Specifies a callback procedure to be called when a button's value
changes.
This callback function is added to each button after creation as the
button's <SystemItem Class="Resource">XmNvalueChangedCallback</SystemItem>.
The callback function is called when a button's value changes, and the
button number is returned in the <Symbol Role="Variable">client_data</Symbol> field.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The variable portion of the argument list consists of groups of
arguments.
The first argument in each group is a constant or a string and
determines which arguments follow in that group.
The last argument in the list must be NULL.
The following list describes the possible first arguments
in each group of <Symbol Role="Variable">varargs</Symbol>:
</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="Constant">XmVaCHECKBUTTON</SystemItem></Term>
<ListItem>
<Para>This is followed by four additional arguments. The set specifies one
button in the CheckBox and some of its resource values.
The following list describes the additional four arguments, in order.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">label</Symbol></Term>
<ListItem>
<Para>The label string, of type <StructName Role="typedef">XmString</StructName>
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">mnemonic</Symbol></Term>
<ListItem>
<Para>The mnemonic, of type <Literal>KeySym</Literal>. This is ignored in this release.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">accelerator</Symbol></Term>
<ListItem>
<Para>The accelerator, of type <StructName Role="typedef">String</StructName>. This is ignored in this release.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">accelerator_text</Symbol></Term>
<ListItem>
<Para>The accelerator text, of type <StructName Role="typedef">XmString</StructName>. This is ignored in this
release.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<!--no-op:  .rE-->
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">resource_name</Symbol></Term>
<ListItem>
<Para>This is followed by one additional argument, the value of the resource,
of type <Symbol>XtArgVal</Symbol>. The pair specifies a resource and its value for the
RowColumn widget.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">XtVaTypedArg</SystemItem></Term>
<ListItem>
<Para>This is followed by four additional arguments. The set specifies a
resource and its value for the RowColumn widget. A resource type
conversion is performed if necessary. Following are the additional four
arguments, in order:
<!--no-op:  .rS .75i--></Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">name</Symbol></Term>
<ListItem>
<Para>The resource name, of type <StructName Role="typedef">String</StructName>
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">type</Symbol></Term>
<ListItem>
<Para>The type of the resource value supplied, of type <StructName Role="typedef">String</StructName>
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">value</Symbol></Term>
<ListItem>
<Para>The resource value (or a pointer to the resource value, depending on the
type and size of the value), of type <Symbol>XtArgVal</Symbol>
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">size</Symbol></Term>
<ListItem>
<Para>The size of the resource value in bytes, of type <Symbol Role="Variable">int</Symbol>
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<!--no-op:  .rE-->
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">XtVaNestedList</SystemItem></Term>
<ListItem>
<Para>This is followed by one additional argument of type XtVarArgsList. This
argument is a nested list of <Symbol Role="Variable">varargs</Symbol> returned by
<Function>XtVaCreateArgsList</Function>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For more information on variable-length argument lists, see the X
Toolkit Intrinsics documentation.
</Para>
<Para>A number of resources exist specifically for use with this and
other simple menu creation routines.
For a complete definition of RowColumn and its associated resources, see
&cdeman.XmRowColumn;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns the RowColumn widget ID.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmCreateRadioBox;,
&cdeman.XmCreateRowColumn;,
&cdeman.XmCreateSimpleCheckBox;,
&cdeman.XmCreateSimpleRadioBox;,
&cdeman.XmRowColumn;, and
&cdeman.XmVaCreateSimpleRadioBox;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
