145 lines
4.6 KiB
Plaintext
145 lines
4.6 KiB
Plaintext
<!-- $XConsortium: DtHelp.sgm /main/7 1996/09/08 19:59:13 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.XCSA.MAN74.rsml.1">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN74.rsml.1">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>Dt/Help.h</RefEntryTitle>
|
|
<ManVolNum>file formats</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Filename>Dt/Help.h</Filename></RefName>
|
|
<RefPurpose>help services definitions
|
|
</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.-->
|
|
<!-- *************************************************************************-->
|
|
<RefSynopsisDiv>
|
|
<Synopsis>#include <Dt/Help.h>
|
|
</Synopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Filename Role="Header">Dt/Help.h</Filename> header defines the variables and function prototypes for help services.
|
|
</Para>
|
|
<Para>The
|
|
header defines the following
|
|
<StructName Role="typedef">DtHelpDialogCallbackStruct</StructName> <Emphasis>windowHint</Emphasis> constants:
|
|
</Para>
|
|
<InformalExample Remap="indent">
|
|
<ProgramListing>DtHELP_POPUP_WINDOW
|
|
DtHELP_CURRENT_WINDOW
|
|
DtHELP_NEW_WINDOW
|
|
</ProgramListing>
|
|
</InformalExample>
|
|
<Para>The
|
|
header defines the following
|
|
<StructName Role="typedef">DtHelpDialogCallbackStruct</StructName> <Emphasis>hyperType</Emphasis> constants:
|
|
</Para>
|
|
<InformalExample Remap="indent">
|
|
<ProgramListing>DtHELP_LINK_JUMP_NEW
|
|
DtHELP_LINK_TOPIC
|
|
DtHELP_LINK_MAN_PAGE
|
|
DtHELP_LINK_APP_DEFINE
|
|
DtHELP_LINK_TEXT_FILE
|
|
</ProgramListing>
|
|
</InformalExample>
|
|
<Para>The
|
|
header defines the following
|
|
<StructName Role="typedef">DtHelpDialogCallbackStruct</StructName> <Symbol Role="Variable">reason</Symbol> constants:
|
|
</Para>
|
|
<InformalExample Remap="indent">
|
|
<ProgramListing>DtCR_HELP_LINK_ACTIVATE
|
|
DtCR_HELP_CLOSE
|
|
DtCR_HELP_HELP
|
|
</ProgramListing>
|
|
</InformalExample>
|
|
<Para>The
|
|
header defines the following
|
|
<Symbol>DtNScrollBarPolicy</Symbol> constants:
|
|
</Para>
|
|
<InformalExample Remap="indent">
|
|
<ProgramListing>DtHELP_NO_SCROLLBARS
|
|
DtHELP_STATIC_SCROLLBARS
|
|
DtHELP_AS_NEEDED_SCROLLBARS
|
|
</ProgramListing>
|
|
</InformalExample>
|
|
<Para>The
|
|
header defines the following
|
|
<SystemItem Class="Resource">DtNhelpType</SystemItem> constants:
|
|
</Para>
|
|
<InformalExample Remap="indent">
|
|
<ProgramListing>DtHELP_TYPE_TOPIC
|
|
DtHELP_TYPE_STRING
|
|
DtHELP_TYPE_MAN_PAGE
|
|
DtHELP_TYPE_FILE
|
|
DtHELP_TYPE_DYNAMIC_STRING
|
|
</ProgramListing>
|
|
</InformalExample>
|
|
<Para>The
|
|
header defines the following
|
|
<SystemItem Class="Resource">DtNpaperSize</SystemItem> constants:
|
|
</Para>
|
|
<InformalExample Remap="indent">
|
|
<ProgramListing>DtHELP_PAPERSIZE_LETTER
|
|
DtHELP_PAPERSIZE_LEGAL
|
|
DtHELP_PAPERSIZE_EXECUTIVE
|
|
DtHELP_PAPERSIZE_A4
|
|
DtHELP_PAPERSIZE_B5
|
|
</ProgramListing>
|
|
</InformalExample>
|
|
<Para>The
|
|
header defines the following
|
|
<Function>DtHelpQuickDialogGetChild</Function> constants:
|
|
</Para>
|
|
<InformalExample Remap="indent">
|
|
<ProgramListing>DtHELP_QUICK_CLOSE_BUTTON
|
|
DtHELP_QUICK_PRINT_BUTTON
|
|
DtHELP_QUICK_HELP_BUTTON
|
|
DtHELP_QUICK_SEPARATOR
|
|
DtHELP_QUICK_MORE_BUTTON
|
|
DtHELP_QUICK_BACK_BUTTON
|
|
</ProgramListing>
|
|
</InformalExample>
|
|
<Para>The
|
|
header defines the following
|
|
<Function>DtHelpReturnSelectedWidgetId</Function> constants:
|
|
</Para>
|
|
<InformalExample Remap="indent">
|
|
<ProgramListing>DtHELP_SELECT_ERROR
|
|
DtHELP_SELECT_VALID
|
|
DtHELP_SELECT_ABORT
|
|
DtHELP_SELECT_INVALID
|
|
</ProgramListing>
|
|
</InformalExample>
|
|
<Para>The
|
|
header declares the following as functions:
|
|
</Para>
|
|
<Synopsis>void DtHelpSetCatalogName(char *<Emphasis>catFile</Emphasis>);
|
|
</Synopsis>
|
|
<Synopsis>int DtHelpReturnSelectedWidgetId(Widget <Symbol Role="Variable">parent</Symbol>,
|
|
Cursor <Symbol Role="Variable">cursor</Symbol>,
|
|
Widget *<Symbol Role="Variable">widget</Symbol>);
|
|
</Synopsis>
|
|
</RefSect1>
|
|
<![ %CDE.C.CDE; [
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.Dt.HelpDialog.h;, &cdeman.Dt.HelpQuickD.h;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.DtCreateHelpDialog;, &cdeman.DtHelpSetCatalogName;, &cdeman.DtHelpReturnSelectedWidgetId;, &cdeman.DtHelpDialog;, &cdeman.DtHelpQuickDialog;.</Para>
|
|
</RefSect1>
|
|
]]>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|