<!-- $XConsortium: ChBackDr.sgm /main/2 1996/09/19 13:37:50 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.changebkdrop">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.WSM.changebkdrop">]]>

<RefMeta>
<RefEntryTitle>DtWsmChangeBackdrop</RefEntryTitle>
<ManVolNum>API</ManVolNum>
</RefMeta>

<RefNameDiv>
<RefName><Function>DtWsmChangeBackdrop</Function></RefName>
<RefPurpose>set current workspace's backdrop
</RefPurpose>
</RefNameDiv>

<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Dt/Wsm.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>DtWsmChangeBackdrop</Function></FuncDef>
<ParamDef>Display <Parameter>*display</Parameter></ParamDef>
<ParamDef>Window <Parameter>root</Parameter></ParamDef>
<ParamDef>char <Parameter>*path</Parameter></ParamDef>
<ParamDef>Pixmap <Parameter>pixmap</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>

<RefSect1>
<Title>DESCRIPTION</Title>
<Para>
The <Function>DtWsmChangeBackdrop</Function> function works with the CDE workspace manager,
<command>dtwm(1)</command>, and
changes the current workspace's backdrop. Applications can use this function to implement an
interface to the workspace manager.
</Para>
<Para>
If the <Function>DtWsmChangeBackdrop</Function> function is not successful, the most likely reason for failure is that
the CDE workspace manager, <command>dtwm(1)</command>, is not running.
</Para>
<Para>
<Function>DtWsmChangeBackdrop</Function> sends a message to the CDE workspace manager,
<command>dtwm(1)</command>, to change the backdrop.
</Para>
<Para>
The <Symbol Role="Variable">path</Symbol> argument points to a backdrop file name.
The file must be in either X Bitmap file format
(with extension <filename>.bm</filename>) or Pixmap file format (with extension <filename>.pm</filename>).
The workspace management services look for the file along the same path used for searching icons.
The directory <filename>/usr/dt/backdrops</filename> is the
default directory if the file cannot be found along the icon search path.
</Para>
</RefSect1>

<RefSect1>

<Title>ARGUMENTS</Title>
<VariableList>

<VarListEntry>
<Term><symbol role="Variable">display</symbol></Term>
<ListItem>
<Para>
display
</Para>
</ListItem>
</VarListEntry>

<VarListEntry>
<Term><symbol role="Variable">root</symbol></Term>
<ListItem>
<Para>
root window of the screen
</Para>
</ListItem>
</VarListEntry>

<VarListEntry>
<Term><symbol role="Variable">path</symbol></Term>
<ListItem>
<Para>
file path to bitmap file
</Para>
</ListItem>
</VarListEntry>

<VarListEntry>
<Term><symbol role="Variable">pixmap</symbol></Term>
<ListItem>
<Para>
pixmap ID of backdrop pixmap
</Para>
</ListItem>
</varlistentry>

</VariableList>

</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>



