include/wx/x11/clipbrd.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        clipbrd.h
   3 // Purpose:     Clipboard functionality.
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_CLIPBRD_H_
  13 #define _WX_CLIPBRD_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "clipbrd.h"
  17 #endif
  18
  19 #if wxUSE_CLIPBOARD
  20
  21 #include "wx/list.h"
  22
  23 bool WXDLLEXPORT wxOpenClipboard();
  24 bool WXDLLEXPORT wxClipboardOpen();
  25 bool WXDLLEXPORT wxCloseClipboard();
  26 bool WXDLLEXPORT wxEmptyClipboard();
  27 bool WXDLLEXPORT wxIsClipboardFormatAvailable(wxDataFormat dataFormat);
  28 bool WXDLLEXPORT wxSetClipboardData(wxDataFormat dataFormat, wxObject *obj, int width = 0, int height = 0);
  29 wxObject* WXDLLEXPORT wxGetClipboardData(wxDataFormat dataFormat, long *len = NULL);
  30 wxDataFormat WXDLLEXPORT wxEnumClipboardFormats(wxDataFormat dataFormat);
  31 wxDataFormat WXDLLEXPORT wxRegisterClipboardFormat(char *formatName);
  32 bool WXDLLEXPORT wxGetClipboardFormatName(wxDataFormat dataFormat, char *formatName, int maxCount);
  33
  34 //-----------------------------------------------------------------------------
  35 // wxClipboard
  36 //-----------------------------------------------------------------------------
  37
  38 class wxClipboard : public wxClipboardBase
  39 {
  40 public:
  41     wxClipboard();
  42     ~wxClipboard();
  43
  44     // open the clipboard before SetData() and GetData()
  45     virtual bool Open();
  46
  47     // close the clipboard after SetData() and GetData()
  48     virtual void Close();
  49
  50     // opened?
  51     virtual bool IsOpened() const { return m_open; }
  52
  53     // replaces the data on the clipboard with data
  54     virtual bool SetData( wxDataObject *data );
  55
  56     // adds data to the clipboard
  57     virtual bool AddData( wxDataObject *data );
  58
  59     // format available on the clipboard ?
  60     virtual bool IsSupported( const wxDataFormat& format );
  61
  62     // fill data with data on the clipboard (if available)
  63     virtual bool GetData( wxDataObject& data );
  64
  65     // clears wxTheClipboard and the system's clipboard if possible
  66     virtual void Clear();
  67
  68     virtual void UsePrimarySelection(bool primary = TRUE)
  69     { m_usePrimary = primary; }
  70
  71     // implementation from now on
  72
  73     bool              m_open;
  74     wxList            m_data;
  75     bool              m_usePrimary;
  76
  77 private:
  78     DECLARE_DYNAMIC_CLASS(wxClipboard)
  79 };
  80
  81 #endif // wxUSE_CLIPBOARD
  82
  83 #endif
  84 // _WX_CLIPBRD_H_