Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk1/clipbrd.h b/include/wx/gtk1/clipbrd.h
index aa46abbb0057ddc26e5a382339936a152105a581..b75f62860592a8b34751150665a5d080c688e0e4 100644 (file)
--- a/include/wx/gtk1/clipbrd.h
+++ b/include/wx/gtk1/clipbrd.h
@@ -1,71 +1,78 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        clipboard.h
+// Name:        wx/gtk1/clipbrd.h
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
 #ifndef __GTKCLIPBOARDH__
 #define __GTKCLIPBOARDH__
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#if wxUSE_CLIPBOARD
 
-#include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/list.h"
+#include "wx/dataobj.h"
 #include "wx/control.h"
-#include "wx/dnd.h"      // for wxDataObject
+#include "wx/module.h"
 
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// wxClipboard
+// ----------------------------------------------------------------------------
 
-class wxClipboard;
+class WXDLLIMPEXP_CORE wxClipboard : public wxClipboardBase
+{
+public:
+    wxClipboard();
+    virtual ~wxClipboard();
 
-//-----------------------------------------------------------------------------
-// global functions
-//-----------------------------------------------------------------------------
+    // open the clipboard before SetData() and GetData()
+    virtual bool Open();
 
-void wxInitClipboard();
-void wxDoneClipboard();
+    // close the clipboard after SetData() and GetData()
+    virtual void Close();
 
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
+    // query whether the clipboard is opened
+    virtual bool IsOpened() const;
 
-extern wxClipboard* wxTheClipboard;
+    // set the clipboard data. all other formats will be deleted.
+    virtual bool SetData( wxDataObject *data );
 
-//-----------------------------------------------------------------------------
-// wxClipboard
-//-----------------------------------------------------------------------------
+    // add to the clipboard data.
+    virtual bool AddData( wxDataObject *data );
 
-class  wxClipboard: public wxObject
-{
-  DECLARE_DYNAMIC_CLASS(wxClipboard)
+    // ask if data in correct format is available
+    virtual bool IsSupported( const wxDataFormat& format );
 
-public:
- 
-  wxClipboard();
-  ~wxClipboard();
-
-  virtual void SetData( wxDataObject *data );
-  virtual void *GetData( wxDataFormat format, size_t *length );
-  virtual bool IsAvailable( wxDataFormat format );
-
- // implementation 
-  
-  wxDataObject  *m_data;
-  char          *m_sentString, 
-               *m_receivedString;
-  void          *m_receivedTargets;
-  size_t         m_receivedLength;
-  GtkWidget     *m_clipboardWidget;
+    // 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 from now on
+    bool              m_open;
+    bool              m_ownsClipboard;
+    bool              m_ownsPrimarySelection;
+    wxDataObject     *m_data;
+
+    GtkWidget        *m_clipboardWidget;  /* for getting and offering data */
+    GtkWidget        *m_targetsWidget;    /* for getting list of supported formats */
+    bool              m_waiting;          /* querying data or formats is asynchronous */
+
+    bool              m_formatSupported;
+    GdkAtom           m_targetRequested;
+    wxDataObject     *m_receivedData;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxClipboard)
 };
 
+#endif
+   // wxUSE_CLIPBOARD
+
 #endif
     // __GTKCLIPBOARDH__