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) wxWidgets Team
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_CLIPBRD_H_BASE_
  13 #define _WX_CLIPBRD_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_CLIPBOARD
  18
  19
  20 #include "wx/object.h"
  21 #include "wx/chartype.h"
  22 #include "wx/vector.h"
  23
  24 class WXDLLIMPEXP_FWD_CORE wxDataFormat;
  25 class WXDLLIMPEXP_FWD_CORE wxDataObject;
  26 class WXDLLIMPEXP_FWD_CORE wxClipboard;
  27
  28 // ----------------------------------------------------------------------------
  29 // wxClipboard represents the system clipboard. Normally, you should use
  30 // wxTheClipboard which is a global pointer to the (unique) clipboard.
  31 //
  32 // Clipboard can be used to copy data to/paste data from. It works together
  33 // with wxDataObject.
  34 // ----------------------------------------------------------------------------
  35
  36 class WXDLLIMPEXP_CORE wxClipboardBase : public wxObject
  37 {
  38 public:
  39     wxClipboardBase() { m_usePrimary = false; }
  40
  41     // open the clipboard before Add/SetData() and GetData()
  42     virtual bool Open() = 0;
  43
  44     // close the clipboard after Add/SetData() and GetData()
  45     virtual void Close() = 0;
  46
  47     // query whether the clipboard is opened
  48     virtual bool IsOpened() const = 0;
  49
  50     // add to the clipboard data
  51     //
  52     // NB: the clipboard owns the pointer and will delete it, so data must be
  53     //     allocated on the heap
  54     virtual bool AddData( wxDataObject *data ) = 0;
  55
  56     // set the clipboard data, this is the same as Clear() followed by
  57     // AddData()
  58     virtual bool SetData( wxDataObject *data ) = 0;
  59
  60     // ask if data in correct format is available
  61     virtual bool IsSupported( const wxDataFormat& format ) = 0;
  62
  63     // fill data with data on the clipboard (if available)
  64     virtual bool GetData( wxDataObject& data ) = 0;
  65
  66     // clears wxTheClipboard and the system's clipboard if possible
  67     virtual void Clear() = 0;
  68
  69     // flushes the clipboard: this means that the data which is currently on
  70     // clipboard will stay available even after the application exits (possibly
  71     // eating memory), otherwise the clipboard will be emptied on exit
  72     virtual bool Flush() { return false; }
  73
  74     // this allows to choose whether we work with CLIPBOARD (default) or
  75     // PRIMARY selection on X11-based systems
  76     //
  77     // on the other ones, working with primary selection does nothing: this
  78     // allows to write code which sets the primary selection when something is
  79     // selected without any ill effects (i.e. without overwriting the
  80     // clipboard which would be wrong on the platforms without X11 PRIMARY)
  81     virtual void UsePrimarySelection(bool usePrimary = false)
  82     {
  83         m_usePrimary = usePrimary;
  84     }
  85
  86     // return true if we're using primary selection
  87     bool IsUsingPrimarySelection() const { return m_usePrimary; }
  88
  89     // Returns global instance (wxTheClipboard) of the object:
  90     static wxClipboard *Get();
  91
  92
  93     // don't use this directly, it is public for compatibility with some ports
  94     // (wxX11, wxMotif, ...) only
  95     bool m_usePrimary;
  96 };
  97
  98 // ----------------------------------------------------------------------------
  99 // asynchronous clipboard event
 100 // ----------------------------------------------------------------------------
 101
 102 class WXDLLIMPEXP_CORE wxClipboardEvent : public wxEvent
 103 {
 104 public:
 105     wxClipboardEvent(wxEventType commandType = wxEVT_NULL)
 106         : wxEvent(0,commandType)
 107         { }
 108
 109     wxClipboardEvent(const wxClipboardEvent& event)
 110         : wxEvent(event),
 111           m_formats(event.m_formats)
 112         { }
 113
 114     bool SupportsFormat( const wxDataFormat &format ) const;
 115     void AddFormat( const wxDataFormat &format );
 116
 117     virtual wxEvent *Clone() const { return new wxClipboardEvent(*this); }
 118
 119 protected:
 120     wxVector<wxDataFormat> m_formats;
 121
 122 private:
 123     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardEvent)
 124 };
 125
 126 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_CLIPBOARD_CHANGED;
 127
 128 typedef void (wxEvtHandler::*wxClipboardEventFunction)(wxClipboardEvent&);
 129
 130 #define wxClipboardEventHandler(func) \
 131     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxClipboardEventFunction, &func)
 132
 133 #define EVT_CLIPBOARD_CHANGED(func) wx__DECLARE_EVT0(wxEVT_CLIPBOARD_CHANGED, wxClipboardEventHandler(func))
 134
 135 // ----------------------------------------------------------------------------
 136 // globals
 137 // ----------------------------------------------------------------------------
 138
 139 // The global clipboard object - backward compatible access macro:
 140 #define wxTheClipboard   (wxClipboard::Get())
 141
 142 // ----------------------------------------------------------------------------
 143 // include platform-specific class declaration
 144 // ----------------------------------------------------------------------------
 145
 146 #if defined(__WXMSW__)
 147     #include "wx/msw/clipbrd.h"
 148 #elif defined(__WXMOTIF__)
 149     #include "wx/motif/clipbrd.h"
 150 #elif defined(__WXGTK20__)
 151     #include "wx/gtk/clipbrd.h"
 152 #elif defined(__WXGTK__)
 153     #include "wx/gtk1/clipbrd.h"
 154 #elif defined(__WXX11__)
 155     #include "wx/x11/clipbrd.h"
 156 #elif defined(__WXMGL__)
 157     #include "wx/mgl/clipbrd.h"
 158 #elif defined(__WXMAC__)
 159     #include "wx/osx/clipbrd.h"
 160 #elif defined(__WXCOCOA__)
 161     #include "wx/cocoa/clipbrd.h"
 162 #elif defined(__WXPM__)
 163     #include "wx/os2/clipbrd.h"
 164 #endif
 165
 166 // ----------------------------------------------------------------------------
 167 // helpful class for opening the clipboard and automatically closing it
 168 // ----------------------------------------------------------------------------
 169
 170 class WXDLLIMPEXP_CORE wxClipboardLocker
 171 {
 172 public:
 173     wxClipboardLocker(wxClipboard *clipboard = (wxClipboard *)NULL)
 174     {
 175         m_clipboard = clipboard ? clipboard : wxTheClipboard;
 176         if ( m_clipboard )
 177         {
 178             m_clipboard->Open();
 179         }
 180     }
 181
 182     bool operator!() const { return !m_clipboard->IsOpened(); }
 183
 184     ~wxClipboardLocker()
 185     {
 186         if ( m_clipboard )
 187         {
 188             m_clipboard->Close();
 189         }
 190     }
 191
 192 private:
 193     wxClipboard *m_clipboard;
 194
 195     DECLARE_NO_COPY_CLASS(wxClipboardLocker)
 196 };
 197
 198 #endif // wxUSE_CLIPBOARD
 199
 200 #endif // _WX_CLIPBRD_H_BASE_