ComboSet.sgm 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <!-- $XConsortium: ComboSet.sgm /main/10 1996/08/30 12:54:48 rws $ -->
  2. <!-- (c) Copyright 1995 Digital Equipment Corporation. -->
  3. <!-- (c) Copyright 1995 Hewlett-Packard Company. -->
  4. <!-- (c) Copyright 1995 International Business Machines Corp. -->
  5. <!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
  6. <!-- (c) Copyright 1995 Novell, Inc. -->
  7. <!-- (c) Copyright 1995 FUJITSU LIMITED. -->
  8. <!-- (c) Copyright 1995 Hitachi. -->
  9. <![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN18.rsml.1">]]>
  10. <![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN18.rsml.1">]]>
  11. <RefMeta>
  12. <RefEntryTitle>DtComboBoxSetItem</RefEntryTitle>
  13. <ManVolNum>library call</ManVolNum>
  14. </RefMeta>
  15. <RefNameDiv>
  16. <RefName><Function>DtComboBoxSetItem</Function></RefName>
  17. <RefPurpose>set an item in the DtComboBox list
  18. </RefPurpose>
  19. </RefNameDiv>
  20. <!-- CDE Common Source Format, Version 1.0.0-->
  21. <!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
  22. <!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
  23. <!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
  24. <!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
  25. <!-- (c) Copyright 1993, 1994, 1995 Interleaf, Inc.-->
  26. <RefSynopsisDiv>
  27. <FuncSynopsis Remap="ANSI">
  28. <FuncSynopsisInfo>#include &lt;Dt/ComboBox.h>
  29. </FuncSynopsisInfo>
  30. <FuncDef>void <Function>DtComboBoxSetItem</Function></FuncDef>
  31. <ParamDef>Widget <Parameter>w</Parameter></ParamDef>
  32. <ParamDef>XmString <Parameter>item</Parameter></ParamDef>
  33. </FuncSynopsis>
  34. </RefSynopsisDiv>
  35. <RefSect1>
  36. <Title>DESCRIPTION</Title>
  37. <note><para>This function has been superseded by the equivalent
  38. Motif function, <function>XmComboBoxSetItem</function>. Please refer to the
  39. <![ %CDE.C.CDE; [<emphasis>Motif Programmer's Reference</emphasis>]]><![ %CDE.C.XO; [&str-ZM;]]> for more information.
  40. </para>
  41. </note>
  42. <Para>The
  43. <Function>DtComboBoxSetItem</Function> function selects an item in the XmList of the given DtComboBox
  44. widget and makes it the first visible item in the list.
  45. </Para>
  46. <Para>The
  47. <Symbol Role="Variable">w</Symbol> argument specifies the DtComboBox widget ID.
  48. </Para>
  49. <Para>The
  50. <Symbol Role="Variable">item</Symbol> argument specifies the
  51. <StructName Role="typedef">XmString</StructName> for the item to be set in the DtComboBox.
  52. If the
  53. <Symbol Role="Variable">item</Symbol> is not found on the list,
  54. <Function>DtComboBoxSetItem</Function> notifies the user via the
  55. <Function>XtWarning</Function> function.
  56. </Para>
  57. </RefSect1>
  58. <RefSect1>
  59. <Title>RETURN VALUE</Title>
  60. <Para>The
  61. <Function>DtComboBoxSetItem</Function> function returns no value.
  62. </Para>
  63. </RefSect1>
  64. <RefSect1>
  65. <Title>SEE ALSO</Title>
  66. <Para>&cdeman.DtComboBox;,
  67. &cdeman.DtComboBoxAddItem;, &cdeman.DtComboBoxDeletePos;, &cdeman.DtComboBoxSelectItem;, <![ %CDE.C.CDE; [<Function>XtWarning</Function>(3).]]><![ %CDE.C.XO; [<Function>XtWarning</Function> in the &str-Zt;.]]></Para>
  68. </RefSect1>
  69. </RefEntry>
  70. <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->