X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fed46e722a84470b223af674ccf3d4a7f57d17ab..e46286351dbfa7ae98e8341e4fc328b134601e87:/include/wx/gtk/dnd.h?ds=sidebyside diff --git a/include/wx/gtk/dnd.h b/include/wx/gtk/dnd.h index 937fe1aa89..2dba9cef49 100644 --- a/include/wx/gtk/dnd.h +++ b/include/wx/gtk/dnd.h @@ -16,19 +16,15 @@ #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" - -//------------------------------------------------------------------------- -// conditional compilation -//------------------------------------------------------------------------- - -#if (GTK_MINOR_VERSION == 1) -#if (GTK_MICRO_VERSION >= 3) -#define NEW_GTK_DND_CODE -#endif -#endif +#include "wx/icon.h" +#include "wx/gdicmn.h" //------------------------------------------------------------------------- // classes @@ -36,153 +32,139 @@ class wxWindow; -class wxDataObject; -class wxTextDataObject; -class wxFileDataObject; - class wxDropTarget; class wxTextDropTarget; class wxFileDropTarget; +class wxPrivateDropTarget; class wxDropSource; //------------------------------------------------------------------------- -// wxDataObject +// wxDropTarget //------------------------------------------------------------------------- -class wxDataObject: public wxObject -{ -public: - - wxDataObject() {}; - ~wxDataObject() {}; - - 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; - -}; - -// ---------------------------------------------------------------------------- -// wxTextDataObject is a specialization of wxDataObject for text data -// ---------------------------------------------------------------------------- - -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(); + + /* may be overridden to reject certain formats or drops + on certain areas. always returns TRUE by default + indicating that you'd accept the data from the drag. */ + virtual bool OnMove( long x, long y ); - virtual void GetDataHere( void *data ) const - { memcpy(data, m_strText.c_str(), GetDataSize()); } - -private: - wxString m_strText; + /* has to be overridden to accept a drop event. call + IsSupported() to ask which formats are available + and then call RequestData() to indicate the format + you request. */ + virtual bool OnDrop( long x, long y ); -}; + /* this gets called once the data has actually arrived. get + it with GetData(). this has to be overridden. */ + virtual bool OnData( long x, long y ); -// ---------------------------------------------------------------------------- -// wxFileDataObject is a specialization of wxDataObject for file names -// ---------------------------------------------------------------------------- + /* called from within OnDrop() to request a certain format + from the drop event. */ + bool RequestData( wxDataFormat format ); -class wxFileDataObject : public wxDataObject -{ -public: - - wxFileDataObject(void) { } - void AddFile( const wxString &file ) - { m_files += file; m_files += '\0'; } + /* called to query what formats are available */ + bool IsSupported( wxDataFormat format ); + + /* fill data with data from the dragging source */ + bool GetData( wxDataObject *data ); - virtual wxDataFormat GetPreferredFormat() const - { return wxDF_FILENAME; } - - virtual bool IsSupportedFormat( wxDataFormat format ) const - { return format == wxDF_FILENAME; } +// implementation + + void RegisterWidget( GtkWidget *widget ); + void UnregisterWidget( GtkWidget *widget ); - virtual size_t GetDataSize() const - { return m_files.Len(); } // no trailing '\0' + GdkDragContext *m_dragContext; + GtkWidget *m_dragWidget; + GtkSelectionData *m_dragData; + guint m_dragTime; + bool m_firstMotion; /* gdk has no "gdk_drag_enter" event */ - virtual void GetDataHere( void *data ) const - { memcpy(data, m_files.c_str(), GetDataSize()); } - -private: - wxString m_files; - + 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; } }; + //------------------------------------------------------------------------- -// wxDropTarget +// wxTextDropTarget //------------------------------------------------------------------------- -class wxDropTarget: public wxObject +class wxTextDropTarget: public wxDropTarget { - public: +public: - wxDropTarget(); - ~wxDropTarget(); - - virtual void OnEnter() { } - virtual void OnLeave() { } - virtual bool OnDrop( long x, long y, const void *data, size_t size ) = 0; + wxTextDropTarget() {} - // Override these to indicate what kind of data you support: - - virtual size_t GetFormatCount() const = 0; - virtual wxDataFormat GetFormat(size_t n) const = 0; - - // implementation - - void RegisterWidget( GtkWidget *widget ); - void UnregisterWidget( GtkWidget *widget ); + virtual bool OnMove( long x, long y ); + virtual bool OnDrop( long x, long y ); + virtual bool OnData( long x, long y ); + + /* you have to override OnDropData to get at the text */ + virtual bool OnDropText( long x, long y, const wxChar *text ) = 0; + }; //------------------------------------------------------------------------- -// wxTextDropTarget +// wxPrivateDropTarget //------------------------------------------------------------------------- -class wxTextDropTarget: public wxDropTarget +class wxPrivateDropTarget: public wxDropTarget { - public: +public: - 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: + /* 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( long x, long y ); + virtual bool OnDrop( long x, long y ); + virtual bool OnData( long x, long y ); - virtual size_t GetFormatCount() const; - virtual wxDataFormat GetFormat(size_t n) const; + /* you have to override OnDropData to get at the data */ + virtual bool OnDropData( long x, long 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_id; }; -// ---------------------------------------------------------------------------- +//---------------------------------------------------------------------------- // A drop target which accepts files (dragged from File Manager or Explorer) -// ---------------------------------------------------------------------------- +//---------------------------------------------------------------------------- class wxFileDropTarget: public wxDropTarget { - public: +public: - wxFileDropTarget() {}; + wxFileDropTarget() {} - virtual bool OnDrop( long x, long y, const void *data, size_t size ); - virtual bool OnDropFiles( long x, long y, - size_t nFiles, const char * const aszFiles[] ); - - protected: + virtual bool OnMove( long x, long y ); + virtual bool OnDrop( long x, long y ); + virtual bool OnData( long x, long y ); - virtual size_t GetFormatCount() const; - virtual wxDataFormat GetFormat(size_t n) const; + /* you have to override OnDropFiles to get at the file names */ + virtual bool OnDropFiles( long x, long y, size_t nFiles, const wxChar * const aszFiles[] ) = 0; + }; //------------------------------------------------------------------------- @@ -194,38 +176,60 @@ 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 + wxDragMove, // the data was successfully moved (MSW only) wxDragCancel // the operation was cancelled by user (not an error) }; class wxDropSource: public wxObject { - public: +public: - wxDropSource( wxWindow *win ); - wxDropSource( wxDataObject &data, wxWindow *win ); + /* constructor. set data later with SetData() */ + wxDropSource( wxWindow *win, const wxIcon &go = wxNullIcon, const wxIcon &stop = wxNullIcon ); - ~wxDropSource(void); + /* constructor for setting one data object */ + wxDropSource( wxDataObject *data, wxWindow *win, const wxIcon &go = wxNullIcon, const wxIcon &stop = wxNullIcon ); - void SetData( wxDataObject &data ); - wxDragResult DoDragDrop( bool bAllowMove = FALSE ); + /* constructor for setting several data objects via wxDataBroker */ + wxDropSource( wxDataBroker *data, wxWindow *win ); + + ~wxDropSource(); - virtual bool GiveFeedback( wxDragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; }; + /* 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; } - // implementation + /* GTK implementation */ - void RegisterWindow(void); - void UnregisterWindow(void); + void RegisterWindow(); + void UnregisterWindow(); GtkWidget *m_widget; wxWindow *m_window; wxDragResult m_retValue; - wxDataObject *m_data; + wxDataBroker *m_data; wxCursor m_defaultCursor; wxCursor m_goaheadCursor; + + wxIcon m_goIcon; + wxIcon m_stopIcon; + + bool m_waiting; }; +#endif + + // wxUSE_DRAG_AND_DROP + #endif //__GTKDNDH__