<!-- $XConsortium: AddWsFun.sgm /main/5 1996/08/30 15:26:53 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.MAN59.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN59.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtWsmAddWorkspaceFunctions</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtWsmAddWorkspaceFunctions</Function></RefName>
<RefPurpose>add workspace functions for a window
</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 &lt;Dt/Wsm.h>
</FuncSynopsisInfo>
<FuncDef>void <Function>DtWsmAddWorkspaceFunctions</Function></FuncDef>
<ParamDef>Display *<Parameter>display</Parameter></ParamDef>
<ParamDef>Window <Parameter>window</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtWsmAddWorkspaceFunctions</Function> function enables workspace functions for a
window.
When workspace functions are enabled, the default window menu for the
window displayed by the
<![ %CDE.C.XO; [workspace manager
]]><![ %CDE.C.CDE; [&str-XZ;
workspace manager,
&cdeman.dtwm;, ]]>shows entries that allow the window to occupy a different
set of workspaces, occupy all workspaces, or be removed from the current
workspace.
</Para>
<Para>The
<Symbol Role="Variable">display</Symbol> argument is the X display.
</Para>
<Para>The
<Symbol Role="Variable">window</Symbol> argument is the window to have its workspace functions enabled.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>DtWsmAddWorkspaceFunctions</Function> function returns no value.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application must call the
<Function>DtWsmAddWorkspaceFunctions</Function> function before mapping the window.
The
<![ %CDE.C.XO; [workspace manager
]]><![ %CDE.C.CDE; [&str-XZ;
workspace manager,
&cdeman.dtwm;, ]]>only looks at the workspace function information at the time the workspace
manager manages the window.
If the
<![ %CDE.C.XO; [workspace manager
]]><![ %CDE.C.CDE; [&str-XZ;
workspace manager,
&cdeman.dtwm;, ]]>is currently managing the window, the application must withdraw
the window
(see
<Function>XWithdrawWindow</Function>(3)), add the workspace functions, and map the window once again.
</Para>
<Para>By default, the workspace manager enables workspace functions.
</Para>
<Para>The application should call
<Function>DtWsmAddWorkspaceFunctions</Function> to restore the workspace functions removed by the
&cdeman.DtWsmRemoveWorkspaceFunctions; function.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Wsm.h;, <![ %CDE.C.CDE; [<Function>XWithdrawWindow</Function>(3), ]]><![ %CDE.C.XO; [<Function>XWithdrawWindow</Function>(3) in the &str-Zl;;
]]><![ %CDE.C.CDE; [&cdeman.dtwm;, ]]>&cdeman.DtWsmRemoveWorkspaceFunctions;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
