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 7f72906e4713b81f5af4154c8a340cf3793127b8..c9f677d3c7488e0cea2075185793c262d3d45f24 100644 (file)
--- a/include/wx/gtk/dnd.h
+++ b/include/wx/gtk/dnd.h
@@ -1,254 +1,125 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        dnd.h
+// Name:        wx/gtk/dnd.h

 // Purpose:     declaration of the wxDropTarget class
 // Author:      Robert Roebling
 // Purpose:     declaration of the wxDropTarget class
 // Author:      Robert Roebling

-// RCS-ID:      
+// RCS-ID:      $Id$

 // Copyright:   (c) 1998 Vadim Zeitlin, Robert Roebling
 // Copyright:   (c) 1998 Vadim Zeitlin, Robert Roebling

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 ///////////////////////////////////////////////////////////////////////////////
 

+#ifndef _WX_GTK_DND_H_
+#define _WX_GTK_DND_H_

 
 

-#ifndef __GTKDNDH__
-#define __GTKDNDH__
+#include "wx/icon.h"

 
 

-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/cursor.h"
-
-//-------------------------------------------------------------------------
-// classes
-//-------------------------------------------------------------------------
-
-class wxWindow;
-
-class wxDataObject;
-class wxTextDataObject;
-class wxFileDataObject;
-
-class wxDropTarget;
-class wxTextDropTarget;
-class wxFileDropTarget;
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------

 
 

-class wxDropSource;
+// this macro may be used instead for wxDropSource ctor arguments: it will use
+// the icon 'name' from an XPM file under GTK, but will expand to something
+// else under MSW. If you don't use it, you will have to use #ifdef in the
+// application code.
+#define wxDROP_ICON(name)   wxICON(name)

 
 //-------------------------------------------------------------------------
 
 //-------------------------------------------------------------------------

-// wxDataObject
+// wxDropTarget

 //-------------------------------------------------------------------------
 
 //-------------------------------------------------------------------------
 

-class wxDataObject: public wxObject
-{
-public:
-  // all data formats (values are the same as in windows.h, do not change!)
-  enum StdFormat
-  {
-    Invalid,
-    Text,
-    Bitmap,
-    MetafilePict,
-    Sylk,
-    Dif,
-    Tiff,
-    OemText,
-    Dib,
-    Palette,
-    Pendata,
-    Riff,
-    Wave,
-    UnicodeText,
-    EnhMetafile,
-    Hdrop,
-    Locale,
-    Max
-  };
-
-  // function to return symbolic name of clipboard format (debug messages)
-  static const char *GetFormatName(wxDataFormat format);
-
-  // ctor & dtor
-  wxDataObject() {};
-  ~wxDataObject() {};
-
-  // pure virtuals to override
-    // get the best suited format for our data
-  virtual wxDataFormat GetPreferredFormat() const = 0;
-    // decide if we support this format (should be one of values of
-    // StdFormat enumerations or a user-defined format)
-  virtual bool IsSupportedFormat(wxDataFormat format) const = 0;
-    // get the (total) size of data
-  virtual size_t GetDataSize() const = 0;
-    // copy raw data to provided pointer
-  virtual void GetDataHere(void *pBuf) const = 0;
-
-};
-
-// ----------------------------------------------------------------------------
-// wxTextDataObject is a specialization of wxDataObject for text data
-// ----------------------------------------------------------------------------
-
-class wxTextDataObject : public wxDataObject
+class WXDLLIMPEXP_CORE wxDropTarget: public wxDropTargetBase

 {
 public:
 {
 public:

-  // ctors
-  wxTextDataObject() { }
-  wxTextDataObject(const wxString& strText) : m_strText(strText) { }
-  void Init(const wxString& strText) { m_strText = strText; }
-
-  // implement base class pure virtuals
-  virtual wxDataFormat GetPreferredFormat() const
-    { return wxDF_TEXT; }
-  virtual bool IsSupportedFormat(wxDataFormat format) const
-    { return format == wxDF_TEXT; }
-  virtual size_t GetDataSize() const
-    { return m_strText.Len() + 1; } // +1 for trailing '\0'of course
-  virtual void GetDataHere(void *pBuf) const
-    { memcpy(pBuf, m_strText.c_str(), GetDataSize()); }
+    wxDropTarget(wxDataObject *dataObject = NULL );

 
 

-private:
-  wxString  m_strText;
-  
-};
+    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();

 
 

-// ----------------------------------------------------------------------------
-// wxFileDataObject is a specialization of wxDataObject for file names
-// ----------------------------------------------------------------------------
+    // Can only be called during OnXXX methods.
+    wxDataFormat GetMatchingPair();

 
 

-class wxFileDataObject : public wxDataObject
-{
-public:
+    // implementation

 
 

-  wxFileDataObject(void) { }
-  void AddFile( const wxString &file )
-    { m_files += file; m_files += '\0'; }
+    GdkAtom GTKGetMatchingPair(bool quiet = false);
+    wxDragResult GTKFigureOutSuggestedAction();

 
 

-  // implement base class pure virtuals
-  virtual wxDataFormat GetPreferredFormat() const
-    { return wxDF_FILENAME; }
-  virtual bool IsSupportedFormat(wxDataFormat format) const
-    { return format == wxDF_FILENAME; }
-  virtual size_t GetDataSize() const
-    { return m_files.Len(); } // no trailing '\0'
-  virtual void GetDataHere(void *pBuf) const
-    { memcpy(pBuf, m_files.c_str(), GetDataSize()); }
+    void GtkRegisterWidget( GtkWidget *widget );
+    void GtkUnregisterWidget( GtkWidget *widget );

 
 

-private:
-  wxString  m_files;
-  
-};
-//-------------------------------------------------------------------------
-// wxDropTarget
-//-------------------------------------------------------------------------
+    GdkDragContext     *m_dragContext;
+    GtkWidget          *m_dragWidget;
+    GtkSelectionData   *m_dragData;
+    unsigned            m_dragTime;
+    bool                m_firstMotion;     // gdk has no "gdk_drag_enter" event

 
 

-class wxDropTarget: public wxObject
-{
-  public:
-
-    wxDropTarget();
-    ~wxDropTarget();
-    
-    virtual void OnEnter() { }
-    virtual void OnLeave() { }
-    virtual bool OnDrop( long x, long y, const void *pData ) = 0;
-
-  // implementation
-      
-    int  m_size;    
-    
-    // Override these to indicate what kind of data you support: 
-  
-    virtual size_t GetFormatCount() const = 0;
-    virtual wxDataFormat GetFormat(size_t n) const = 0;
-  
-    void Drop( GdkEventDropDataAvailable *event, int x, int y );
-    void RegisterWidget( GtkWidget *widget );
-    void UnregisterWidget( GtkWidget *widget );
+    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; }

 };
 
 //-------------------------------------------------------------------------
 };
 
 //-------------------------------------------------------------------------

