Added possibility of 2-step initialisation, and wxWIZARD_EX_HELPBUTTON style.

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

diff --git a/include/wx/motif/clipbrd.h b/include/wx/motif/clipbrd.h
index 5c33021f49447e9873712f5aba3260db8a5f2700..e0baf4a4ac5eee6f526f8bdd0bcd70fb72853dc5 100644 (file)
--- a/include/wx/motif/clipbrd.h
+++ b/include/wx/motif/clipbrd.h
@@ -1,26 +1,22 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        clipbrd.h
 // Purpose:     Clipboard functionality.
-//              Note: this functionality is under review, and
-//              is derived from wxWindows 1.xx code. Please contact
-//              the wxWindows developers for further information.
 // Author:      Julian Smart
 // Modified by:
 // Created:     17/09/98
 // 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"
+    #pragma interface "clipbrd.h"
 #endif
 
-#include "wx/defs.h"
-#include "wx/setup.h"
+#if wxUSE_CLIPBOARD
 
 #include "wx/list.h"
 
@@ -28,77 +24,61 @@ bool WXDLLEXPORT wxOpenClipboard();
 bool WXDLLEXPORT wxClipboardOpen();
 bool WXDLLEXPORT wxCloseClipboard();
 bool WXDLLEXPORT wxEmptyClipboard();
-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);
-
-/* A clipboard client holds data belonging to the clipboard.
-   For plain text, a client is not necessary. */
-class WXDLLEXPORT wxClipboardClient : public wxObject
+bool WXDLLEXPORT wxIsClipboardFormatAvailable(wxDataFormat dataFormat);
+bool WXDLLEXPORT wxSetClipboardData(wxDataFormat dataFormat, wxObject *obj, int width = 0, int height = 0);
+wxObject* WXDLLEXPORT wxGetClipboardData(wxDataFormat dataFormat, long *len = NULL);
+wxDataFormat WXDLLEXPORT wxEnumClipboardFormats(wxDataFormat dataFormat);
+wxDataFormat WXDLLEXPORT wxRegisterClipboardFormat(char *formatName);
+bool WXDLLEXPORT wxGetClipboardFormatName(wxDataFormat dataFormat, char *formatName, int maxCount);
+
+//-----------------------------------------------------------------------------
+// wxClipboard
+//-----------------------------------------------------------------------------
+
+class wxClipboard : public wxClipboardBase
 {
-  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() = 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;
-};
+public:
+    wxClipboard();
+    ~wxClipboard();
 
-/* ONE instance of this class: */
-class WXDLLEXPORT wxClipboard : public wxObject
-{
-  DECLARE_DYNAMIC_CLASS(wxClipboard)
+    // open the clipboard before SetData() and GetData()
+    virtual bool Open();
 
- public:
-  wxClipboardClient *clipOwner;
-  char *cbString, *sentString, *receivedString;
-  void *receivedTargets;
-  long receivedLength;
+    // close the clipboard after SetData() and GetData()
+    virtual void Close();
 
-  wxClipboard();
-  ~wxClipboard();
+    // opened?
+    virtual bool IsOpened() const { return m_open; }
 
-  /* Set the clipboard data owner. "time" comes from the event record. */
-  void SetClipboardClient(wxClipboardClient *, long time);
+    // replaces the data on the clipboard with data
+    virtual bool SetData( wxDataObject *data );
 
-  /* Set the clipboard string; does not require a client. */
-  void SetClipboardString(char *, long time);
+    // adds data to the clipboard
+    virtual bool AddData( wxDataObject *data );
 
-  /* Get data from the clipboard in the format "TEXT". */
-  char *GetClipboardString(long time);
+    // format available on the clipboard ?
+    virtual bool IsSupported( const wxDataFormat& format );
 
-  /* Get data from the clipboard */
-  char *GetClipboardData(char *format, long *length, long time);
+    // fill data with data on the clipboard (if available)
+    virtual bool GetData( 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();
-};
+    // clears wxTheClipboard and the system's clipboard if possible
+    virtual void Clear();
+
+    virtual void UsePrimarySelection(bool primary = TRUE)
+        { m_usePrimary = primary; }
 
-/* Initialize wxTheClipboard. Can be called repeatedly */
-void WXDLLEXPORT wxInitClipboard();
+    // implementation from now on
+
+    bool              m_open;
+    wxList            m_data;
+    bool              m_usePrimary;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxClipboard)
+};
 
-/* The clipboard */
-WXDLLEXPORT_DATA(extern wxClipboard*) wxTheClipboard;
+#endif // wxUSE_CLIPBOARD
 
 #endif
     // _WX_CLIPBRD_H_