// Created: 01/02/97
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_CLIPBRD_H_
#if wxUSE_CLIPBOARD
#include "wx/list.h"
-
-WXDLLEXPORT bool wxOpenClipboard(void);
-WXDLLEXPORT bool wxClipboardOpen(void);
-WXDLLEXPORT bool wxCloseClipboard(void);
-WXDLLEXPORT bool wxEmptyClipboard(void);
-WXDLLEXPORT bool wxIsClipboardFormatAvailable(int dataFormat);
-WXDLLEXPORT bool wxSetClipboardData(int dataFormat, wxObject *obj, int width = 0, int height = 0);
-WXDLLEXPORT wxObject* wxGetClipboardData(int dataFormat, long *len = NULL);
-WXDLLEXPORT int wxEnumClipboardFormats(int dataFormat);
+#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();
+
+// 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 wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat);
WXDLLEXPORT int wxRegisterClipboardFormat(char *formatName);
-WXDLLEXPORT bool wxGetClipboardFormatName(int dataFormat, char *formatName, int maxCount);
-
-/* The following is Matthew Flatt's implementation of the MSW
- * side of generic clipboard functionality.
- */
+WXDLLEXPORT bool wxGetClipboardFormatName(wxDataFormat dataFormat,
+ char *formatName,
+ int maxCount);
-/* A clipboard client holds data belonging to the clipboard.
- For plain text, a client is not necessary. */
-class WXDLLEXPORT wxClipboardClient : public wxObject
-{
- DECLARE_ABSTRACT_CLASS(wxClipboardClient)
-
- public:
- /* This list should be filled in with strings indicating the formats
- this client can provide. Almost all clients will provide "TEXT".
- Format names should be 4 characters long, so things will work
- out on the Macintosh */
- wxStringList formats;
-
- /* This method is called when the client is losing the selection. */
- virtual void BeingReplaced(void) = 0;
-
- /* This method is called when someone wants the data this client is
- supplying to the clipboard. "format" is a string indicating the
- format of the data - one of the strings from the "formats"
- list. "*size" should be filled with the size of the resulting
- data. In the case of text, "*size" does not count the
- NULL terminator. */
- virtual char *GetData(char *format, long *size) = 0;
-};
+//-----------------------------------------------------------------------------
+// wxClipboard
+//-----------------------------------------------------------------------------
-/* ONE instance of this class: */
+class WXDLLEXPORT wxDataObject;
class WXDLLEXPORT wxClipboard : public wxObject
{
- DECLARE_DYNAMIC_CLASS(wxClipboard)
-
- public:
- wxClipboardClient *clipOwner;
- char *cbString, *sentString, *receivedString;
- void *receivedTargets;
- long receivedLength;
-#ifdef __XVIEW__
- long sel_owner;
-#endif
+ DECLARE_DYNAMIC_CLASS(wxClipboard)
- wxClipboard();
- ~wxClipboard();
+public:
+ wxClipboard();
+ ~wxClipboard();
- /* Set the clipboard data owner. "time" comes from the event record. */
- void SetClipboardClient(wxClipboardClient *, long time);
+ // open the clipboard before SetData() and GetData()
+ virtual bool Open();
- /* Set the clipboard string; does not require a client. */
- void SetClipboardString(char *, long time);
+ // close the clipboard after SetData() and GetData()
+ virtual void Close();
- /* Get data from the clipboard in the format "TEXT". */
- char *GetClipboardString(long time);
+ // set the clipboard data. all other formats will be deleted.
+ virtual bool SetData( wxDataObject *data );
- /* Get data from the clipboard */
- char *GetClipboardData(char *format, long *length, long time);
+ // add to the clipboard data.
+ virtual bool AddData( wxDataObject *data );
- /* Get the clipboard client directly. Will be NULL if clipboard data
- is a string, or if some other application owns the clipboard.
- This can be useful for shortcutting data translation, if the
- clipboard user can check for a specific client. (This is used
- by the wxMediaEdit class.) */
- wxClipboardClient *GetClipboardClient(void);
-};
+ // 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 );
-/* Initialize wxTheClipboard. Can be called repeatedly */
-WXDLLEXPORT void wxInitClipboard(void);
+ // clears wxTheClipboard and the system's clipboard if possible
+ virtual void Clear();
+};
-/* The clipboard */
+// The global clipboard object
WXDLLEXPORT_DATA(extern wxClipboard*) wxTheClipboard;
+//-----------------------------------------------------------------------------
+// wxClipboardModule: module responsible for initializing the global clipboard
+// object
+//-----------------------------------------------------------------------------
+
+class wxClipboardModule : public wxModule
+{
+ DECLARE_DYNAMIC_CLASS(wxClipboardModule)
+
+public:
+ wxClipboardModule() { }
+
+ bool OnInit();
+ void OnExit();
+};
+
#endif // wxUSE_CLIPBOARD
#endif
// _WX_CLIPBRD_H_
projects / wxWidgets.git / blobdiff