<!-- $XConsortium: DragSt.sgm /main/9 1996/09/08 20:40:10 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. -->

<RefEntry Id="CDEMMA.MAN208.rsml.1">
<RefMeta>
<RefEntryTitle>XmDragStart</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmDragStart</Function></RefName>
<RefPurpose>A Drag and Drop function that initiates a drag and
drop transaction
<IndexTerm>
<Primary>XmDragStart</Primary>
</IndexTerm><IndexTerm>
<Primary>Drag and Drop functions</Primary>
<Secondary>XmDragStart</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- -->
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/DragDrop.h>
</FuncSynopsisInfo>
<FuncDef>Widget <Function>XmDragStart</Function></FuncDef>
<!--<ParamDef><Replaceable>widget, event, arglist, argcount</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>XEvent *<Parameter>event</Parameter></ParamDef>
<ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
<ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmDragStart</Function> initiates a drag operation. This routine
returns the DragContext widget that it initializes for the
associated drag transaction. The toolkit is responsible for
freeing the DragContext when the drag and drop transaction
is complete.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the ID of the smallest widget and/or gadget that encloses
the source elements selected for a drag operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">event</Symbol></Term>
<ListItem>
<Para>Specifies the <Symbol>XEvent</Symbol> that triggered the drag operation. This
event must be a ButtonPress event.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">arglist</Symbol></Term>
<ListItem>
<Para>Specifies the argument list. Any <Classname>XmDragContext</Classname> resources not
specified in the argument list are obtained from the resource database
or are set to their default values.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">argcount</Symbol></Term>
<ListItem>
<Para>Specifies the number of attribute/value pairs in the argument
list (<Symbol Role="Variable">arglist</Symbol>)
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of DragContext and its associated resources,
see &cdeman.XmDragContext;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns the ID of the DragContext widget that controls this drag
and drop transaction.
Returns NULL if the drag cannot be initiated.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmDragCancel; and
&cdeman.XmDragContext;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
