X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4ce81a75efb34de9f01fe3c7b9ffecb03293b1c3..84dd58ce98d52362fabd7f83b1213cce95c5f87a:/include/wx/msw/clipbrd.h diff --git a/include/wx/msw/clipbrd.h b/include/wx/msw/clipbrd.h index 9849af42eb..bc4e18fdbe 100644 --- a/include/wx/msw/clipbrd.h +++ b/include/wx/msw/clipbrd.h @@ -1,12 +1,12 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: clipbrd.h -// Purpose: Clipboard functionality +// Name: wx/msw/clipbrd.h +// Purpose: wxClipboad class and clipboard functions for MSW // Author: Julian Smart // Modified by: // Created: 01/02/97 // RCS-ID: $Id$ // Copyright: (c) Julian Smart -// Licence: wxWindows licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_CLIPBRD_H_ @@ -16,81 +16,84 @@ #pragma interface "clipbrd.h" #endif -#include "wx/defs.h" -#include "wx/setup.h" - #if wxUSE_CLIPBOARD #include "wx/list.h" #include "wx/module.h" - -// These functions superceded by wxClipboard, but retained in order to implement -// wxClipboard, and for compatibility. -WXDLLEXPORT bool wxOpenClipboard(void); -WXDLLEXPORT bool wxClipboardOpen(void); -WXDLLEXPORT bool wxCloseClipboard(void); -WXDLLEXPORT bool wxEmptyClipboard(void); +#include "wx/dataobj.h" // for wxDataFormat + +// These functions superceded by wxClipboard, but retained in order to +// implement wxClipboard, and for compatibility. + +// open/close the clipboard +WXDLLEXPORT bool wxOpenClipboard(); +WXDLLEXPORT bool wxIsClipboardOpened(); +#define wxClipboardOpen wxIsClipboardOpened +WXDLLEXPORT bool wxCloseClipboard(); + +// get/set data +WXDLLEXPORT bool wxEmptyClipboard(); +WXDLLEXPORT bool wxSetClipboardData(wxDataFormat dataFormat, + const void *data, + int width = 0, int height = 0); +WXDLLEXPORT void* wxGetClipboardData(wxDataFormat dataFormat, + long *len = NULL); + +// clipboard formats WXDLLEXPORT bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat); -WXDLLEXPORT bool wxSetClipboardData(wxDataFormat dataFormat, wxObject *obj, int width = 0, int height = 0); -WXDLLEXPORT wxObject* wxGetClipboardData(wxDataFormat dataFormat, long *len = NULL); WXDLLEXPORT wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat); -WXDLLEXPORT int wxRegisterClipboardFormat(char *formatName); -WXDLLEXPORT bool wxGetClipboardFormatName(wxDataFormat dataFormat, char *formatName, int maxCount); +WXDLLEXPORT int wxRegisterClipboardFormat(wxChar *formatName); +WXDLLEXPORT bool wxGetClipboardFormatName(wxDataFormat dataFormat, + wxChar *formatName, + int maxCount); //----------------------------------------------------------------------------- // wxClipboard //----------------------------------------------------------------------------- class WXDLLEXPORT wxDataObject; -class WXDLLEXPORT wxClipboard: public wxObject +class WXDLLEXPORT wxClipboard : public wxObject { - DECLARE_DYNAMIC_CLASS(wxClipboard) + DECLARE_DYNAMIC_CLASS(wxClipboard) public: - - wxClipboard(); - ~wxClipboard(); - - // open the clipboard before SetData() and GetData() - virtual bool Open(); - - // close the clipboard after SetData() and GetData() - virtual void Close(); - - // can be called several times - virtual bool SetData( wxDataObject *data ); - - // format available on the clipboard ? - // supply ID if private format, the same as wxPrivateDataObject::SetId() - virtual bool IsSupportedFormat( wxDataFormat format, const wxString &id = wxEmptyString ); - - // fill data with data on the clipboard (if available) - virtual bool GetData( wxDataObject *data ); - - // clears wxTheClipboard and the system's clipboard if possible - virtual void Clear(); - - // implementation - - bool m_open; - wxList m_data; -}; + wxClipboard(); + ~wxClipboard(); -/* The clipboard */ -WXDLLEXPORT_DATA(extern wxClipboard*) wxTheClipboard; + // open the clipboard before SetData() and GetData() + virtual bool Open(); -//----------------------------------------------------------------------------- -// wxClipboardModule -//----------------------------------------------------------------------------- + // close the clipboard after SetData() and GetData() + virtual void Close(); -class wxClipboardModule: public wxModule -{ - DECLARE_DYNAMIC_CLASS(wxClipboardModule) - -public: - wxClipboardModule() {} - bool OnInit(); - void OnExit(); + // 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 ); + + // add to the clipboard data. + virtual bool AddData( wxDataObject *data ); + + // ask if data in correct format is available + virtual bool IsSupported( wxDataFormat format ); + + // fill data with data on the clipboard (if available) + virtual bool GetData( wxDataObject& data ); + + // clears wxTheClipboard and the system's clipboard if possible + virtual void Clear(); + + // 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(); + + // X11 has two clipboards which get selected by this call. Empty on MSW. + void UsePrimarySelection( bool WXUNUSED(primary) = FALSE ) { } + +private: + bool m_clearOnExit; }; #endif // wxUSE_CLIPBOARD