include/wx/x11/clipbrd.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/x11/clipbrd.h
   3 // Purpose:     Clipboard functionality.
   4 // Author:      Robert Roebling
   5 // Created:     17/09/98
   6 // Copyright:   (c) Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_X11_CLIPBRD_H_
  11 #define _WX_X11_CLIPBRD_H_
  12
  13 #if wxUSE_CLIPBOARD
  14
  15 #include "wx/object.h"
  16 #include "wx/list.h"
  17 #include "wx/dataobj.h"
  18 #include "wx/control.h"
  19 #include "wx/module.h"
  20
  21 // ----------------------------------------------------------------------------
  22 // wxClipboard
  23 // ----------------------------------------------------------------------------
  24
  25 class WXDLLIMPEXP_CORE wxClipboard : public wxClipboardBase
  26 {
  27 public:
  28     wxClipboard();
  29     virtual ~wxClipboard();
  30
  31     // open the clipboard before SetData() and GetData()
  32     virtual bool Open();
  33
  34     // close the clipboard after SetData() and GetData()
  35     virtual void Close();
  36
  37     // query whether the clipboard is opened
  38     virtual bool IsOpened() const;
  39
  40     // set the clipboard data. all other formats will be deleted.
  41     virtual bool SetData( wxDataObject *data );
  42
  43     // add to the clipboard data.
  44     virtual bool AddData( wxDataObject *data );
  45
  46     // ask if data in correct format is available
  47     virtual bool IsSupported( const wxDataFormat& format );
  48
  49     // fill data with data on the clipboard (if available)
  50     virtual bool GetData( wxDataObject& data );
  51
  52     // clears wxTheClipboard and the system's clipboard if possible
  53     virtual void Clear();
  54
  55     // implementation from now on
  56     bool              m_open;
  57     bool              m_ownsClipboard;
  58     bool              m_ownsPrimarySelection;
  59     wxDataObject     *m_data;
  60
  61     WXWindow          m_clipboardWidget;  /* for getting and offering data */
  62     WXWindow          m_targetsWidget;    /* for getting list of supported formats */
  63     bool              m_waiting;          /* querying data or formats is asynchronous */
  64
  65     bool              m_formatSupported;
  66     Atom              m_targetRequested;
  67     wxDataObject     *m_receivedData;
  68
  69 private:
  70     DECLARE_DYNAMIC_CLASS(wxClipboard)
  71 };
  72
  73 #endif // wxUSE_CLIPBOARD
  74
  75 #endif // _WX_X11_CLIPBRD_H_