1. wxTimer::Start() returns bool in wxGTK too (other minor corrections

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

diff --git a/include/wx/gtk/dnd.h b/include/wx/gtk/dnd.h
index 45bf0cf2f6c34b8331ff2998fa360321a3ec92c3..962161ea94f42f41987591639da275c43d019272 100644 (file)
--- a/include/wx/gtk/dnd.h
+++ b/include/wx/gtk/dnd.h
@@ -26,29 +26,145 @@
 
 class wxWindow;
 
 
 class wxWindow;
 

+class wxDataObject;
+class wxTextDataObject;
+class wxFileDataObject;
+

 class wxDropTarget;
 class wxTextDropTarget;
 class wxDropTarget;
 class wxTextDropTarget;

-class wxDragSource;
-class wxTextDragSource;
+class wxFileDropTarget;
+
+class wxDropSource;
+
+//-------------------------------------------------------------------------
+// wxDataObject
+//-------------------------------------------------------------------------
+
+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
+{
+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()); }
+
+private:
+  wxString  m_strText;
+  
+};

 
 

+// ----------------------------------------------------------------------------
+// wxFileDataObject is a specialization of wxDataObject for file names
+// ----------------------------------------------------------------------------
+
+class wxFileDataObject : public wxDataObject
+{
+public:
+
+  wxFileDataObject(void) { }
+  void AddFile( const wxString &file )
+    { m_files += file; m_files += ";"; }
+
+  // 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() + 1; } // +1 for trailing '\0'of course
+  virtual void GetDataHere(void *pBuf) const
+    { memcpy(pBuf, m_files.c_str(), GetDataSize()); }
+
+private:
+  wxString  m_files;
+  
+};

 //-------------------------------------------------------------------------
 // wxDropTarget
 //-------------------------------------------------------------------------
 
 //-------------------------------------------------------------------------
 // wxDropTarget
 //-------------------------------------------------------------------------
 

-class wxDropTarget: wxObject
+class wxDropTarget: public wxObject

 {
   public:
 
     wxDropTarget();
     ~wxDropTarget();
 {
   public:
 
     wxDropTarget();
     ~wxDropTarget();

+    

     virtual void OnEnter() { }
     virtual void OnLeave() { }
     virtual bool OnDrop( long x, long y, const void *pData ) = 0;
 
     virtual void OnEnter() { }
     virtual void OnLeave() { }
     virtual bool OnDrop( long x, long y, const void *pData ) = 0;
 

-  public:
-
+//  protected:
+      
+    friend wxWindow;
+    
+    // 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( GdkEvent *event, int x, int y );
     void Drop( GdkEvent *event, int x, int y );

-    virtual void RegisterWidget( GtkWidget *widget ) = 0;
+    void RegisterWidget( GtkWidget *widget );

     void UnregisterWidget( GtkWidget *widget );
 };
 
     void UnregisterWidget( GtkWidget *widget );
 };
 


@@ -63,52 +179,74 @@ class wxTextDropTarget: public wxDropTarget
     wxTextDropTarget() {};
     virtual bool OnDrop( long x, long y, const void *pData );
     virtual bool OnDropText( long x, long y, const char *psz );
     wxTextDropTarget() {};
     virtual bool OnDrop( long x, long y, const void *pData );
     virtual bool OnDropText( long x, long y, const char *psz );

-    virtual void RegisterWidget( GtkWidget *widget );
+    
+  protected:
+  
+    virtual size_t GetFormatCount() const;
+    virtual wxDataFormat GetFormat(size_t n) const;

 };
 
 };
 

-//-------------------------------------------------------------------------
-// wxDragSource
-//-------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// A drop target which accepts files (dragged from File Manager or Explorer)
+// ----------------------------------------------------------------------------

 
 

-class wxDragSource: public wxObject
+class wxFileDropTarget: public wxDropTarget

 {
   public:
 {
   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[]);

 
 

-    wxDragSource( wxWindow *win );
-    ~wxDragSource(void);
-    void SetData( char *data, const long size );
-    void Start( int x, int y );
-
-  public:
-
-    void ConnectWindow(void);
-    void UnconnectWindow(void);
-    virtual void RegisterWindow(void) = 0;
-    void UnregisterWindow(void);
+  protected:

   
   

-    GtkWidget   *m_widget;
-    wxWindow    *m_window;
-    char        *m_data;
-    long         m_size;
-    wxCursor     m_defaultCursor;
-    wxCursor     m_goaheadCursor;
+    virtual size_t GetFormatCount() const;
+    virtual wxDataFormat GetFormat(size_t n) const;

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

-// wxTextDragSource
+// wxDropSource

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

-class wxTextDragSource: public wxDragSource
+  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:
 
 {
   public:
 

-    wxTextDragSource( wxWindow *win ) : wxDragSource(win) {};
-    void SetTextData( const wxString &text );
-    void RegisterWindow(void);
+    wxDropSource( wxWindow *win );
+    wxDropSource( wxDataObject &data, wxWindow *win );

     
     

-  private:
+    ~wxDropSource(void);
+    
+    void SetData( wxDataObject &data  );
+    wxDragResult DoDragDrop( bool bAllowMove = FALSE );
+    
+    virtual bool GiveFeedback( wxDragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; };
+
+  protected:

   
   

-    wxString m_tmp;
+    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  
 };
 
 #endif