X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/77ffb5937e89927b621128789401db8921fe580f..eef2e91ffb62bbf3f61b8d9e718022a020cdeaa2:/include/wx/clipbrd.h?ds=inline diff --git a/include/wx/clipbrd.h b/include/wx/clipbrd.h index d0e3495d14..06dd74d194 100644 --- a/include/wx/clipbrd.h +++ b/include/wx/clipbrd.h @@ -6,26 +6,23 @@ // Created: 19.10.99 // RCS-ID: $Id$ // Copyright: (c) wxWidgets Team -// Licence: wxWidgets licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_CLIPBRD_H_BASE_ #define _WX_CLIPBRD_H_BASE_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma interface "clipboardbase.h" -#endif - #include "wx/defs.h" #if wxUSE_CLIPBOARD -#include "wx/object.h" -#include "wx/wxchar.h" +#include "wx/event.h" +#include "wx/chartype.h" +#include "wx/dataobj.h" // for wxDataFormat +#include "wx/vector.h" -class WXDLLEXPORT wxDataFormat; -class WXDLLEXPORT wxDataObject; +class WXDLLIMPEXP_FWD_CORE wxClipboard; // ---------------------------------------------------------------------------- // wxClipboard represents the system clipboard. Normally, you should use @@ -35,10 +32,10 @@ class WXDLLEXPORT wxDataObject; // with wxDataObject. // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxClipboardBase : public wxObject +class WXDLLIMPEXP_CORE wxClipboardBase : public wxObject { public: - wxClipboardBase(); + wxClipboardBase() { m_usePrimary = false; } // open the clipboard before Add/SetData() and GetData() virtual bool Open() = 0; @@ -62,22 +59,93 @@ 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 IsSupportedAsync( wxEvtHandler *sink ); + // fill data with data on the clipboard (if available) virtual bool GetData( wxDataObject& data ) = 0; - + // clears wxTheClipboard and the system's clipboard if possible virtual void Clear() = 0; // flushes the clipboard: this means that the data which is currently on // clipboard will stay available even after the application exits (possibly // eating memory), otherwise the clipboard will be emptied on exit - virtual bool Flush() { return FALSE; } + virtual bool Flush() { return 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(); + + + // 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) + : wxEvent(0, evtType) + { + } + + wxClipboardEvent(const wxClipboardEvent& event) + : wxEvent(event), + m_formats(event.m_formats) + { + } + + bool SupportsFormat(const wxDataFormat& format) const; + void AddFormat(const wxDataFormat& format); + + virtual wxEvent *Clone() const + { + return new wxClipboardEvent(*this); + } - // X11 has two clipboards which get selected by this call. Empty on MSW. - virtual void UsePrimarySelection( bool WXUNUSED(primary) = FALSE ) { } +protected: + wxVector m_formats; + + 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 +// ---------------------------------------------------------------------------- + +// The global clipboard object - backward compatible access macro: +#define wxTheClipboard (wxClipboard::Get()) + // ---------------------------------------------------------------------------- // include platform-specific class declaration // ---------------------------------------------------------------------------- @@ -86,35 +154,30 @@ public: #include "wx/msw/clipbrd.h" #elif defined(__WXMOTIF__) #include "wx/motif/clipbrd.h" -#elif defined(__WXGTK__) +#elif defined(__WXGTK20__) #include "wx/gtk/clipbrd.h" +#elif defined(__WXGTK__) + #include "wx/gtk1/clipbrd.h" #elif defined(__WXX11__) #include "wx/x11/clipbrd.h" #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__) #include "wx/os2/clipbrd.h" #endif -// ---------------------------------------------------------------------------- -// globals -// ---------------------------------------------------------------------------- - -// The global clipboard object -WXDLLEXPORT_DATA(extern wxClipboard *) wxTheClipboard; - // ---------------------------------------------------------------------------- // helpful class for opening the clipboard and automatically closing it // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxClipboardLocker +class WXDLLIMPEXP_CORE wxClipboardLocker { public: - wxClipboardLocker(wxClipboard *clipboard = (wxClipboard *)NULL) + wxClipboardLocker(wxClipboard *clipboard = NULL) { m_clipboard = clipboard ? clipboard : wxTheClipboard; if ( m_clipboard ) @@ -136,7 +199,7 @@ public: private: wxClipboard *m_clipboard; - DECLARE_NO_COPY_CLASS(wxClipboardLocker) + wxDECLARE_NO_COPY_CLASS(wxClipboardLocker); }; #endif // wxUSE_CLIPBOARD