]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/gtk1/dnd.h
Unicode definitions for glibc, etc.
[wxWidgets.git] / include / wx / gtk1 / dnd.h
index e10c9e7c764868d31b179d6191a95d6ccffababf..3c918bad235bb5a96561c25308e5eca8a0b5597a 100644 (file)
 #endif
 
 #include "wx/defs.h"
+
+#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 wxDataObject;
-class wxTextDataObject;
-class wxFileDataObject;
-
 class wxDropTarget;
 class wxTextDropTarget;
 class wxFileDropTarget;
+class wxPrivateDropTarget;
 
 class wxDropSource;
 
 //-------------------------------------------------------------------------
-// wxDataObject
+// wxDropSource
 //-------------------------------------------------------------------------
 
-class wxDataObject: public wxObject
+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 (MSW only)
+  wxDragCancel    // the operation was cancelled by user (not an error)
+};
+
+class wxDropSource: public wxObject
 {
 public:
 
-  wxDataObject() {};
-  ~wxDataObject() {};
+  /* constructor. set data later with SetData() */
+  wxDropSource( wxWindow *win, const wxIcon &go = wxNullIcon, const wxIcon &stop = wxNullIcon );
+    
+  /* constructor for setting one data object */
+  wxDropSource( wxDataObject *data, wxWindow *win, const wxIcon &go = wxNullIcon, const wxIcon &stop = wxNullIcon );
+    
+  /* constructor for setting several data objects via wxDataBroker */
+  wxDropSource( wxDataBroker *data, wxWindow *win );
 
-  virtual wxDataFormat GetPreferredFormat() const = 0;
-  virtual bool IsSupportedFormat( wxDataFormat format ) const = 0;
-  virtual size_t GetDataSize() const = 0;
-  virtual void GetDataHere( void *data ) const = 0;
+  ~wxDropSource();
+    
+  /* set several dataobjects via wxDataBroker */
+  void SetData( wxDataBroker *data );
+
+  /* set one dataobject */
+  void SetData( wxDataObject *data );
 
+  /* start drag action */
+  wxDragResult DoDragDrop( bool bAllowMove = FALSE );
+    
+  /* override to give feedback */
+  virtual bool GiveFeedback( wxDragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; }
+  
+  /* GTK implementation */
+      
+  void RegisterWindow();
+  void UnregisterWindow();
+  
+    GtkWidget     *m_widget;
+    wxWindow      *m_window;
+    wxDragResult   m_retValue;
+    wxDataBroker  *m_data;
+    
+    wxCursor      m_defaultCursor;
+    wxCursor      m_goaheadCursor;
+    
+    wxIcon        m_goIcon;
+    wxIcon        m_stopIcon;
 };
 
-// ----------------------------------------------------------------------------
-// wxTextDataObject is a specialization of wxDataObject for text data
-// ----------------------------------------------------------------------------
+#include "gtk/gtk.h"
+#if (GTK_MINOR_VERSION > 0)
+
+//-------------------------------------------------------------------------
+// wxDropTarget
+//-------------------------------------------------------------------------
 
-class wxTextDataObject : public wxDataObject
+class wxDropTarget: public wxObject
 {
 public:
 
-  wxTextDataObject() { }
-  wxTextDataObject(const wxString& strText) : m_strText(strText) { }
-  void Init(const wxString& strText) { m_strText = strText; }
-
-  virtual wxDataFormat GetPreferredFormat() const
-    { return wxDF_TEXT; }
+  wxDropTarget();
+  ~wxDropTarget();
     
-  virtual bool IsSupportedFormat(wxDataFormat format) const
-    { return format == wxDF_TEXT; }
-
-  virtual size_t GetDataSize() const
-    { return m_strText.Len() + 1; } // +1 for trailing '\0'
+  /* may be overridden to react to events */
+  virtual void OnEnter();
+  virtual void OnLeave();
+  virtual bool OnMove( int x, int y );
     
-  virtual void GetDataHere( void *data ) const
-    { memcpy(data, m_strText.c_str(), GetDataSize()); }
+  /* has te be overridden to get data */
+  virtual bool OnDrop( int x, int y );
 
-private:
-  wxString  m_strText;
+  /* called to query formats available */
+  bool IsSupported( wxDataFormat format );
   
+  /* fill data with data on the clipboard (if available) */
+  bool GetData( wxDataObject *data );
+
+// implementation
+  
+  void RegisterWidget( GtkWidget *widget );
+  void UnregisterWidget( GtkWidget *widget );
+    
+  GdkDragContext *m_dragContext;
+    
+  void SetDragContext( GdkDragContext *dc ) { m_dragContext = dc; }
+  GdkDragContext *GetDragContext() { return m_dragContext; }
 };
 
-// ----------------------------------------------------------------------------
-// wxFileDataObject is a specialization of wxDataObject for file names
-// ----------------------------------------------------------------------------
+//-------------------------------------------------------------------------
+// wxTextDropTarget
+//-------------------------------------------------------------------------
 
