X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c86f1403c3737c07d58676a203f4707942684a01..d345e841da6719c3de9de784220aafafb5eb1e93:/include/wx/gtk1/dnd.h diff --git a/include/wx/gtk1/dnd.h b/include/wx/gtk1/dnd.h index fa97fdc5cd..2eccb9c9d6 100644 --- a/include/wx/gtk1/dnd.h +++ b/include/wx/gtk1/dnd.h @@ -2,7 +2,7 @@ // Name: dnd.h // Purpose: declaration of the wxDropTarget class // Author: Robert Roebling -// RCS-ID: +// RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin, Robert Roebling // Licence: wxWindows license /////////////////////////////////////////////////////////////////////////////// @@ -16,9 +16,23 @@ #endif #include "wx/defs.h" + +//------------------------------------------------------------------------- +// conditional compilation +//------------------------------------------------------------------------- + +#if (GTK_MINOR_VERSION > 0) +#define NEW_GTK_DND_CODE +#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 @@ -26,119 +40,13 @@ class wxWindow; -class wxDataObject; -class wxTextDataObject; -class wxFileDataObject; - class wxDropTarget; class wxTextDropTarget; class wxFileDropTarget; +class wxPrivateDropTarget; 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 //------------------------------------------------------------------------- @@ -152,20 +60,20 @@ class wxDropTarget: public wxObject virtual void OnEnter() { } virtual void OnLeave() { } - virtual bool OnDrop( long x, long y, const void *pData ) = 0; + virtual void OnMouseMove( long WXUNUSED(x), long WXUNUSED(y) ) { } + virtual bool OnDrop( long x, long y, const void *data, size_t size ) = 0; -// 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; + virtual wxDataFormat &GetFormat(size_t n) const; + + // implementation - void Drop( GdkEvent *event, int x, int y ); void RegisterWidget( GtkWidget *widget ); void UnregisterWidget( GtkWidget *widget ); + + wxDataFormat *m_format; }; //------------------------------------------------------------------------- @@ -176,79 +84,124 @@ class wxTextDropTarget: public wxDropTarget { public: - wxTextDropTarget() {}; - virtual bool OnDrop( long x, long y, const void *pData ); + 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 *pData); + 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[]); + size_t nFiles, const char * const aszFiles[] ); protected: virtual size_t GetFormatCount() const; - virtual wxDataFormat GetFormat(size_t n) const; }; //------------------------------------------------------------------------- // wxDropSource //------------------------------------------------------------------------- +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: - enum DragResult - { - Error, // error prevented the d&d operation from completing - None, // drag target didn't accept the data - Copy, // the data was successfully copied - Move, // the data was successfully moved - Cancel // the operation was cancelled by user (not an error) - }; - - 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 ); + + /* 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 ); ~wxDropSource(void); - void SetData( wxDataObject &data ); - DragResult DoDragDrop( bool bAllowMove = FALSE ); + /* set one dataobject */ + void SetData( wxDataBroker *data ); - virtual bool GiveFeedback( DragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; }; - - protected: - - friend void gtk_drag_callback( GtkWidget *widget, GdkEvent *event, wxDropSource *source ); + /* set severa dataobjects via wxDataBroker */ + 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); void UnregisterWindow(void); GtkWidget *m_widget; wxWindow *m_window; - DragResult m_retValue; - wxDataObject *m_data; + wxDragResult m_retValue; + wxDataBroker *m_data; wxCursor m_defaultCursor; wxCursor m_goaheadCursor; + + wxIcon m_goIcon; + wxIcon m_stopIcon; }; +#endif + + // wxUSE_DRAG_AND_DROP + #endif //__GTKDNDH__