84 lines
3.4 KiB
Plaintext
84 lines
3.4 KiB
Plaintext
<!-- $XConsortium: ActionLa.sgm /main/6 1996/08/30 12:53:56 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.MAN13.rsml.1">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN13.rsml.1">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>DtActionLabel</RefEntryTitle>
|
|
<ManVolNum>library call</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Function>DtActionLabel</Function></RefName>
|
|
<RefPurpose>get the localizable label string 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 Novell, Inc.-->
|
|
<!-- *************************************************************************-->
|
|
<RefSynopsisDiv>
|
|
<FuncSynopsis Remap="ANSI">
|
|
<FuncSynopsisInfo>#include <Dt/Action.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>char <Function>*DtActionLabel</Function></FuncDef>
|
|
<ParamDef>char *<Parameter>actionName</Parameter></ParamDef>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Function>DtActionLabel</Function> function provides access to the localizable label string associated with an
|
|
action named
|
|
<Emphasis>actionName</Emphasis>. The
|
|
<Emphasis>actionName</Emphasis> argument is the name of the action.
|
|
The localizable label string is the string that all components
|
|
should display to identify the action.
|
|
If the action definition does not specify a label string,
|
|
the action name itself is returned.
|
|
</Para>
|
|
<Para>The label string associated with an action is localizable, but the
|
|
action name is not.
|
|
</Para>
|
|
<Para>If there are multiple
|
|
<Emphasis>actionName</Emphasis> actions, the label string returned
|
|
is the label 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>DtActionLabel</Function> function returns a newly allocated
|
|
copy of the localizable
|
|
label string associated with the action if an action named
|
|
<Emphasis>actionName</Emphasis> is found;
|
|
otherwise, it returns
|
|
<SystemItem Class="Constant">NULL</SystemItem>. It is up to the caller to free the memory associated with
|
|
this new copy of the label.
|
|
The default value for an action label is the action name itself.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>APPLICATION USAGE</Title>
|
|
<Para>All applications displaying action names should use
|
|
the action label to identify an action.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.Dt.Action.h;, <![ %CDE.C.CDE; [&cdeman.dtactionfile;, &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<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-->
|