88 lines
3.7 KiB
Plaintext
88 lines
3.7 KiB
Plaintext
<!-- $XConsortium: ActionIc.sgm /main/6 1996/08/30 12:53:36 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.XCDI.MAN11.rsml.1">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN11.rsml.1">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>DtActionIcon</RefEntryTitle>
|
|
<ManVolNum>library call</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Function>DtActionIcon</Function></RefName>
|
|
<RefPurpose>get the icon information for an action
|
|
</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 Unix System Labs, Inc.,-->
|
|
<!-- ** a subsidiary of Novell, Inc.-->
|
|
<!-- *************************************************************************-->
|
|
<RefSynopsisDiv>
|
|
<FuncSynopsis Remap="ANSI">
|
|
<FuncSynopsisInfo>#include <Dt/Action.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>char <Function>*DtActionIcon</Function></FuncDef>
|
|
<ParamDef>char *<Parameter>actionName</Parameter></ParamDef>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Function>DtActionIcon</Function> function gets the icon information for an action.
|
|
The
|
|
<Emphasis>actionName</Emphasis> argument is the name of the action.
|
|
<Function>DtActionIcon</Function> returns the name of the icon associated with an
|
|
<Emphasis>actionName</Emphasis> action.
|
|
If the action definition does not explicitly identify an icon
|
|
name, this function returns the default action icon name,
|
|
as described in
|
|
<![ %CDE.C.CDE; [&cdeman.dtactionfile; (``Action Selection'').
|
|
]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.M4DTA.anch.1" Role="4">. ]]>The default action icon name can be customized using the
|
|
<Literal>actionIcon</Literal> X resource.
|
|
</Para>
|
|
<Para>If there are multiple
|
|
<Emphasis>actionName</Emphasis> actions, the string returned is the
|
|
icon associated with the most general action.
|
|
The most general action is the one with the lowest precedence,
|
|
as described in
|
|
<![ %CDE.C.CDE; [&cdeman.dtactionfile; (``Action Selection'').
|
|
]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.M4DTA.anch.1" Role="4">. ]]></Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>RETURN VALUE</Title>
|
|
<Para>Upon successful completion, the
|
|
<Function>DtActionIcon</Function> function returns a
|
|
newly allocated copy of the icon name string
|
|
(
|
|
<SystemItem Class="Constant">ICON</SystemItem> field) associated with the action;
|
|
otherwise, it returns
|
|
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>APPLICATION USAGE</Title>
|
|
<Para>The
|
|
<Function>DtActionIcon</Function> function is useful for applications that provide a graphical interface
|
|
to actions.
|
|
</Para>
|
|
<Para>The application should use
|
|
<Function>XtFree</Function>(3) to free the icon name string returned by the
|
|
<Function>DtActionIcon</Function> function.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.Dt.Action.h;, <![ %CDE.C.CDE; [<Function>XtFree</Function>(3) &cdeman.dtactionfile;, &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<Function>XtFree</Function>(3) in the &str-Zt;;
|
|
<XRef Linkend="XCDI.ACTI.anch.3" Role="2">, <XRef Linkend="XCDI.M4DTS.anch.1" Role="3">. ]]></Para>
|
|
</RefSect1>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|