CDE/cde/doc/C/guides/man/m3_Dt/ComboAdd.sgm

<!-- $XConsortium: ComboAdd.sgm /main/10 1996/08/30 12:54:06 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. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN15.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN15.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtComboBoxAddItem</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtComboBoxAddItem</Function></RefName>
<RefPurpose>add an item to the ComboBox widget
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Interleaf, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Dt/ComboBox.h>
</FuncSynopsisInfo>
<FuncDef>void <Function>DtComboBoxAddItem</Function></FuncDef>
<ParamDef>Widget <Parameter>w</Parameter></ParamDef>
<ParamDef>XmString <Parameter>item</Parameter></ParamDef>
<ParamDef>int <Parameter>pos</Parameter></ParamDef>
<ParamDef>Boolean <Parameter>unique</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<note><para>This function has been superseded by the equivalent
Motif function, <function>XmComboBoxAddItem</function>. Please refer to the
<![ %CDE.C.CDE; [<emphasis>Motif Programmer's Reference</emphasis>]]><![ %CDE.C.XO; [&str-ZM;]]> for more information.
</para>
</note>
<Para>The
<Function>DtComboBoxAddItem</Function> function adds the given item to the DtComboBox at the given position.
</Para>
<Para>The
<Symbol Role="Variable">w</Symbol> argument specifies the DtComboBox widget ID.
</Para>
<Para>The
<Symbol Role="Variable">item</Symbol> argument specifies the
<StructName Role="typedef">XmString</StructName> for the new item.
</Para>
<Para>The
<Emphasis>pos</Emphasis> argument specifies the position of the new item.
</Para>
<Para>The
<Emphasis>unique</Emphasis> argument specifies if this item should duplicate an identical item or not.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>DtComboBoxAddItem</Function> function returns no value.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The functions
<Function>DtComboBoxAddItem</Function> and
<Function>DtComboBoxDeletePos</Function> have different naming conventions (Item versus Pos)
because of the objects they are manipulating.
The Item is a string to be added,
the Pos is a numeric position number.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtComboBox;,
&cdeman.DtComboBoxDeletePos;, &cdeman.DtComboBoxSetItem;, &cdeman.DtComboBoxSelectItem;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->