X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e1ee679c2e3f48bc4f2607e35033ed5505ed6665..d5dc103fd4afb197f48d6a87f67f6b82dd7f56fe:/include/wx/clipbrd.h diff --git a/include/wx/clipbrd.h b/include/wx/clipbrd.h index 6ce90e1982..6c2d3ac5eb 100644 --- a/include/wx/clipbrd.h +++ b/include/wx/clipbrd.h @@ -5,7 +5,7 @@ // Modified by: // Created: 19.10.99 // RCS-ID: $Id$ -// Copyright: (c) wxWindows Team +// Copyright: (c) wxWidgets Team // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -16,11 +16,13 @@ #if wxUSE_CLIPBOARD + #include "wx/object.h" #include "wx/wxchar.h" class WXDLLEXPORT wxDataFormat; class WXDLLEXPORT wxDataObject; +class WXDLLEXPORT wxClipboard; // ---------------------------------------------------------------------------- // wxClipboard represents the system clipboard. Normally, you should use @@ -33,50 +35,55 @@ class WXDLLEXPORT wxDataObject; class WXDLLEXPORT wxClipboardBase : public wxObject { public: + wxClipboardBase() {} + // open the clipboard before Add/SetData() and GetData() - virtual bool Open(); + virtual bool Open() = 0; // close the clipboard after Add/SetData() and GetData() - virtual void Close(); + 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 // allocated on the heap - virtual bool AddData( wxDataObject *data ); + virtual bool AddData( wxDataObject *data ) = 0; // set the clipboard data, this is the same as Clear() followed by // AddData() - virtual bool SetData( wxDataObject *data ); + virtual bool SetData( wxDataObject *data ) = 0; // ask if data in correct format is available - virtual bool IsSupported( const wxDataFormat& format ); + virtual bool IsSupported( const wxDataFormat& format ) = 0; // fill data with data on the clipboard (if available) - virtual bool GetData( wxDataObject& data ); + virtual bool GetData( wxDataObject& data ) = 0; // clears wxTheClipboard and the system's clipboard if possible - virtual void Clear(); + 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; } // X11 has two clipboards which get selected by this call. Empty on MSW. - virtual void UsePrimarySelection( bool WXUNUSED(primary) = FALSE ) { } + virtual void UsePrimarySelection( bool WXUNUSED(primary) = false ) { } -#ifdef WXWIN_COMPATIBILITY_2 - // deprecated version - bool GetData(wxDataObject *data) - { - wxCHECK_MSG(data, FALSE, wxT("NULL pointer in wxClipboard")); - - return GetData(*data); - } -#endif // WXWIN_COMPATIBILITY_2 + // Returns global instance (wxTheClipboard) of the object: + static wxClipboard *Get(); }; +// ---------------------------------------------------------------------------- +// globals +// ---------------------------------------------------------------------------- + +// The global clipboard object - backward compatible access macro: +#define wxTheClipboard (wxClipboard::Get()) + // ---------------------------------------------------------------------------- // include platform-specific class declaration // ---------------------------------------------------------------------------- @@ -85,42 +92,52 @@ 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; - -// ---------------------------------------------------------------------------- -// wxClipboardModule: module responsible for initializing the global clipboard -// object -// -// NB: IMPLEMENT_DYNAMIC_CLASS() for it is in common/appcmn.cpp -// ---------------------------------------------------------------------------- - -class wxClipboardModule : public wxModule +class WXDLLEXPORT wxClipboardLocker { public: - bool OnInit() - { wxTheClipboard = new wxClipboard; } - void OnExit() - { delete wxTheClipboard; wxTheClipboard = (wxClipboard *)NULL; } + 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: - DECLARE_DYNAMIC_CLASS(wxClipboardModule) + wxClipboard *m_clipboard; + + DECLARE_NO_COPY_CLASS(wxClipboardLocker) }; #endif // wxUSE_CLIPBOARD