X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/97c79de27c368de18afab3ca655bc48a4d53fc30..dd9f8b6bb6935360a8271dc3e8749fb026b601a8:/include/wx/clipbrd.h diff --git a/include/wx/clipbrd.h b/include/wx/clipbrd.h index 47f0af66b5..886ac3871c 100644 --- a/include/wx/clipbrd.h +++ b/include/wx/clipbrd.h @@ -5,27 +5,24 @@ // Modified by: // Created: 19.10.99 // RCS-ID: $Id$ -// Copyright: (c) wxWindows Team +// Copyright: (c) wxWidgets Team // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_CLIPBRD_H_BASE_ #define _WX_CLIPBRD_H_BASE_ -#ifdef __GNUG__ - #pragma interface "clipboardbase.h" -#endif - #include "wx/defs.h" #if wxUSE_CLIPBOARD #include "wx/object.h" -#include "wx/wxchar.h" +#include "wx/chartype.h" -class WXDLLEXPORT wxDataFormat; -class WXDLLEXPORT wxDataObject; +class WXDLLIMPEXP_FWD_CORE wxDataFormat; +class WXDLLIMPEXP_FWD_CORE wxDataObject; +class WXDLLIMPEXP_FWD_CORE wxClipboard; // ---------------------------------------------------------------------------- // wxClipboard represents the system clipboard. Normally, you should use @@ -38,7 +35,7 @@ class WXDLLEXPORT wxDataObject; class WXDLLEXPORT wxClipboardBase : public wxObject { public: - wxClipboardBase(); + wxClipboardBase() { m_usePrimary = false; } // open the clipboard before Add/SetData() and GetData() virtual bool Open() = 0; @@ -46,6 +43,9 @@ public: // close the clipboard after Add/SetData() and GetData() virtual void Close() = 0; + // query whether the clipboard is opened + virtual bool IsOpened() const = 0; + // add to the clipboard data // // NB: the clipboard owns the pointer and will delete it, so data must be @@ -61,20 +61,46 @@ public: // 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(); - // X11 has two clipboards which get selected by this call. Empty on MSW. - virtual void UsePrimarySelection( bool WXUNUSED(primary) = FALSE ) { } + // don't use this directly, it is public for compatibility with some ports + // (wxX11, wxMotif, ...) only + bool m_usePrimary; }; +// ---------------------------------------------------------------------------- +// globals +// ---------------------------------------------------------------------------- + +// The global clipboard object - backward compatible access macro: +#define wxTheClipboard (wxClipboard::Get()) + // ---------------------------------------------------------------------------- // include platform-specific class declaration // ---------------------------------------------------------------------------- @@ -83,24 +109,53 @@ public: #include "wx/msw/clipbrd.h" #elif defined(__WXMOTIF__) #include "wx/motif/clipbrd.h" -#elif defined(__WXGTK__) - #include "wx/gtk/clipbrd.h" -#elif defined(__WXQT__) +#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" +#elif defined(__WXCOCOA__) + #include "wx/cocoa/clipbrd.h" #elif defined(__WXPM__) #include "wx/os2/clipbrd.h" -#elif defined(__WXSTUBS__) - #include "wx/stubs/clipbrd.h" #endif // ---------------------------------------------------------------------------- -// globals +// helpful class for opening the clipboard and automatically closing it // ---------------------------------------------------------------------------- -// The global clipboard object -WXDLLEXPORT_DATA(extern wxClipboard *) wxTheClipboard; +class WXDLLEXPORT wxClipboardLocker +{ +public: + wxClipboardLocker(wxClipboard *clipboard = (wxClipboard *)NULL) + { + m_clipboard = clipboard ? clipboard : wxTheClipboard; + if ( m_clipboard ) + { + m_clipboard->Open(); + } + } + + bool operator!() const { return !m_clipboard->IsOpened(); } + + ~wxClipboardLocker() + { + if ( m_clipboard ) + { + m_clipboard->Close(); + } + } + +private: + wxClipboard *m_clipboard; + + DECLARE_NO_COPY_CLASS(wxClipboardLocker) +}; #endif // wxUSE_CLIPBOARD