include/wx/mac/carbon/dnd.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        dnd.h
   3 // Purpose:     Declaration of the wxDropTarget, wxDropSource class etc.
   4 // Author:      Stefan Csomor
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1998 Stefan Csomor
   7 // Licence:     wxWindows licence
   8 ///////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_DND_H_
  11 #define _WX_DND_H_
  12
  13 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  14 #pragma interface "dnd.h"
  15 #endif
  16
  17 #if wxUSE_DRAG_AND_DROP
  18
  19 #include "wx/defs.h"
  20 #include "wx/object.h"
  21 #include "wx/string.h"
  22 #include "wx/string.h"
  23 #include "wx/dataobj.h"
  24 #include "wx/cursor.h"
  25
  26 //-------------------------------------------------------------------------
  27 // classes
  28 //-------------------------------------------------------------------------
  29
  30 class WXDLLEXPORT wxWindow;
  31
  32 class WXDLLEXPORT wxDropTarget;
  33 class WXDLLEXPORT wxTextDropTarget;
  34 class WXDLLEXPORT wxFileDropTarget;
  35
  36 class WXDLLEXPORT wxDropSource;
  37
  38 // ----------------------------------------------------------------------------
  39 // macros
  40 // ----------------------------------------------------------------------------
  41
  42 // this macro may be used instead for wxDropSource ctor arguments: it will use
  43 // the icon 'name' from an XPM file under GTK, but will expand to something
  44 // else under MSW. If you don't use it, you will have to use #ifdef in the
  45 // application code.
  46 #define wxDROP_ICON(X)   wxCursor( (const char**) X##_xpm )
  47
  48 //-------------------------------------------------------------------------
  49 // wxDropTarget
  50 //-------------------------------------------------------------------------
  51
  52 class WXDLLEXPORT wxDropTarget: public wxDropTargetBase
  53 {
  54   public:
  55
  56     wxDropTarget(wxDataObject *dataObject = (wxDataObject*) NULL );
  57
  58     virtual wxDragResult OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
  59     virtual bool OnDrop(wxCoord x, wxCoord y);
  60     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
  61     virtual bool GetData();
  62
  63     bool CurrentDragHasSupportedFormat() ;
  64     void SetCurrentDrag( void* drag ) { m_currentDrag = drag ; }
  65     void* GetCurrentDrag() { return m_currentDrag ; }
  66   protected :
  67     void* m_currentDrag ;
  68 };
  69
  70 //-------------------------------------------------------------------------
  71 // wxDropSource
  72 //-------------------------------------------------------------------------
  73
  74 class WXDLLEXPORT wxDropSource: public wxDropSourceBase
  75 {
  76 public:
  77     // ctors: if you use default ctor you must call SetData() later!
  78     //
  79     // NB: the "wxWindow *win" parameter is unused and is here only for wxGTK
  80     //     compatibility, as well as both icon parameters
  81     wxDropSource( wxWindow *win = (wxWindow *)NULL,
  82                  const wxCursor &cursorCopy = wxNullCursor,
  83                  const wxCursor &cursorMove = wxNullCursor,
  84                  const wxCursor &cursorStop = wxNullCursor);
  85
  86     /* constructor for setting one data object */
  87     wxDropSource( wxDataObject& data,
  88                   wxWindow *win,
  89                  const wxCursor &cursorCopy = wxNullCursor,
  90                  const wxCursor &cursorMove = wxNullCursor,
  91                  const wxCursor &cursorStop = wxNullCursor);
  92
  93     ~wxDropSource();
  94
  95     // do it (call this in response to a mouse button press, for example)
  96     // params: if bAllowMove is false, data can be only copied
  97     virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly);
  98
  99     wxWindow*     GetWindow() { return m_window ; }
 100     void SetCurrentDrag( void* drag ) { m_currentDrag = drag ; }
 101     void* GetCurrentDrag() { return m_currentDrag ; }
 102         bool                    MacInstallDefaultCursor(wxDragResult effect) ;
 103   protected :
 104
 105     wxWindow        *m_window;
 106     void* m_currentDrag ;
 107 };
 108
 109 #endif
 110       // D&D
 111
 112 #endif
 113        //_WX_DND_H_
 114