/////////////////////////////////////////////////////////////////////////////
-// Name: clipboard.h
-// Purpose:
-// Author: Robert Roebling
+// Name: wx/gtk/clipboard.h
+// Purpose: wxClipboard for wxGTK
+// Author: Robert Roebling, Vadim Zeitlin
// Id: $Id$
// Copyright: (c) 1998 Robert Roebling
+// (c) 2007 Vadim Zeitlin
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+#ifndef _WX_GTK_CLIPBOARD_H_
+#define _WX_GTK_CLIPBOARD_H_
-#ifndef __GTKCLIPBOARDH__
-#define __GTKCLIPBOARDH__
-
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-
-#if wxUSE_CLIPBOARD
-
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/dataobj.h"
-#include "wx/control.h"
-#include "wx/module.h"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxClipboard;
-class wxClipboardModule;
-
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
-
-extern wxClipboard* wxTheClipboard;
-
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
// wxClipboard
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
-class wxClipboard : public wxObject
+#include "wx/weakref.h"
+
+class WXDLLIMPEXP_CORE wxClipboard : public wxClipboardBase
{
public:
+ // there are several clipboards in X11 (and in GDK)
+ enum Kind
+ {
+ Primary,
+ Clipboard
+ };
+
wxClipboard();
- ~wxClipboard();
+ virtual ~wxClipboard();
// open the clipboard before SetData() and GetData()
virtual bool Open();
// close the clipboard after SetData() and GetData()
virtual void Close();
+ // query whether the clipboard is opened
+ virtual bool IsOpened() const;
+
// set the clipboard data. all other formats will be deleted.
virtual bool SetData( wxDataObject *data );
virtual bool AddData( wxDataObject *data );
// ask if data in correct format is available
- virtual bool IsSupported( wxDataFormat format );
+ virtual bool IsSupported( const wxDataFormat& format );
+
+ // 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 );
+ virtual bool GetData( wxDataObject& data );
// clears wxTheClipboard and the system's clipboard if possible
virtual void Clear();
- /// If primary == TRUE, use primary selection in all further ops,
- /// primary=FALSE resets it.
- inline void UsePrimarySelection(bool primary = TRUE) { m_usePrimary = primary; }
-
- // implementation
- bool m_open;
- bool m_ownsClipboard;
- bool m_ownsPrimarySelection;
+ // implementation from now on
+ // --------------------------
+
+ // get our clipboard item (depending on m_usePrimary value)
+ GdkAtom GTKGetClipboardAtom() const;
+
+ // get the data object currently being used
+ wxDataObject *GTKGetDataObject() { return Data(); }
+
+ // clear the data for the given clipboard kind
+ void GTKClearData(Kind kind);
+
+ // called when selection data is received
+ void GTKOnSelectionReceived(const GtkSelectionData& sel);
- wxDataBroker *m_dataBroker;
- GtkWidget *m_clipboardWidget; /* for getting and offering data */
- GtkWidget *m_targetsWidget; /* for getting list of supported formats */
- bool m_waiting; /* querying data or formats is asynchronous */
+ // called when available target information is received
+ bool GTKOnTargetReceived(const wxDataFormat& format);
- bool m_formatSupported;
- GdkAtom m_targetRequested;
- bool m_usePrimary;
- wxDataObject *m_receivedData;
-
private:
- DECLARE_DYNAMIC_CLASS(wxClipboard)
-};
+ // the data object for the specific selection
+ wxDataObject *& Data(Kind kind)
+ {
+ return kind == Primary ? m_dataPrimary : m_dataClipboard;
+ }
-//-----------------------------------------------------------------------------
-// wxClipboardModule
-//-----------------------------------------------------------------------------
+ // 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
-{
public:
- wxClipboardModule() {}
- bool OnInit();
- void OnExit();
-
+ // async stuff
+ wxEvtHandlerRef m_sink;
private:
- DECLARE_DYNAMIC_CLASS(wxClipboardModule)
-};
-
-#endif
+ GtkWidget *m_targetsWidgetAsync; // for getting list of supported formats
- // wxUSE_CLIPBOARD
+ DECLARE_DYNAMIC_CLASS(wxClipboard)
+};
-#endif
- // __GTKCLIPBOARDH__
+#endif // _WX_GTK_CLIPBOARD_H_
projects / wxWidgets.git / blobdiff