offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DragSourceDragEvent.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_datatransfer_dnd_DragSourceDragEvent_idl__
  32 #define __com_sun_star_datatransfer_dnd_DragSourceDragEvent_idl__
  33
  34 #ifndef __com_sun_star_datatransfer_dnd_DragSourceEvent_idl__
  35 #include <com/sun/star/datatransfer/dnd/DragSourceEvent.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module datatransfer { module dnd {
  41
  42 //=============================================================================
  43 /** The <type>DragSourceDragEvent</type> is delivered from an object that
  44     implements the <type>XDragSourceContext</type> to the
  45     currently registered drag source listener.
  46
  47     <p>It contains state regarding the current state of the operation to enable
  48     the operations initiator to provide the end user with the appropriate drag
  49     over feedback.</p>
  50
  51     @see com::sun::star::datatransfer::dnd::XDragSourceListener
  52 */
  53
  54 published struct DragSourceDragEvent: com::sun::star::datatransfer::dnd::DragSourceEvent
  55 {
  56     //-------------------------------------------------------------------------
  57     /** The drag action selected by the current drop target.
  58
  59         @see com::sun::star::datatransfer::dnd::DNDConstants
  60      */
  61     byte DropAction;
  62
  63     //-------------------------------------------------------------------------
  64     /** The user's currently selected drop action.
  65
  66         @see com::sun::star::datatransfer::dnd::DNDConstants
  67      */
  68     byte UserAction;
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; }; };
  74
  75 #endif