/////////////////////////////////////////////////////////////////////////////
-// Name: clipboard.h
-// Purpose:
-// Author: Robert Roebling
+// Name: wx/gtk/clipbrd.h
+// Purpose: wxClipboard for wxGTK
+// Author: Robert Roebling, Vadim Zeitlin
// Id: $Id$
// Copyright: (c) 1998 Robert Roebling
-// Licence: wxWindows licence
+// (c) 2007 Vadim Zeitlin
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+#ifndef _WX_GTK_CLIPBOARD_H_
+#define _WX_GTK_CLIPBOARD_H_
-#ifndef __GTKCLIPBOARDH__
-#define __GTKCLIPBOARDH__
+// ----------------------------------------------------------------------------
+// wxClipboard
+// ----------------------------------------------------------------------------
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "wx/weakref.h"
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/control.h"
-#include "wx/dnd.h" // for wxDataObject
-#include "wx/module.h"
+class WXDLLIMPEXP_CORE wxClipboard : public wxClipboardBase
+{
+public:
+ // there are several clipboards in X11 (and in GDK)
+ enum Kind
+ {
+ Primary,
+ Clipboard
+ };
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
+ wxClipboard();
+ virtual ~wxClipboard();
-class wxClipboard;
-class wxClipboardModule;
+ // open the clipboard before SetData() and GetData()
+ virtual bool Open();
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
+ // close the clipboard after SetData() and GetData()
+ virtual void Close();
-extern wxClipboard* wxTheClipboard;
+ // query whether the clipboard is opened
+ virtual bool IsOpened() const;
-//-----------------------------------------------------------------------------
-// wxClipboard
-//-----------------------------------------------------------------------------
+ // set the clipboard data. all other formats will be deleted.
+ virtual bool SetData( wxDataObject *data );
-class wxClipboard: public wxObject
-{
- DECLARE_DYNAMIC_CLASS(wxClipboard)
+ // add to the clipboard data.
+ virtual bool AddData( wxDataObject *data );
-public:
-
- wxClipboard();
- ~wxClipboard();
-
- virtual void SetData( wxDataObject *data );
-
- virtual bool IsSupportedFormat( wxDataFormat format );
- virtual bool ObtainData( wxDataFormat format );
-
- // call these after ObtainData()
- virtual size_t GetDataSize() const;
- virtual void GetDataHere( void *data ) const;
-
- // clears wxTheClipboard and the system's clipboard if possible
- virtual void Clear();
-
- // implementation
-
- wxDataObject *m_data;
- char *m_sentString,
- *m_receivedString;
- void *m_receivedTargets;
- GtkWidget *m_clipboardWidget;
-
- bool m_formatSupported;
- GdkAtom m_targetRequested;
-
- size_t m_receivedSize;
- char *m_receivedData;
-};
+ // ask if data in correct format is available
+ virtual bool IsSupported( const wxDataFormat& format );
-//-----------------------------------------------------------------------------
-// wxClipboardModule
-//-----------------------------------------------------------------------------
+ // ask if data in correct format is available
+ virtual bool IsSupportedAsync( wxEvtHandler *sink );
+
+ // fill data with data on the clipboard (if available)
+ virtual bool GetData( wxDataObject& data );
+
+ // clears wxTheClipboard and the system's clipboard if possible
+ virtual void Clear();
+
+
+
+ // implementation from now on
+ // --------------------------
+
+ // get our clipboard item (depending on m_usePrimary value)
+ GdkAtom GTKGetClipboardAtom() const;
+
+ // get the data object currently being requested
+ wxDataObject *GTKGetDataObject( GdkAtom atom );
+
+ // clear the data for the given clipboard kind
+ void GTKClearData(Kind kind);
+
+ // called when selection data is received
+ void GTKOnSelectionReceived(const GtkSelectionData& sel);
+
+ // called when available target information is received
+ bool GTKOnTargetReceived(const wxDataFormat& format);
+
+private:
+ // the data object for the specific selection
+ wxDataObject *& Data(Kind kind)
+ {
+ return kind == Primary ? m_dataPrimary : m_dataClipboard;
+ }
+
+ // the data object we're currently using
+ wxDataObject *& Data()
+ {
+ return Data(m_usePrimary ? Primary : Clipboard);
+ }
+
+
+ // set or unset selection ownership
+ bool SetSelectionOwner(bool set = true);
+
+ // add atom to the list of supported targets
+ void AddSupportedTarget(GdkAtom atom);
+
+ // check if the given format is supported
+ bool DoIsSupported(const wxDataFormat& format);
+
+
+ // both of these pointers can be non-NULL simultaneously but we only use
+ // one of them at any moment depending on m_usePrimary value, use Data()
+ // (from inside) or GTKGetDataObject() (from outside) accessors
+ wxDataObject *m_dataPrimary,
+ *m_dataClipboard;
+
+ // this is used to temporarily hold the object passed to our GetData() so
+ // that GTK callbacks could access it
+ wxDataObject *m_receivedData;
+
+ // used to pass information about the format we need from DoIsSupported()
+ // to GTKOnTargetReceived()
+ GdkAtom m_targetRequested;
+
+ GtkWidget *m_clipboardWidget; // for getting and offering data
+ GtkWidget *m_targetsWidget; // for getting list of supported formats
+
+ bool m_open;
+ bool m_formatSupported;
-class wxClipboardModule: public wxModule
-{
- DECLARE_DYNAMIC_CLASS(wxClipboardModule)
-
public:
- wxClipboardModule() {}
- bool OnInit();
- void OnExit();
-};
+ // async stuff
+ wxEvtHandlerRef m_sink;
+private:
+ GtkWidget *m_targetsWidgetAsync; // for getting list of supported formats
+ DECLARE_DYNAMIC_CLASS(wxClipboard)
+};
-#endif
- // __GTKCLIPBOARDH__
+#endif // _WX_GTK_CLIPBOARD_H_
projects / wxWidgets.git / blobdiff