Files
cdesktop/cde/doc/C/guides/man/m3_Dt/ComboSet.sgm

72 lines
2.8 KiB
Plaintext

<!-- $XConsortium: ComboSet.sgm /main/10 1996/08/30 12:54:48 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.MAN18.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN18.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtComboBoxSetItem</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtComboBoxSetItem</Function></RefName>
<RefPurpose>set an item in the DtComboBox list
</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>DtComboBoxSetItem</Function></FuncDef>
<ParamDef>Widget <Parameter>w</Parameter></ParamDef>
<ParamDef>XmString <Parameter>item</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<note><para>This function has been superseded by the equivalent
Motif function, <function>XmComboBoxSetItem</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>DtComboBoxSetItem</Function> function selects an item in the XmList of the given DtComboBox
widget and makes it the first visible item in the list.
</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 item to be set in the DtComboBox.
If the
<Symbol Role="Variable">item</Symbol> is not found on the list,
<Function>DtComboBoxSetItem</Function> notifies the user via the
<Function>XtWarning</Function> function.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>DtComboBoxSetItem</Function> function returns no value.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtComboBox;,
&cdeman.DtComboBoxAddItem;, &cdeman.DtComboBoxDeletePos;, &cdeman.DtComboBoxSelectItem;, <![ %CDE.C.CDE; [<Function>XtWarning</Function>(3).]]><![ %CDE.C.XO; [<Function>XtWarning</Function> in the &str-Zt;.]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->