-// wxTextDropTarget
+// wxDropSource

 //-------------------------------------------------------------------------
 
 //-------------------------------------------------------------------------
 

-class wxTextDropTarget: public wxDropTarget
-{
-  public:
-
-    wxTextDropTarget() {};
-    virtual bool OnDrop( long x, long y, const void *pData );
-    virtual bool OnDropText( long x, long y, const char *psz );
-    
-  protected:
-  
-    virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;
-};
-
-// ----------------------------------------------------------------------------
-// A drop target which accepts files (dragged from File Manager or Explorer)
-// ----------------------------------------------------------------------------
-
-class wxFileDropTarget: public wxDropTarget
+class WXDLLIMPEXP_CORE wxDropSource: public wxDropSourceBase

 {
 {

-  public:
-    
-    wxFileDropTarget() {};
-    
-    virtual bool OnDrop(long x, long y, const void *pData);
-    virtual bool OnDropFiles( long x, long y, 
-                              size_t nFiles, const char * const aszFiles[]);
-
-  protected:
-  
-    virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;
-};
+public:
+    // constructor. set data later with SetData()
+    wxDropSource( wxWindow *win = NULL,
+                  const wxIcon &copy = wxNullIcon,
+                  const wxIcon &move = wxNullIcon,
+                  const wxIcon &none = wxNullIcon);
+
+    // constructor for setting one data object
+    wxDropSource( wxDataObject& data,
+                  wxWindow *win,
+                  const wxIcon &copy = wxNullIcon,
+                  const wxIcon &move = wxNullIcon,
+                  const wxIcon &none = wxNullIcon);
+
+    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);
+
+    void PrepareIcon( int action, GdkDragContext *context );
+
+    GtkWidget       *m_widget;
+    GtkWidget       *m_iconWindow;
+    GdkDragContext  *m_dragContext;
+    wxWindow        *m_window;
+
+    wxDragResult     m_retValue;
+    wxIcon           m_iconCopy,
+                     m_iconMove,
+                     m_iconNone;
+
+    bool             m_waiting;

 
 

-//-------------------------------------------------------------------------
-// wxDropSource
-//-------------------------------------------------------------------------
+private:
+    // common part of both ctors
+    void SetIcons(const wxIcon& copy,
+                  const wxIcon& move,
+                  const wxIcon& none);

 
 

-  enum wxDragResult
-  {
-    wxDragError,    // error prevented the d&d operation from completing
-    wxDragNone,     // drag target didn't accept the data
-    wxDragCopy,     // the data was successfully copied
-    wxDragMove,     // the data was successfully moved
-    wxDragCancel    // the operation was cancelled by user (not an error)
-  };
+    // GTK implementation
+    void GTKConnectDragSignals();
+    void GTKDisconnectDragSignals();

 
 

-class wxDropSource: public wxObject
-{
-  public:
-
-    wxDropSource( wxWindow *win );
-    wxDropSource( wxDataObject &data, wxWindow *win );
-    
-    ~wxDropSource(void);
-    
-    void SetData( wxDataObject &data  );
-    wxDragResult DoDragDrop( bool bAllowMove = FALSE );
-    
-    virtual bool GiveFeedback( wxDragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; };
-
-  protected:
-  
-    friend void gtk_drag_callback( GtkWidget *widget, GdkEvent *event, wxDropSource *source );
-  
-    void RegisterWindow(void);
-    void UnregisterWindow(void);
-  
-    GtkWidget     *m_widget;
-    wxWindow      *m_window;
-    wxDragResult   m_retValue;
-    wxDataObject  *m_data;
-    
-    wxCursor      m_defaultCursor;
-    wxCursor      m_goaheadCursor;

 };
 
 };
 

-#endif  
-       //__GTKDNDH__
+#endif // _WX_GTK_DND_H_