CreHelpQ.sgm 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. <!-- $XConsortium: CreHelpQ.sgm /main/6 1996/08/30 12:55:26 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.XCSA.MAN11.rsml.1">]]>
  10. <![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN11.rsml.1">]]>
  11. <RefMeta>
  12. <RefEntryTitle>DtCreateHelpQuickDialog</RefEntryTitle>
  13. <ManVolNum>library call</ManVolNum>
  14. </RefMeta>
  15. <RefNameDiv>
  16. <RefName><Function>DtCreateHelpQuickDialog</Function></RefName>
  17. <RefPurpose>create a DtHelpQuickDialog widget
  18. </RefPurpose>
  19. </RefNameDiv>
  20. <!-- CDE Common Source Format, Version 1.0.0-->
  21. <!-- *************************************************************************-->
  22. <!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
  23. <!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
  24. <!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
  25. <!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
  26. <!-- *************************************************************************-->
  27. <RefSynopsisDiv>
  28. <FuncSynopsis Remap="ANSI">
  29. <FuncSynopsisInfo>#include &lt;Dt/HelpQuickD.h>
  30. </FuncSynopsisInfo>
  31. <FuncDef>Widget <Function>DtCreateHelpQuickDialog</Function></FuncDef>
  32. <ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
  33. <ParamDef>String <Parameter>name</Parameter></ParamDef>
  34. <ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
  35. <ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
  36. </FuncSynopsis>
  37. </RefSynopsisDiv>
  38. <RefSect1>
  39. <Title>DESCRIPTION</Title>
  40. <Para>The
  41. <Function>DtCreateHelpQuickDialog</Function> function is a convenience function that creates a
  42. DtHelpQuickDialog
  43. widget.
  44. </Para>
  45. <Para>The
  46. <Symbol Role="Variable">parent</Symbol> argument specifies the parent widget ID.
  47. </Para>
  48. <Para>The
  49. <Symbol Role="Variable">name</Symbol> argument specifies the name of the created widget.
  50. </Para>
  51. <Para>The
  52. <Symbol Role="Variable">arglist</Symbol> argument specifies the argument list.
  53. </Para>
  54. <Para>The
  55. <Symbol Role="Variable">argcount</Symbol> argument specifies the number of attribute and value pairs
  56. in the argument list
  57. (<Symbol Role="Variable">arglist</Symbol>).</Para>
  58. </RefSect1>
  59. <RefSect1>
  60. <Title>RETURN VALUE</Title>
  61. <Para>Upon successful completion, the
  62. <Function>DtCreateHelpQuickDialog</Function> function returns an
  63. XmBulletinBoard
  64. widget whose parent is a dialog shell widget; otherwise, it returns an
  65. undefined widget value.
  66. The dialog shell is the
  67. DtHelpQuickDialog
  68. widget's top level.
  69. <![ %CDE.C.CDE; [Refer to the
  70. Motif documentation for more information on the dialog shell widget and
  71. applicable resources.
  72. ]]></Para>
  73. </RefSect1>
  74. <RefSect1>
  75. <Title>SEE ALSO</Title>
  76. <Para>&cdeman.Dt.HelpDialog.h;, &cdeman.Dt.Help.h;, &cdeman.DtCreateHelpDialog;, &cdeman.DtHelpSetCatalogName;, &cdeman.DtHelpQuickDialogGetChild;, <![ %CDE.C.CDE; [&cdeman.XmBulletinBoard;. ]]><![ %CDE.C.XO; [<Classname>XmBulletinBoard</Classname> in the &str-ZM;.
  77. ]]></Para>
  78. </RefSect1>
  79. </RefEntry>
  80. <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->