-class wxFileDataObject : public wxDataObject
+class wxTextDropTarget: public wxDropTarget
 {
 public:
 
-  wxFileDataObject(void) { }
-  void AddFile( const wxString &file )
-    { m_files += file; m_files += '\0'; }
+  wxTextDropTarget() {}
 
-  virtual wxDataFormat GetPreferredFormat() const
-    { return wxDF_FILENAME; }
+  virtual bool OnMove( int x, int y );
+  virtual bool OnDrop( int x, int y );
     
-  virtual bool IsSupportedFormat( wxDataFormat format ) const
-    { return format == wxDF_FILENAME; }
+  /* you have to override OnDropData to get at the text */
+  virtual bool OnDropText( int x, int y, const char *text ) = 0;
     
-  virtual size_t GetDataSize() const
-    { return m_files.Len(); } // no trailing '\0'
-    
-  virtual void GetDataHere( void *data ) const
-    { memcpy(data, m_files.c_str(), GetDataSize()); }
+};
+
+//-------------------------------------------------------------------------
+// wxPrivateDropTarget
+//-------------------------------------------------------------------------
+
+class wxPrivateDropTarget: public wxDropTarget
+{
+public:
 
+  /* sets id to "application/myprogram" where "myprogram" is the
+     same as wxApp->GetAppName() */
+  wxPrivateDropTarget();
+  /* see SetId() below for explanation */
+  wxPrivateDropTarget( const wxString &id );
+  
+  virtual bool OnMove( int x, int y );
+  virtual bool OnDrop( int x, int y );
+  
+  /* you have to override OnDropData to get at the data */
+  virtual bool OnDropData( int x, int y, void *data, size_t size ) = 0;
+    
+  /* the string ID identifies the format of clipboard or DnD data. a word
+     processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
+     to the clipboard - the latter with the Id "application/wxword" or
+     "image/png". */
+  void SetId( const wxString& id ) { m_id = id; }
+  wxString GetId() { return m_id; }
+      
 private:
-  wxString  m_files;
+
+    wxString   m_id;
+};
+
+//----------------------------------------------------------------------------
+// A drop target which accepts files (dragged from File Manager or Explorer)
+//----------------------------------------------------------------------------
+
+class wxFileDropTarget: public wxDropTarget
+{
+public:
+    
+  wxFileDropTarget() {}
+    
+  virtual bool OnMove( int x, int y );
+  virtual bool OnDrop( int x, int y );
   
+  /* you have to override OnDropFiles to get at the file names */
+  virtual bool OnDropFiles( int x, int y, size_t nFiles, const char * const aszFiles[] ) = 0;
+
 };
+
+#else
+
 //-------------------------------------------------------------------------
 // wxDropTarget
 //-------------------------------------------------------------------------
@@ -124,17 +218,20 @@ class wxDropTarget: public wxObject
     
     virtual void OnEnter() { }
     virtual void OnLeave() { }
+    virtual void OnMouseMove( long WXUNUSED(x), long WXUNUSED(y) ) { }
     virtual bool OnDrop( long x, long y, const void *data, size_t size ) = 0;
 
     // Override these to indicate what kind of data you support: 
   
     virtual size_t GetFormatCount() const = 0;
-    virtual wxDataFormat GetFormat(size_t n) const = 0;
+    virtual wxDataFormat &GetFormat(size_t n) const;
   
   // implementation
   
     void RegisterWidget( GtkWidget *widget );
     void UnregisterWidget( GtkWidget *widget );
+    
+    wxDataFormat  *m_format;
 };
 
 //-------------------------------------------------------------------------
@@ -145,25 +242,53 @@ class wxTextDropTarget: public wxDropTarget
 {
   public:
 
-    wxTextDropTarget() {};
+    wxTextDropTarget();
     virtual bool OnDrop( long x, long y, const void *data, size_t size );
     virtual bool OnDropText( long x, long y, const char *psz );
     
   protected:
   
     virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;
 };
 
-// ----------------------------------------------------------------------------
+//-------------------------------------------------------------------------
+// wxPrivateDropTarget
+//-------------------------------------------------------------------------
+
+class wxPrivateDropTarget: public wxDropTarget
+{
+public:
+
+  wxPrivateDropTarget();
+  
+  // you have to override OnDrop to get at the data
+    
+  // the string ID identifies the format of clipboard or DnD data. a word
+  // processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
+  // to the clipboard - the latter with the Id "application/wxword" or
+  // "image/png".
+    
+  void SetId( const wxString& id );
+    
+  wxString GetId()
+      { return m_id; }
+
+private:
+
+  virtual size_t GetFormatCount() const;
+    
+  wxString   m_id;
+};
+
+//----------------------------------------------------------------------------
 // A drop target which accepts files (dragged from File Manager or Explorer)
-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------
 
 class wxFileDropTarget: public wxDropTarget
 {
   public:
     
-    wxFileDropTarget() {};
+    wxFileDropTarget();
     
     virtual bool OnDrop( long x, long y, const void *data, size_t size );
     virtual bool OnDropFiles( long x, long y, 
@@ -172,49 +297,14 @@ class wxFileDropTarget: public wxDropTarget
   protected:
   
     virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;
 };
 
-//-------------------------------------------------------------------------
-// wxDropSource
-//-------------------------------------------------------------------------
+#endif
 
-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)
-};
 
-class wxDropSource: public wxObject
-{
-  public:
+#endif
 
-    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; };
-  
-  // implementation
-      
-    void RegisterWindow(void);
-    void UnregisterWindow(void);
-  
-    GtkWidget     *m_widget;
-    wxWindow      *m_window;
-    wxDragResult   m_retValue;
-    wxDataObject  *m_data;
-    
-    wxCursor      m_defaultCursor;
-    wxCursor      m_goaheadCursor;
-};
+   // wxUSE_DRAG_AND_DROP
 
 #endif  
        //__GTKDNDH__