82 lines
3.4 KiB
Plaintext
82 lines
3.4 KiB
Plaintext
<!-- $XConsortium: HelpQDGC.sgm /main/6 1996/09/08 20:04:30 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.MAN47.rsml.1">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN47.rsml.1">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>DtHelpQuickDialogGetChild</RefEntryTitle>
|
|
<ManVolNum>library call</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Function>DtHelpQuickDialogGetChild</Function></RefName>
|
|
<RefPurpose>get child of DtHelpQuickDialog widget
|
|
</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>
|
|
<FuncSynopsis Remap="ANSI">
|
|
<FuncSynopsisInfo>#include <Dt/HelpQuickD.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>Widget <Function>DtHelpQuickDialogGetChild</Function></FuncDef>
|
|
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
|
<ParamDef>int <Parameter>child</Parameter></ParamDef>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Function>DtHelpQuickDialogGetChild</Function> function accesses a component within a
|
|
DtHelpQuickDialog
|
|
widget.
|
|
</Para>
|
|
<Para>The
|
|
<Symbol Role="Variable">widget</Symbol> argument specifies the
|
|
DtHelpQuickDialog
|
|
widget instance.
|
|
</Para>
|
|
<Para>The
|
|
<Symbol Role="Variable">child</Symbol> argument specifies which
|
|
DtHelpQuickDialog
|
|
widget child the widget ID is for.
|
|
The following are valid values for the
|
|
<Symbol Role="Variable">child</Symbol> argument:
|
|
</Para>
|
|
<InformalExample Remap="indent">
|
|
<ProgramListing><SystemItem Class="Constant">DtHELP_QUICK_CLOSE_BUTTON</SystemItem> <SystemItem Class="Constant">DtHELP_QUICK_PRINT_BUTTON</SystemItem> <SystemItem Class="Constant">DtHELP_QUICK_HELP_BUTTON</SystemItem> <SystemItem Class="Constant">DtHELP_QUICK_SEPARATOR</SystemItem> <SystemItem Class="Constant">DtHELP_QUICK_MORE_BUTTON</SystemItem> <SystemItem Class="Constant">DtHELP_QUICK_BACK_BUTTON</SystemItem></ProgramListing>
|
|
</InformalExample>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>RETURN VALUE</Title>
|
|
<Para>Upon successful completion, the
|
|
<Function>DtHelpQuickDialogGetChild</Function> function returns the widget ID of the requested child of the
|
|
DtHelpQuickDialog
|
|
widget; otherwise, it returns
|
|
<SystemItem Class="Constant">NULL</SystemItem> if either the function call fails, or an invalid value was passed in for
|
|
the
|
|
<Symbol Role="Variable">child</Symbol> argument.
|
|
<![ %CDE.C.CDE; [</Para>
|
|
<Para>If an invalid child type is given,
|
|
a warning message is generated:
|
|
``Non-valid Quick Help child type.''
|
|
]]></Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.Dt.HelpQuickD.h;, &cdeman.DtCreateHelpQuickDialog;; <![ %CDE.C.CDE; [&cdeman.XmeWarning;. ]]><![ %CDE.C.XO; [<Emphasis>XmWarning</Emphasis> in the &str-ZM;.
|
|
]]></Para>
|
|
</RefSect1>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|