///////////////////////////////////////////////////////////////////////////////
// Name: dnd.h
-// Purpose: Declaration of the wxDropTarget, wxDropSource class etc.
-// Author: AUTHOR
+// Purpose: declaration of the wxDropTarget class
+// Author: David Webster
+// Modified by:
+// Created: 10/21/99
// RCS-ID: $Id$
-// Copyright: (c) 1998 AUTHOR
+// Copyright: (c) 1999 David Webster
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
-#ifndef _WX_DND_H_
-#define _WX_DND_H_
-#ifdef __GNUG__
-#pragma interface "dnd.h"
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/cursor.h"
-
-//-------------------------------------------------------------------------
-// classes
-//-------------------------------------------------------------------------
+#ifndef __OS2DNDH__
+#define __OS2DNDH__
-class WXDLLEXPORT wxWindow;
+#if !wxUSE_DRAG_AND_DROP
+ #error "You should #define wxUSE_DRAG_AND_DROP to 1 to compile this file!"
+#endif //WX_DRAG_DROP
-class WXDLLEXPORT wxDataObject;
-class WXDLLEXPORT wxTextDataObject;
-class WXDLLEXPORT wxFileDataObject;
-
-class WXDLLEXPORT wxDropTarget;
-class WXDLLEXPORT wxTextDropTarget;
-class WXDLLEXPORT wxFileDropTarget;
+#define INCL_WINSTDDRAG
+#include <os2.h>
+#ifndef __EMX__
+#include <pmstddlg.h>
+#endif
-class WXDLLEXPORT wxDropSource;
+class CIDropTarget;
//-------------------------------------------------------------------------
-// wxDataFormat (internal)
+// wxDropSource
//-------------------------------------------------------------------------
-class wxDataFormat : public wxObject
+class WXDLLIMPEXP_CORE wxDropSource: public wxDropSourceBase
{
- DECLARE_CLASS( wxDataFormat )
-
public:
- wxDataFormat();
- wxDataFormat( wxDataFormatId type );
- wxDataFormat( const wxString &id );
- wxDataFormat( const wxChar *id );
- wxDataFormat( const wxDataFormat &format );
+ /* constructor. set data later with SetData() */
+ wxDropSource(wxWindow* pWin);
- void SetType( wxDataFormatId type );
- wxDataFormatId GetType() const;
+ /* constructor for setting one data object */
+ wxDropSource( wxDataObject& rData,
+ wxWindow* pWin
+ );
+ virtual ~wxDropSource();
- /* 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", an
- * image manipulation program would put a wxBitmapDataObject and a
- * wxPrivateDataObject to the clipboard - the latter with "image/png". */
+ /* start drag action */
+ virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly);
+ virtual bool GiveFeedback(wxDragResult eEffect);
- wxString GetId() const;
- void SetId( const wxChar *id );
+protected:
+ void Init(void);
- // implicit conversion to wxDataFormatId
- operator wxDataFormatId() const { return m_type; }
+ ULONG m_ulItems;
+ PDRAGINFO m_pDragInfo;
+ DRAGIMAGE m_vDragImage;
+ PDRAGITEM m_pDragItem;
+ wxWindow* m_pWindow;
+}; // end of CLASS wxDropSource
- bool operator==(wxDataFormatId type) const { return m_type == type; }
- bool operator!=(wxDataFormatId type) const { return m_type != type; }
-
-private:
- wxDataFormatId m_type;
- wxString m_id;
-};
//-------------------------------------------------------------------------
-// wxDataObject
+// wxDropTarget
//-------------------------------------------------------------------------
-class WXDLLEXPORT 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 WXDLLEXPORT 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 WXDLLEXPORT wxFileDataObject : public wxDataObject
+class WXDLLIMPEXP_CORE wxDropTarget : public wxDropTargetBase
{
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()); }
+ wxDropTarget(wxDataObject* pDataObject = (wxDataObject*)NULL);
+ virtual ~wxDropTarget();
+
+ //
+ // These functions are called when data is moved over position (x, y) and
+ // may return either wxDragCopy, wxDragMove or wxDragNone depending on
+ // what would happen if the data were dropped here.
+ //
+ // The last parameter is what would happen by default and is determined by
+ // the platform-specific logic (for example, under Windows it's wxDragCopy
+ // if Ctrl key is pressed and wxDragMove otherwise) except that it will
+ // always be wxDragNone if the carried data is in an unsupported format.
+ //
+ // OnData must be implemented and other should be overridden by derived classes
+ //
+ virtual wxDragResult OnData( wxCoord vX
+ ,wxCoord vY
+ ,wxDragResult eResult
+ );
+ virtual bool OnDrop( wxCoord vX
+ ,wxCoord vY
+ );
+ bool IsAcceptedData(PDRAGINFO pDataSource) const;
+
+protected:
+ virtual bool GetData(void);
+ wxDataFormat GetSupportedFormat(PDRAGINFO pDataSource) const;
+ void Release(void);
private:
- wxString m_files;
-
-};
-//-------------------------------------------------------------------------
-// wxDropTarget
-//-------------------------------------------------------------------------
-
-class WXDLLEXPORT wxDropTarget: public wxObject
-{
- public:
+ CIDropTarget* m_pDropTarget;
+}; // end of CLASS wxDropTarget
- wxDropTarget();
- ~wxDropTarget();
-
- virtual void OnEnter() { }
- virtual void OnLeave() { }
- virtual bool OnDrop( long x, long y, const void *pData ) = 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;
-};
-
-//-------------------------------------------------------------------------
-// wxTextDropTarget
-//-------------------------------------------------------------------------
-
-class WXDLLEXPORT 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 WXDLLEXPORT wxFileDropTarget: public wxDropTarget
-{
- 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;
-};
-
-//-------------------------------------------------------------------------
-// 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
- wxDragCancel // the operation was cancelled by user (not an error)
- };
-
-class WXDLLEXPORT 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:
-
- wxDataObject *m_data;
-};
-
-#endif
- //_WX_DND_H_
+#endif //__OS2DNDH__
projects / wxWidgets.git / blobdiff