Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / gtk / dnd.h

diff --git a/include/wx/gtk/dnd.h b/include/wx/gtk/dnd.h
index 003c0150743d530555eac8d17c97db8cda5c8f02..c9f677d3c7488e0cea2075185793c262d3d45f24 100644 (file)
--- a/include/wx/gtk/dnd.h
+++ b/include/wx/gtk/dnd.h
@@ -1,40 +1,16 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        dnd.h
+// Name:        wx/gtk/dnd.h
 // Purpose:     declaration of the wxDropTarget class
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin, Robert Roebling
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
+#ifndef _WX_GTK_DND_H_
+#define _WX_GTK_DND_H_
 
-#ifndef __GTKDNDH__
-#define __GTKDNDH__
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface
-#endif
-
-#if wxUSE_DRAG_AND_DROP
-
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/dataobj.h"
-#include "wx/cursor.h"
 #include "wx/icon.h"
-#include "wx/gdicmn.h"
-
-//-------------------------------------------------------------------------
-// classes
-//-------------------------------------------------------------------------
-
-class wxWindow;
-
-class wxDropTarget;
-class wxTextDropTarget;
-class wxFileDropTarget;
-
-class wxDropSource;
 
 // ----------------------------------------------------------------------------
 // macros
@@ -50,44 +26,48 @@ class wxDropSource;
 // wxDropTarget
 //-------------------------------------------------------------------------
 
-class wxDropTarget: public wxDropTargetBase
+class WXDLLIMPEXP_CORE wxDropTarget: public wxDropTargetBase
 {
 public:
-    wxDropTarget(wxDataObject *dataObject = (wxDataObject*) NULL );
+    wxDropTarget(wxDataObject *dataObject = NULL );
 
     virtual wxDragResult OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
     virtual bool OnDrop(wxCoord x, wxCoord y);
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
     virtual bool GetData();
 
-  // implementation
+    // Can only be called during OnXXX methods.
+    wxDataFormat GetMatchingPair();
 
-    GdkAtom GetMatchingPair();
+    // implementation
 
-    void RegisterWidget( GtkWidget *widget );
-    void UnregisterWidget( GtkWidget *widget );
+    GdkAtom GTKGetMatchingPair(bool quiet = false);
+    wxDragResult GTKFigureOutSuggestedAction();
+
+    void GtkRegisterWidget( GtkWidget *widget );
+    void GtkUnregisterWidget( GtkWidget *widget );
 
     GdkDragContext     *m_dragContext;
     GtkWidget          *m_dragWidget;
     GtkSelectionData   *m_dragData;
-    guint               m_dragTime;
+    unsigned            m_dragTime;
     bool                m_firstMotion;     // gdk has no "gdk_drag_enter" event
 
-    void SetDragContext( GdkDragContext *dc ) { m_dragContext = dc; }
-    void SetDragWidget( GtkWidget *w ) { m_dragWidget = w; }
-    void SetDragData( GtkSelectionData *sd ) { m_dragData = sd; }
-    void SetDragTime( guint time ) { m_dragTime = time; }
+    void GTKSetDragContext( GdkDragContext *dc ) { m_dragContext = dc; }
+    void GTKSetDragWidget( GtkWidget *w ) { m_dragWidget = w; }
+    void GTKSetDragData( GtkSelectionData *sd ) { m_dragData = sd; }
+    void GTKSetDragTime(unsigned time) { m_dragTime = time; }
 };
 
 //-------------------------------------------------------------------------
 // wxDropSource
 //-------------------------------------------------------------------------
 
-class wxDropSource: public wxDropSourceBase
+class WXDLLIMPEXP_CORE wxDropSource: public wxDropSourceBase
 {
 public:
     // constructor. set data later with SetData()
-    wxDropSource( wxWindow *win = (wxWindow *)NULL,
+    wxDropSource( wxWindow *win = NULL,
                   const wxIcon &copy = wxNullIcon,
                   const wxIcon &move = wxNullIcon,
                   const wxIcon &none = wxNullIcon);
@@ -101,13 +81,20 @@ public:
 
     virtual ~wxDropSource();
 
+    // set the icon corresponding to given drag result
+    void SetIcon(wxDragResult res, const wxIcon& icon)
+    {
+        if ( res == wxDragCopy )
+            m_iconCopy = icon;
+        else if ( res == wxDragMove )
+            m_iconMove = icon;
+        else
+            m_iconNone = icon;
+    }
+
     // start drag action
     virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly);
 
-    // GTK implementation
-    void RegisterWindow();
-    void UnregisterWindow();
-
     void PrepareIcon( int action, GdkDragContext *context );
 
     GtkWidget       *m_widget;
@@ -127,9 +114,12 @@ private:
     void SetIcons(const wxIcon& copy,
                   const wxIcon& move,
                   const wxIcon& none);
-};
 
-#endif // wxUSE_DRAG_AND_DROP
+    // GTK implementation
+    void GTKConnectDragSignals();
+    void GTKDisconnectDragSignals();
+
+};
 
-#endif //__GTKDNDH__
+#endif // _WX_GTK_DND_H_