include/wx/clipbrd.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/clipbrd.h
   3 // Purpose:     wxClipboad class and clipboard functions
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     19.10.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWindows Team
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_CLIPBRD_H_BASE_
  13 #define _WX_CLIPBRD_H_BASE_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "clipboardbase.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_CLIPBOARD
  22
  23
  24 #include "wx/object.h"
  25 #include "wx/wxchar.h"
  26
  27 class WXDLLEXPORT wxDataFormat;
  28 class WXDLLEXPORT wxDataObject;
  29
  30 // ----------------------------------------------------------------------------
  31 // wxClipboard represents the system clipboard. Normally, you should use
  32 // wxTheClipboard which is a global pointer to the (unique) clipboard.
  33 //
  34 // Clipboard can be used to copy data to/paste data from. It works together
  35 // with wxDataObject.
  36 // ----------------------------------------------------------------------------
  37
  38 class WXDLLEXPORT wxClipboardBase : public wxObject
  39 {
  40 public:
  41     wxClipboardBase();
  42
  43     // open the clipboard before Add/SetData() and GetData()
  44     virtual bool Open() = 0;
  45
  46     // close the clipboard after Add/SetData() and GetData()
  47     virtual void Close() = 0;
  48
  49     // query whether the clipboard is opened
  50     virtual bool IsOpened() const = 0;
  51
  52     // add to the clipboard data
  53     //
  54     // NB: the clipboard owns the pointer and will delete it, so data must be
  55     //     allocated on the heap
  56     virtual bool AddData( wxDataObject *data ) = 0;
  57
  58     // set the clipboard data, this is the same as Clear() followed by
  59     // AddData()
  60     virtual bool SetData( wxDataObject *data ) = 0;
  61
  62     // ask if data in correct format is available
  63     virtual bool IsSupported( const wxDataFormat& format ) = 0;
  64
  65     // fill data with data on the clipboard (if available)
  66     virtual bool GetData( wxDataObject& data ) = 0;
  67
  68     // clears wxTheClipboard and the system's clipboard if possible
  69     virtual void Clear() = 0;
  70
  71     // flushes the clipboard: this means that the data which is currently on
  72     // clipboard will stay available even after the application exits (possibly
  73     // eating memory), otherwise the clipboard will be emptied on exit
  74     virtual bool Flush() { return FALSE; }
  75
  76     // X11 has two clipboards which get selected by this call. Empty on MSW.
  77     virtual void UsePrimarySelection( bool WXUNUSED(primary) = FALSE ) { }
  78
  79 };
  80
  81 // ----------------------------------------------------------------------------
  82 // include platform-specific class declaration
  83 // ----------------------------------------------------------------------------
  84
  85 #if defined(__WXMSW__)
  86     #include "wx/msw/clipbrd.h"
  87 #elif defined(__WXMOTIF__)
  88     #include "wx/motif/clipbrd.h"
  89 #elif defined(__WXGTK__)
  90     #include "wx/gtk/clipbrd.h"
  91 #elif defined(__WXMGL__)
  92     #include "wx/mgl/clipbrd.h"
  93 #elif defined(__WXMAC__)
  94     #include "wx/mac/clipbrd.h"
  95 #elif defined(__WXPM__)
  96     #include "wx/os2/clipbrd.h"
  97 #elif defined(__WXSTUBS__)
  98     #include "wx/stubs/clipbrd.h"
  99 #endif
 100
 101 // ----------------------------------------------------------------------------
 102 // globals
 103 // ----------------------------------------------------------------------------
 104
 105 // The global clipboard object
 106 WXDLLEXPORT_DATA(extern wxClipboard *) wxTheClipboard;
 107
 108 // ----------------------------------------------------------------------------
 109 // helpful class for opening the clipboard and automatically closing it
 110 // ----------------------------------------------------------------------------
 111
 112 class WXDLLEXPORT wxClipboardLocker
 113 {
 114 public:
 115     wxClipboardLocker(wxClipboard *clipboard = (wxClipboard *)NULL)
 116     {
 117         m_clipboard = clipboard ? clipboard : wxTheClipboard;
 118         if ( m_clipboard )
 119         {
 120             m_clipboard->Open();
 121         }
 122     }
 123
 124     bool operator!() const { return !m_clipboard->IsOpened(); }
 125
 126     ~wxClipboardLocker()
 127     {
 128         if ( m_clipboard )
 129         {
 130             m_clipboard->Close();
 131         }
 132     }
 133
 134 private:
 135     wxClipboard *m_clipboard;
 136 };
 137
 138 #endif // wxUSE_CLIPBOARD
 139
 140 #endif // _WX_CLIPBRD_H_BASE_