CDE/cde/doc/C/guides/man/m3_Dt/DndCreSI.sgm

<!-- $XConsortium: DndCreSI.sgm /main/5 1996/08/30 12:56:35 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.MAN24.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN24.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtDndCreateSourceIcon</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtDndCreateSourceIcon</Function></RefName>
<RefPurpose>create a drag source icon
</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/Dnd.h>
</FuncSynopsisInfo>
<FuncDef>Widget <Function>DtDndCreateSourceIcon</Function></FuncDef>
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
<ParamDef>Pixmap <Parameter>pixmap</Parameter></ParamDef>
<ParamDef>Pixmap <Parameter>mask</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtDndCreateSourceIcon</Function> function creates a Motif drag icon, named
<Literal>sourceIcon</Literal>, based on the characteristics of the
<Symbol Role="Variable">pixmap</Symbol> argument.
The resulting drag icon is suitable for use with
&cdeman.DtDndDragStart;.</Para>
<Para>The
<Symbol Role="Variable">parent</Symbol> argument is the parent of the drag icon.
Typically this widget is the drag source.
</Para>
<Para>The
<Symbol Role="Variable">pixmap</Symbol> argument is the pixmap representation of the data to be dragged.
</Para>
<Para>The
<Symbol Role="Variable">mask</Symbol> argument is the mask for the
<Symbol Role="Variable">pixmap</Symbol>.</Para>
<Para>When it calls
&cdeman.XmCreateDragIcon;, the
<Function>DtDndCreateSourceIcon</Function> function sets Motif resources in the drag icon;
the application must not modify the values of any of these resources:
</Para>
<ItemizedList>
<ListItem><Para><SystemItem Class="Resource">XmNwidth</SystemItem></Para></ListItem>
<ListItem><Para><SystemItem Class="Resource">XmNheight</SystemItem></Para></ListItem>
<ListItem><Para><SystemItem Class="Resource">XmNpixmap</SystemItem></Para></ListItem>
<ListItem><Para><SystemItem Class="Resource">XmNmask</SystemItem></Para></ListItem>
<ListItem><Para><SystemItem Class="Resource">XmNdepth</SystemItem></Para></ListItem>
</ItemizedList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtDndCreateSourceIcon</Function> function returns a drag icon created by calling
&cdeman.XmCreateDragIcon; with the characteristics of the
<Symbol Role="Variable">pixmap</Symbol>; otherwise, it returns
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Dnd.h;, <![ %CDE.C.CDE; [&cdeman.DtDndDragStart;, &cdeman.XmCreateDragIcon;, &cdeman.XmDragIcon;, &cdeman.XmDragStart;, <Function>XtDestroyWidget</Function>(3). ]]><![ %CDE.C.XO; [<Function>DtDndDragStart</Function>; <Function>XmCreateDragIcon</Function>, <Function>XmDragIcon</Function>, <Function>XmDragStart</Function> in the &str-ZM;;
<Function>XtDestroyWidget</Function> in the &str-Zt;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->