/////////////////////////////////////////////////////////////////////////////
-// 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_
#define _WX_CLIPBRD_H_
-#ifdef __GNUG__
-#pragma interface "clipbrd.h"
-#endif
-
-#include "wx/defs.h"
-#include "wx/setup.h"
-
#if wxUSE_CLIPBOARD
#include "wx/list.h"
+#include "wx/module.h"
+#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();
-// 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);
+// 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 wxClipboardBase
{
- 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;
-};
+ wxClipboard();
+ ~wxClipboard();
+
+ // open the clipboard before SetData() and GetData()
+ virtual bool Open();
+
+ // close the clipboard after SetData() and GetData()
+ virtual void Close();
-/* The clipboard */
-// WXDLLEXPORT_DATA(extern wxClipboard*) wxTheClipboard;
+ // 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( const 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;
+ bool m_isOpened;
+};
#endif // wxUSE_CLIPBOARD
#endif