document various enumerations defined in defs.h; give a name to the anonymous enum...

[wxWidgets.git] / include / wx / gtk / clipbrd.h

diff --git a/include/wx/gtk/clipbrd.h b/include/wx/gtk/clipbrd.h
index ebd59179afe144d3dc728e27e9024d4263880d5c..548e911743adbb7fd2ed5375c3403c9743644511 100644 (file)
--- a/include/wx/gtk/clipbrd.h
+++ b/include/wx/gtk/clipbrd.h
@@ -1,9 +1,10 @@
 /////////////////////////////////////////////////////////////////////////////
-// 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
 /////////////////////////////////////////////////////////////////////////////
 
@@ -14,9 +15,18 @@
 // wxClipboard
 // ----------------------------------------------------------------------------
 
+#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();
     virtual ~wxClipboard();
 
@@ -38,35 +48,85 @@ public:
     // ask if data in correct format is available
     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 );
 
     // 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.
-    virtual void UsePrimarySelection(bool primary = TRUE)
-        { m_usePrimary = primary; }
-    
+
 
     // implementation from now on
     // --------------------------
 
-    bool              m_open;
-    bool              m_ownsClipboard;
-    bool              m_ownsPrimarySelection;
-    wxDataObject     *m_data;
+    // 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);
+
+    // 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);
+
 
-    GtkWidget        *m_clipboardWidget;  /* for getting and offering data */
-    GtkWidget        *m_targetsWidget;    /* for getting list of supported formats */
+    // 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;
 
-    bool              m_formatSupported;
-    GdkAtom           m_targetRequested;
-    bool              m_usePrimary;
-    wxDataObject     *m_receivedData;
+    // 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;
+
+public:
+    // async stuff
+    wxEvtHandlerRef    m_sink;
 private:
+    GtkWidget         *m_targetsWidgetAsync;  // for getting list of supported formats
+
     DECLARE_DYNAMIC_CLASS(wxClipboard)
 };