Files
cdesktop/cde/doc/C/guides/man/m3_DtWsm/SetWsOcc.sgm
T

89 lines
3.2 KiB
Plaintext

<!-- $XConsortium: SetWsOcc.sgm /main/6 1996/08/30 15:31:52 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.MAN71.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN71.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtWsmSetWorkspacesOccupied</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtWsmSetWorkspacesOccupied</Function></RefName>
<RefPurpose>set the workspaces in which a window resides
</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>DtWsmSetWorkspacesOccupied</Function></FuncDef>
<ParamDef>Display *<Parameter>display</Parameter></ParamDef>
<ParamDef>Window <Parameter>window</Parameter></ParamDef>
<ParamDef>Atom *<Parameter>paWorkspaces</Parameter></ParamDef>
<ParamDef>int <Parameter>numWs</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtWsmSetWorkspacesOccupied</Function> function works with the
<![ %CDE.C.XO; [workspace manager
]]><![ %CDE.C.CDE; [&str-XZ;
workspace manager,
&cdeman.dtwm;, ]]>and puts a window into a set of workspaces.
</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 be put into
this set of workspaces.
</Para>
<Para>The
<Emphasis>paWorkspaces</Emphasis> argument points to a list of workspace names
(converted to X atoms); the
<![ %CDE.C.XO; [workspace manager
]]><![ %CDE.C.CDE; [&str-XZ;
workspace manager,
&cdeman.dtwm;, ]]>places the window into these
workspaces.
</Para>
<Para>The
<Emphasis>numWs</Emphasis> argument is the number of elements in the list of
workspaces.
</Para>
<Para>The
<Function>DtWsmSetWorkspacesOccupied</Function> function does not validate the list of requested workspaces.
The workspace manager ignores invalid workspaces in the list.
</Para>
<Para>Calling the
<Function>DtWsmSetWorkspacesOccupied</Function> function overrides the effect of the
<Function>DtWsmOccupyAllWorkspaces</Function> function.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>DtWsmSetWorkspacesOccupied</Function> function returns no value.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><![ %CDE.C.CDE; [&cdeman.dtwm;, ]]>&cdeman.Dt.Wsm.h;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->