include/wx/x11/clipbrd.h

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