Give GTK specific (but public) methods a Gtk prefix

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

diff --git a/include/wx/clipbrd.h b/include/wx/clipbrd.h
index 6c2d3ac5eb7093cf9674cd8091d4cc269d50d2cf..e8b9a900ed90fe4d77368fe4ed35db16c1c8f3cc 100644 (file)
--- a/include/wx/clipbrd.h
+++ b/include/wx/clipbrd.h
@@ -17,12 +17,13 @@
 #if wxUSE_CLIPBOARD
 
 
 #if wxUSE_CLIPBOARD
 
 

-#include "wx/object.h"
-#include "wx/wxchar.h"
+#include "wx/event.h"
+#include "wx/chartype.h"
+#include "wx/vector.h"

 
 

-class WXDLLEXPORT wxDataFormat;
-class WXDLLEXPORT wxDataObject;
-class WXDLLEXPORT wxClipboard;
+class WXDLLIMPEXP_FWD_CORE wxDataFormat;
+class WXDLLIMPEXP_FWD_CORE wxDataObject;
+class WXDLLIMPEXP_FWD_CORE wxClipboard;

 
 // ----------------------------------------------------------------------------
 // wxClipboard represents the system clipboard. Normally, you should use
 
 // ----------------------------------------------------------------------------
 // wxClipboard represents the system clipboard. Normally, you should use


@@ -32,10 +33,10 @@ class WXDLLEXPORT wxClipboard;
 // with wxDataObject.
 // ----------------------------------------------------------------------------
 
 // with wxDataObject.
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxClipboardBase : public wxObject
+class WXDLLIMPEXP_CORE wxClipboardBase : public wxObject

 {
 public:
 {
 public:

-    wxClipboardBase() {}
+    wxClipboardBase() { m_usePrimary = false; }

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


@@ -59,6 +60,9 @@ public:
     // ask if data in correct format is available
     virtual bool IsSupported( const wxDataFormat& format ) = 0;
 
     // ask if data in correct format is available
     virtual bool IsSupported( const wxDataFormat& format ) = 0;
 

+    // 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 ) = 0;
 
     // fill data with data on the clipboard (if available)
     virtual bool GetData( wxDataObject& data ) = 0;
 


@@ -70,13 +74,61 @@ public:
     // eating memory), otherwise the clipboard will be emptied on exit
     virtual bool Flush() { return false; }
 
     // eating memory), otherwise the clipboard will be emptied on exit
     virtual bool Flush() { return false; }
 

-    // X11 has two clipboards which get selected by this call. Empty on MSW.
-    virtual void UsePrimarySelection( bool WXUNUSED(primary) = false ) { }
+    // this allows to choose whether we work with CLIPBOARD (default) or
+    // PRIMARY selection on X11-based systems
+    //
+    // on the other ones, working with primary selection does nothing: this
+    // allows to write code which sets the primary selection when something is
+    // selected without any ill effects (i.e. without overwriting the
+    // clipboard which would be wrong on the platforms without X11 PRIMARY)
+    virtual void UsePrimarySelection(bool usePrimary = false)
+    {
+        m_usePrimary = usePrimary;
+    }
+
+    // return true if we're using primary selection
+    bool IsUsingPrimarySelection() const { return m_usePrimary; }

 
     // Returns global instance (wxTheClipboard) of the object:
     static wxClipboard *Get();
 
     // Returns global instance (wxTheClipboard) of the object:
     static wxClipboard *Get();

+
+
+    // don't use this directly, it is public for compatibility with some ports
+    // (wxX11, wxMotif, ...) only
+    bool m_usePrimary;
+};
+
+// ----------------------------------------------------------------------------
+// asynchronous clipboard event
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxClipboardEvent : public wxEvent
+{
+public:
+    wxClipboardEvent(wxEventType evtType = wxEVT_NULL);
+    wxClipboardEvent(const wxClipboardEvent& event);
+
+    bool SupportsFormat(const wxDataFormat& format) const;
+    void AddFormat(const wxDataFormat& format);
+
+    virtual wxEvent *Clone() const { return new wxClipboardEvent(*this); }
+
+protected:
+    wxVector<wxDataFormat> m_formats;
+
+private:
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardEvent)

 };
 
 };
 

+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_CLIPBOARD_CHANGED, wxClipboardEvent )
+
+typedef void (wxEvtHandler::*wxClipboardEventFunction)(wxClipboardEvent&);
+
+#define wxClipboardEventHandler(func) \
+    wxEVENT_HANDLER_CAST(wxClipboardEventFunction, func)
+
+#define EVT_CLIPBOARD_CHANGED(func) wx__DECLARE_EVT0(wxEVT_CLIPBOARD_CHANGED, wxClipboardEventHandler(func))
+

 // ----------------------------------------------------------------------------
 // globals
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // globals
 // ----------------------------------------------------------------------------


@@ -101,7 +153,7 @@ public:
 #elif defined(__WXMGL__)
     #include "wx/mgl/clipbrd.h"
 #elif defined(__WXMAC__)
 #elif defined(__WXMGL__)
     #include "wx/mgl/clipbrd.h"
 #elif defined(__WXMAC__)

-    #include "wx/mac/clipbrd.h"
+    #include "wx/osx/clipbrd.h"

 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/clipbrd.h"
 #elif defined(__WXPM__)
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/clipbrd.h"
 #elif defined(__WXPM__)


@@ -112,10 +164,10 @@ public:
 // helpful class for opening the clipboard and automatically closing it
 // ----------------------------------------------------------------------------
 
 // helpful class for opening the clipboard and automatically closing it
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxClipboardLocker
+class WXDLLIMPEXP_CORE wxClipboardLocker

 {
 public:
 {
 public:

-    wxClipboardLocker(wxClipboard *clipboard = (wxClipboard *)NULL)
+    wxClipboardLocker(wxClipboard *clipboard = NULL)

     {
         m_clipboard = clipboard ? clipboard : wxTheClipboard;
         if ( m_clipboard )
     {
         m_clipboard = clipboard ? clipboard : wxTheClipboard;
         if ( m_clipboard )