113 lines
3.1 KiB
Plaintext
113 lines
3.1 KiB
Plaintext
<!-- $XConsortium: SetWsTi.sgm /main/2 1996/09/19 13:38:13 cdedoc $ -->
|
|
<!-- (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="CDE.WSM.SetWsTitle">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCDI.WSM.SetWsTitle">]]>
|
|
|
|
<RefMeta>
|
|
<RefEntryTitle>DtWsmSetWorkspaceTitle</RefEntryTitle>
|
|
<ManVolNum>API</ManVolNum>
|
|
</RefMeta>
|
|
|
|
<RefNameDiv>
|
|
<RefName><Function>DtWsmSetWorkspaceTitle</Function></RefName>
|
|
<RefPurpose>set workspace title
|
|
</RefPurpose>
|
|
</RefNameDiv>
|
|
|
|
<RefSynopsisDiv>
|
|
<FuncSynopsis Remap="ANSI">
|
|
<FuncSynopsisInfo>#include <Dt/Wsm.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>int <Function>DtWsmSetWorkspaceTitle</Function></FuncDef>
|
|
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
|
<ParamDef>Atom <Parameter>workspace</Parameter></ParamDef>
|
|
<ParamDef>char <Parameter>*title</Parameter></ParamDef>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
|
|
<Para>The
|
|
<Function>DtWsmSetWorkspaceTitle()</Function> function works with the CDE workspace manager, <command>dtwm(1)</command>,
|
|
and changes a specific workspace's title. Applications can use this function to implement
|
|
an interface to the workspace manager.
|
|
</Para>
|
|
<para>
|
|
If the <function>DtWsmSetWorkspaceTitle()</function> function is not successful,
|
|
the most likely reason for failure is that
|
|
the CDE workspace manager, <command>dtwm(1)</command>, is not running.
|
|
The <function>DtWsmSetWorkspaceTitle()</function> function
|
|
requires a widget. A gadget (or unrealized widget) is not acceptable for the widget argument.
|
|
</para>
|
|
<para>
|
|
<function>DtWsmSetWorkspaceTitle()</function> sends a message to the CDE workspace manager,
|
|
dtwm(1), to set the title. If the workspace name is not valid, no action is
|
|
taken and the workspace manager reports no error.
|
|
</para>
|
|
</RefSect1>
|
|
|
|
<RefSect1>
|
|
<Title>ARGUMENTS</Title>
|
|
<VariableList>
|
|
<VarListEntry>
|
|
<Term><symbol role="Variable">widget</symbol></Term>
|
|
<ListItem>
|
|
<Para>
|
|
A realized widget on the screen of interest
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term><symbol role="Variable">workspace</symbol></Term>
|
|
<ListItem>
|
|
<Para>
|
|
The name of the workspace (in X atom form) where the title should be set
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term><symbol role="Variable">title</symbol></Term>
|
|
<ListItem>
|
|
<Para>
|
|
The new title
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
</VariableList>
|
|
</RefSect1>
|
|
|
|
<RefSect1>
|
|
<Title>RETURN VALUE</Title>
|
|
<Para>
|
|
The function returns Success (0) when it succeeds, and non-zero upon failure.
|
|
Note that these are
|
|
not the same values that <literal>_DtWsmSetWorkspaceTitle</literal> returns.
|
|
</Para>
|
|
</refsect1>
|
|
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<para>
|
|
<literal>DtWsm(5)</literal>
|
|
</para>
|
|
<para>
|
|
"Communicating with the Workspace Manager" section in the <citetitle>CDE Programmer's Guide</citetitle>
|
|
</para>
|
|
<para>
|
|
"Workspace Manager" section in the <citetitle>CDE Programmer's Overview</citetitle>
|
|
</para>
|
|
</RefSect1>
|
|
|
|
</RefEntry>
|
|
|
|
|
|
|