Applied rowspan patch #15276 (dghart)

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

diff --git a/include/wx/gtk/clipbrd.h b/include/wx/gtk/clipbrd.h
index 2a4f2bd8a5a7a7b582be406bca1a7fffda8c2903..ff24ad33dc3bd84ac8da9472724a10dc27d4d983 100644 (file)
--- a/include/wx/gtk/clipbrd.h
+++ b/include/wx/gtk/clipbrd.h
@@ -1,54 +1,34 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling

+//              (c) 2007 Vadim Zeitlin

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // 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
 // wxClipboard

-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 
 

-class wxClipboard : public wxObject
-{
-    DECLARE_DYNAMIC_CLASS(wxClipboard)
+#include "wx/weakref.h"

 
 

+class WXDLLIMPEXP_CORE wxClipboard : public wxClipboardBase
+{

 public:
 public:

+    // there are several clipboards in X11 (and in GDK)
+    enum Kind
+    {
+        Primary,
+        Clipboard
+    };
+

     wxClipboard();
     wxClipboard();

-    ~wxClipboard();
+    virtual ~wxClipboard();

 
     // open the clipboard before SetData() and GetData()
     virtual bool Open();
 
     // open the clipboard before SetData() and GetData()
     virtual bool Open();


@@ -56,6 +36,9 @@ public:
     // close the clipboard after SetData() and GetData()
     virtual void Close();
 
     // 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 );
 
     // set the clipboard data. all other formats will be deleted.
     virtual bool SetData( wxDataObject *data );
 


@@ -63,47 +46,91 @@ public:
     virtual bool AddData( wxDataObject *data );
 
     // ask if data in correct format is available
     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)
 
     // 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();
 
 
     // clears wxTheClipboard and the system's clipboard if possible
     virtual void Clear();
 

-    // implementation

 
 

-    bool              m_open;

 
 

-    bool              m_ownsClipboard;
-    bool              m_ownsPrimarySelection;
+    // implementation from now on
+    // --------------------------

 
 

-    wxDataBroker     *m_dataBroker;
-    GtkWidget        *m_clipboardWidget;
+    // get our clipboard item (depending on m_usePrimary value)
+    GdkAtom GTKGetClipboardAtom() const;

 
 

-    bool              m_formatSupported;
-    GdkAtom           m_targetRequested;
+    // get the data object currently being requested
+    wxDataObject *GTKGetDataObject( GdkAtom atom );

 
 

-    wxDataObject      *m_receivedData;
-};
+    // clear the data for the given clipboard kind
+    void GTKClearData(Kind kind);

 
 

-//-----------------------------------------------------------------------------
-// wxClipboardModule
-//-----------------------------------------------------------------------------
+    // called when selection data is received
+    void GTKOnSelectionReceived(const GtkSelectionData& sel);

 
 

-class wxClipboardModule: public wxModule
-{
-  DECLARE_DYNAMIC_CLASS(wxClipboardModule)
+    // called when available target information is received
+    bool GTKOnTargetReceived(const wxDataFormat& format);

 
 

-public:
-    wxClipboardModule() {}
-    bool OnInit();
-    void OnExit();
-};
+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;

 
 

-#endif
+    // this is used to temporarily hold the object passed to our GetData() so
+    // that GTK callbacks could access it
+    wxDataObject *m_receivedData;

 
 

-   // wxUSE_CLIPBOARD
+    // 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
+
+    // ID of the connection to "selection_get" signal, initially 0.
+    unsigned long m_idSelectionGetHandler;
+
+    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)
+};

 
 

-#endif
-    // __GTKCLIPBOARDH__
+#endif // _WX_GTK_CLIPBOARD_H_