cde/doc/C/guides/man/man5/DtHelp.sgm

   1 <!-- $XConsortium: DtHelp.sgm /main/7 1996/09/08 19:59:13 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
  10 <![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN74.rsml.1">]]>
  11 <![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN74.rsml.1">]]>
  12 <RefMeta>
  13 <RefEntryTitle>Dt/Help.h</RefEntryTitle>
  14 <ManVolNum>file formats</ManVolNum>
  15 </RefMeta>
  16 <RefNameDiv>
  17 <RefName><Filename>Dt/Help.h</Filename></RefName>
  18 <RefPurpose>help services definitions
  19 </RefPurpose>
  20 </RefNameDiv>
  21 <!-- CDE Common Source Format, Version 1.0.0-->
  22 <!-- *************************************************************************-->
  23 <!-- **  (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
  24 <!-- **  (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
  25 <!-- **  (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
  26 <!-- **  (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
  27 <!-- *************************************************************************-->
  28 <RefSynopsisDiv>
  29 <Synopsis>#include &lt;Dt/Help.h>
  30 </Synopsis>
  31 </RefSynopsisDiv>
  32 <RefSect1>
  33 <Title>DESCRIPTION</Title>
  34 <Para>The
  35 <Filename Role="Header">Dt/Help.h</Filename> header defines the variables and function prototypes for help services.
  36 </Para>
  37 <Para>The
  38 header defines the following
  39 <StructName Role="typedef">DtHelpDialogCallbackStruct</StructName> <Emphasis>windowHint</Emphasis> constants:
  40 </Para>
  41 <InformalExample Remap="indent">
  42 <ProgramListing>DtHELP_POPUP_WINDOW
  43 DtHELP_CURRENT_WINDOW
  44 DtHELP_NEW_WINDOW
  45 </ProgramListing>
  46 </InformalExample>
  47 <Para>The
  48 header defines the following
  49 <StructName Role="typedef">DtHelpDialogCallbackStruct</StructName> <Emphasis>hyperType</Emphasis> constants:
  50 </Para>
  51 <InformalExample Remap="indent">
  52 <ProgramListing>DtHELP_LINK_JUMP_NEW
  53 DtHELP_LINK_TOPIC
  54 DtHELP_LINK_MAN_PAGE
  55 DtHELP_LINK_APP_DEFINE
  56 DtHELP_LINK_TEXT_FILE
  57 </ProgramListing>
  58 </InformalExample>
  59 <Para>The
  60 header defines the following
  61 <StructName Role="typedef">DtHelpDialogCallbackStruct</StructName> <Symbol Role="Variable">reason</Symbol> constants:
  62 </Para>
  63 <InformalExample Remap="indent">
  64 <ProgramListing>DtCR_HELP_LINK_ACTIVATE
  65 DtCR_HELP_CLOSE
  66 DtCR_HELP_HELP
  67 </ProgramListing>
  68 </InformalExample>
  69 <Para>The
  70 header defines the following
  71 <Symbol>DtNScrollBarPolicy</Symbol> constants:
  72 </Para>
  73 <InformalExample Remap="indent">
  74 <ProgramListing>DtHELP_NO_SCROLLBARS
  75 DtHELP_STATIC_SCROLLBARS
  76 DtHELP_AS_NEEDED_SCROLLBARS
  77 </ProgramListing>
  78 </InformalExample>
  79 <Para>The
  80 header defines the following
  81 <SystemItem Class="Resource">DtNhelpType</SystemItem> constants:
  82 </Para>
  83 <InformalExample Remap="indent">
  84 <ProgramListing>DtHELP_TYPE_TOPIC
  85 DtHELP_TYPE_STRING
  86 DtHELP_TYPE_MAN_PAGE
  87 DtHELP_TYPE_FILE
  88 DtHELP_TYPE_DYNAMIC_STRING
  89 </ProgramListing>
  90 </InformalExample>
  91 <Para>The
  92 header defines the following
  93 <SystemItem Class="Resource">DtNpaperSize</SystemItem> constants:
  94 </Para>
  95 <InformalExample Remap="indent">
  96 <ProgramListing>DtHELP_PAPERSIZE_LETTER
  97 DtHELP_PAPERSIZE_LEGAL
  98 DtHELP_PAPERSIZE_EXECUTIVE
  99 DtHELP_PAPERSIZE_A4
 100 DtHELP_PAPERSIZE_B5
 101 </ProgramListing>
 102 </InformalExample>
 103 <Para>The
 104 header defines the following
 105 <Function>DtHelpQuickDialogGetChild</Function> constants:
 106 </Para>
 107 <InformalExample Remap="indent">
 108 <ProgramListing>DtHELP_QUICK_CLOSE_BUTTON
 109 DtHELP_QUICK_PRINT_BUTTON
 110 DtHELP_QUICK_HELP_BUTTON
 111 DtHELP_QUICK_SEPARATOR
 112 DtHELP_QUICK_MORE_BUTTON
 113 DtHELP_QUICK_BACK_BUTTON
 114 </ProgramListing>
 115 </InformalExample>
 116 <Para>The
 117 header defines the following
 118 <Function>DtHelpReturnSelectedWidgetId</Function> constants:
 119 </Para>
 120 <InformalExample Remap="indent">
 121 <ProgramListing>DtHELP_SELECT_ERROR
 122 DtHELP_SELECT_VALID
 123 DtHELP_SELECT_ABORT
 124 DtHELP_SELECT_INVALID
 125 </ProgramListing>
 126 </InformalExample>
 127 <Para>The
 128 header declares the following as functions:
 129 </Para>
 130 <Synopsis>void DtHelpSetCatalogName(char *<Emphasis>catFile</Emphasis>);
 131 </Synopsis>
 132 <Synopsis>int DtHelpReturnSelectedWidgetId(Widget <Symbol Role="Variable">parent</Symbol>,
 133                 Cursor <Symbol Role="Variable">cursor</Symbol>,
 134                 Widget *<Symbol Role="Variable">widget</Symbol>);
 135 </Synopsis>
 136 </RefSect1>
 137 <![ %CDE.C.CDE; [
 138 <RefSect1>
 139 <Title>SEE ALSO</Title>
 140 <Para>&cdeman.Dt.HelpDialog.h;, &cdeman.Dt.HelpQuickD.h;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.DtCreateHelpDialog;, &cdeman.DtHelpSetCatalogName;, &cdeman.DtHelpReturnSelectedWidgetId;, &cdeman.DtHelpDialog;, &cdeman.DtHelpQuickDialog;.</Para>
 141 </RefSect1>
 142 ]]>
 143 </RefEntry>
 144 <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->