Tweaking some of the new wxPython stuff for wxGTK

[wxWidgets.git] / include / wx / msw / clipbrd.h

diff --git a/include/wx/msw/clipbrd.h b/include/wx/msw/clipbrd.h
index 8d4d4edfb23af8ea1d0b38d9ca0eb28b4d89f37f..bc4e18fdbe7e28a40561e9820d19cea33c89a68e 100644 (file)
--- 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
 // 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_
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CLIPBRD_H_


@@ -16,96 +16,86 @@
 #pragma interface "clipbrd.h"
 #endif
 
 #pragma interface "clipbrd.h"
 #endif
 

-#include "wx/defs.h"
-#include "wx/setup.h"
-
-#if USE_CLIPBOARD
+#if wxUSE_CLIPBOARD

 
 #include "wx/list.h"
 
 #include "wx/list.h"

-
-bool WXDLLEXPORT wxOpenClipboard(void);
-bool WXDLLEXPORT wxClipboardOpen(void);
-bool WXDLLEXPORT wxCloseClipboard(void);
-bool WXDLLEXPORT wxEmptyClipboard(void);
-bool WXDLLEXPORT wxIsClipboardFormatAvailable(int dataFormat);
-bool WXDLLEXPORT wxSetClipboardData(int dataFormat, wxObject *obj, int width = 0, int height = 0);
-wxObject* WXDLLEXPORT wxGetClipboardData(int dataFormat, long *len = NULL);
-int  WXDLLEXPORT wxEnumClipboardFormats(int dataFormat);
-int  WXDLLEXPORT wxRegisterClipboardFormat(char *formatName);
-bool WXDLLEXPORT wxGetClipboardFormatName(int dataFormat, char *formatName, int maxCount);
-
-/* The following is Matthew Flatt's implementation of the MSW
- * side of generic clipboard functionality.
- */
-
-/* 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;
-};
-
-/* ONE instance of this class: */
+#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(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)
-
- 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);
+    // query whether the clipboard is opened
+    virtual bool IsOpened() const;

 
 

-  /* Get data from the clipboard */
-  char *GetClipboardData(char *format, long *length, long time);
+    // set the clipboard data. all other formats will be deleted.
+    virtual bool SetData( 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);
-};
+    // 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 );

 
 

-/* Initialize wxTheClipboard. Can be called repeatedly */
-void WXDLLEXPORT wxInitClipboard(void);
+    // clears wxTheClipboard and the system's clipboard if possible
+    virtual void Clear();

 
 

-/* The clipboard */
-extern wxClipboard* WXDLLEXPORT wxTheClipboard;
+    // 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 // USE_CLIPBOARD
+#endif // wxUSE_CLIPBOARD

 #endif
     // _WX_CLIPBRD_H_
 #endif
     // _WX_CLIPBRD_H_