]> git.saurik.com Git - wxWidgets.git/blob - include/wx/gtk/dnd.h
fixing overrelease and out-of-bounds write, fixes #13725
[wxWidgets.git] / include / wx / gtk / dnd.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/gtk/dnd.h
3 // Purpose: declaration of the wxDropTarget class
4 // Author: Robert Roebling
5 // RCS-ID: $Id$
6 // Copyright: (c) 1998 Vadim Zeitlin, Robert Roebling
7 // Licence: wxWindows licence
8 ///////////////////////////////////////////////////////////////////////////////
9
10 #ifndef _WX_GTK_DND_H_
11 #define _WX_GTK_DND_H_
12
13 #include "wx/icon.h"
14
15 // ----------------------------------------------------------------------------
16 // macros
17 // ----------------------------------------------------------------------------
18
19 // this macro may be used instead for wxDropSource ctor arguments: it will use
20 // the icon 'name' from an XPM file under GTK, but will expand to something
21 // else under MSW. If you don't use it, you will have to use #ifdef in the
22 // application code.
23 #define wxDROP_ICON(name) wxICON(name)
24
25 //-------------------------------------------------------------------------
26 // wxDropTarget
27 //-------------------------------------------------------------------------
28
29 class WXDLLIMPEXP_CORE wxDropTarget: public wxDropTargetBase
30 {
31 public:
32 wxDropTarget(wxDataObject *dataObject = NULL );
33
34 virtual wxDragResult OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
35 virtual bool OnDrop(wxCoord x, wxCoord y);
36 virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
37 virtual bool GetData();
38
39 // Can only be called during OnXXX methods.
40 wxDataFormat GetMatchingPair();
41
42 // implementation
43
44 GdkAtom GTKGetMatchingPair(bool quiet = false);
45 wxDragResult GTKFigureOutSuggestedAction();
46
47 void GtkRegisterWidget( GtkWidget *widget );
48 void GtkUnregisterWidget( GtkWidget *widget );
49
50 GdkDragContext *m_dragContext;
51 GtkWidget *m_dragWidget;
52 GtkSelectionData *m_dragData;
53 unsigned m_dragTime;
54 bool m_firstMotion; // gdk has no "gdk_drag_enter" event
55
56 void GTKSetDragContext( GdkDragContext *dc ) { m_dragContext = dc; }
57 void GTKSetDragWidget( GtkWidget *w ) { m_dragWidget = w; }
58 void GTKSetDragData( GtkSelectionData *sd ) { m_dragData = sd; }
59 void GTKSetDragTime(unsigned time) { m_dragTime = time; }
60 };
61
62 //-------------------------------------------------------------------------
63 // wxDropSource
64 //-------------------------------------------------------------------------
65
66 class WXDLLIMPEXP_CORE wxDropSource: public wxDropSourceBase
67 {
68 public:
69 // constructor. set data later with SetData()
70 wxDropSource( wxWindow *win = NULL,
71 const wxIcon &copy = wxNullIcon,
72 const wxIcon &move = wxNullIcon,
73 const wxIcon &none = wxNullIcon);
74
75 // constructor for setting one data object
76 wxDropSource( wxDataObject& data,
77 wxWindow *win,
78 const wxIcon &copy = wxNullIcon,
79 const wxIcon &move = wxNullIcon,
80 const wxIcon &none = wxNullIcon);
81
82 virtual ~wxDropSource();
83
84 // set the icon corresponding to given drag result
85 void SetIcon(wxDragResult res, const wxIcon& icon)
86 {
87 if ( res == wxDragCopy )
88 m_iconCopy = icon;
89 else if ( res == wxDragMove )
90 m_iconMove = icon;
91 else
92 m_iconNone = icon;
93 }
94
95 // start drag action
96 virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly);
97
98 void PrepareIcon( int action, GdkDragContext *context );
99
100 GtkWidget *m_widget;
101 GtkWidget *m_iconWindow;
102 GdkDragContext *m_dragContext;
103 wxWindow *m_window;
104
105 wxDragResult m_retValue;
106 wxIcon m_iconCopy,
107 m_iconMove,
108 m_iconNone;
109
110 bool m_waiting;
111
112 private:
113 // common part of both ctors
114 void SetIcons(const wxIcon& copy,
115 const wxIcon& move,
116 const wxIcon& none);
117
118 // GTK implementation
119 void GTKConnectDragSignals();
120 void GTKDisconnectDragSignals();
121
122 };
123
124 #endif // _WX_GTK_DND_H_
125