include/wx/cocoa/clipbrd.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/cocoa/clipboard.h
   3 // Purpose:     wxClipboard
   4 // Author:      David Elliott <dfe@cox.net>
   5 // Modified by:
   6 // Created:     2003/07/23
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 David Elliott
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef __WX_COCOA_CLIPBRD_H__
  13 #define __WX_COCOA_CLIPBRD_H__
  14
  15 #include "wx/dataobj.h"
  16
  17 //=========================================================================
  18 // wxClipboard
  19 //=========================================================================
  20 class wxClipboard : public wxClipboardBase
  21 {
  22     DECLARE_DYNAMIC_CLASS(wxClipboard)
  23 public:
  24     wxClipboard();
  25     ~wxClipboard();
  26
  27     // open the clipboard before SetData() and GetData()
  28     virtual bool Open();
  29
  30     // close the clipboard after SetData() and GetData()
  31     virtual void Close();
  32
  33     // query whether the clipboard is opened
  34     virtual bool IsOpened() const;
  35
  36     // set the clipboard data. all other formats will be deleted.
  37     virtual bool SetData( wxDataObject *data );
  38
  39     // add to the clipboard data.
  40     virtual bool AddData( wxDataObject *data );
  41
  42     // ask if data in correct format is available
  43     virtual bool IsSupported( const wxDataFormat& format );
  44
  45     // fill data with data on the clipboard (if available)
  46     virtual bool GetData( wxDataObject& data );
  47
  48     // clears wxTheClipboard and the system's clipboard if possible
  49     virtual void Clear();
  50 };
  51
  52 #endif //__WX_COCOA_CLIPBRD_H__