include/wx/motif/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 #if wxUSE_CLIPBOARD
  16
  17 class WXDLLIMPEXP_CORE wxDataObject;
  18 struct wxDataIdToDataObject;
  19
  20 #include "wx/list.h"
  21
  22 WX_DECLARE_LIST(wxDataObject, wxDataObjectList);
  23 WX_DECLARE_LIST(wxDataIdToDataObject, wxDataIdToDataObjectList);
  24
  25 bool WXDLLEXPORT wxOpenClipboard();
  26 bool WXDLLEXPORT wxClipboardOpen();
  27 bool WXDLLEXPORT wxCloseClipboard();
  28 bool WXDLLEXPORT wxEmptyClipboard();
  29 bool WXDLLEXPORT wxIsClipboardFormatAvailable(wxDataFormat dataFormat);
  30 bool WXDLLEXPORT wxSetClipboardData(wxDataFormat dataFormat, wxObject *obj, int width = 0, int height = 0);
  31 wxObject* WXDLLEXPORT wxGetClipboardData(wxDataFormat dataFormat, long *len = NULL);
  32 wxDataFormat WXDLLEXPORT wxEnumClipboardFormats(wxDataFormat dataFormat);
  33 wxDataFormat WXDLLEXPORT wxRegisterClipboardFormat(char *formatName);
  34 bool WXDLLEXPORT wxGetClipboardFormatName(wxDataFormat dataFormat, char *formatName, int maxCount);
  35
  36 //-----------------------------------------------------------------------------
  37 // wxClipboard
  38 //-----------------------------------------------------------------------------
  39
  40 class WXDLLIMPEXP_CORE wxClipboard : public wxClipboardBase
  41 {
  42 public:
  43     wxClipboard();
  44     ~wxClipboard();
  45
  46     // open the clipboard before SetData() and GetData()
  47     virtual bool Open();
  48
  49     // close the clipboard after SetData() and GetData()
  50     virtual void Close();
  51
  52     // opened?
  53     virtual bool IsOpened() const { return m_open; }
  54
  55     // replaces the data on the clipboard with data
  56     virtual bool SetData( wxDataObject *data );
  57
  58     // adds data to the clipboard
  59     virtual bool AddData( wxDataObject *data );
  60
  61     // format available on the clipboard ?
  62     virtual bool IsSupported( const wxDataFormat& format );
  63
  64     // fill data with data on the clipboard (if available)
  65     virtual bool GetData( wxDataObject& data );
  66
  67     // clears wxTheClipboard and the system's clipboard if possible
  68     virtual void Clear();
  69
  70     virtual void UsePrimarySelection(bool primary = true)
  71     { m_usePrimary = primary; }
  72
  73     // implementation from now on
  74     bool              m_open;
  75     wxDataObjectList  m_data;
  76     bool              m_usePrimary;
  77     wxDataIdToDataObjectList m_idToObject;
  78
  79 private:
  80     DECLARE_DYNAMIC_CLASS(wxClipboard)
  81 };
  82
  83 #endif // wxUSE_CLIPBOARD
  84
  85 #endif
  86 // _WX_CLIPBRD_H_