interface/clipbrd.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        clipbrd.h
   3 // Purpose:     interface of wxClipboard
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxClipboard
  11     @wxheader{clipbrd.h}
  12
  13     A class for manipulating the clipboard. Note that this is not compatible with
  14     the
  15     clipboard class from wxWidgets 1.xx, which has the same name but a different
  16     implementation.
  17
  18     To use the clipboard, you call member functions of the global @b wxTheClipboard
  19     object.
  20
  21     See also the @ref overview_wxdataobjectoverview for further information.
  22
  23     Call wxClipboard::Open to get ownership of the clipboard. If this operation
  24     returns @true, you
  25     now own the clipboard. Call wxClipboard::SetData to put data
  26     on the clipboard, or wxClipboard::GetData to
  27     retrieve data from the clipboard. Call wxClipboard::Close to close
  28     the clipboard and relinquish ownership. You should keep the clipboard open only
  29     momentarily.
  30
  31     For example:
  32
  33     @code
  34     // Write some text to the clipboard
  35       if (wxTheClipboard-Open())
  36       {
  37         // This data objects are held by the clipboard,
  38         // so do not delete them in the app.
  39         wxTheClipboard-SetData( new wxTextDataObject("Some text") );
  40         wxTheClipboard-Close();
  41       }
  42
  43       // Read some text
  44       if (wxTheClipboard-Open())
  45       {
  46         if (wxTheClipboard-IsSupported( wxDF_TEXT ))
  47         {
  48           wxTextDataObject data;
  49           wxTheClipboard-GetData( data );
  50           wxMessageBox( data.GetText() );
  51         }
  52         wxTheClipboard-Close();
  53       }
  54     @endcode
  55
  56     @library{wxcore}
  57     @category{dnd}
  58
  59     @see @ref overview_wxdndoverview, wxDataObject
  60 */
  61 class wxClipboard : public wxObject
  62 {
  63 public:
  64     /**
  65         Constructor.
  66     */
  67     wxClipboard();
  68
  69     /**
  70         Destructor.
  71     */
  72     ~wxClipboard();
  73
  74     /**
  75         Call this function to add the data object to the clipboard. You may call
  76         this function repeatedly after having cleared the clipboard using Clear().
  77         After this function has been called, the clipboard owns the data, so do not
  78         delete
  79         the data explicitly.
  80
  81         @see SetData()
  82     */
  83     bool AddData(wxDataObject* data);
  84
  85     /**
  86         Clears the global clipboard object and the system's clipboard if possible.
  87     */
  88     void Clear();
  89
  90     /**
  91         Call this function to close the clipboard, having opened it with Open().
  92     */
  93     void Close();
  94
  95     /**
  96         Flushes the clipboard: this means that the data which is currently on
  97         clipboard will stay available even after the application exits (possibly
  98         eating memory), otherwise the clipboard will be emptied on exit.
  99         Returns @false if the operation is unsuccessful for any reason.
 100     */
 101     bool Flush();
 102
 103     /**
 104         Call this function to fill @a data with data on the clipboard, if available in
 105         the required
 106         format. Returns @true on success.
 107     */
 108     bool GetData(wxDataObject& data);
 109
 110     /**
 111         Returns @true if the clipboard has been opened.
 112     */
 113     bool IsOpened() const;
 114
 115     /**
 116         Returns @true if there is data which matches the data format of the given data
 117         object currently @b available (IsSupported sounds like a misnomer, FIXME: better deprecate this name?) on the clipboard.
 118     */
 119     bool IsSupported(const wxDataFormat& format);
 120
 121     /**
 122         Returns @true if we are using the primary selection, @false if clipboard
 123         one.
 124         See @ref useprimary() UsePrimarySelection for more information.
 125     */
 126     bool IsUsingPrimarySelection() const;
 127
 128     /**
 129         Call this function to open the clipboard before calling SetData()
 130         and GetData().
 131         Call Close() when you have finished with the clipboard. You
 132         should keep the clipboard open for only a very short time.
 133         Returns @true on success. This should be tested (as in the sample shown above).
 134     */
 135     bool Open();
 136
 137     /**
 138         Call this function to set the data object to the clipboard. This function will
 139         clear all previous contents in the clipboard, so calling it several times
 140         does not make any sense.
 141         After this function has been called, the clipboard owns the data, so do not
 142         delete
 143         the data explicitly.
 144
 145         @see AddData()
 146     */
 147     bool SetData(wxDataObject* data);
 148
 149     /**
 150         On platforms supporting it (all X11-based ports), wxClipboard uses the
 151         CLIPBOARD X11 selection by default. When this function is called with @true
 152         argument, all subsequent clipboard operations will use PRIMARY selection until
 153         this function is called again with @false.
 154         On the other platforms, there is no PRIMARY selection and so all clipboard
 155         operations will fail. This allows to implement the standard X11 handling of the
 156         clipboard which consists in copying data to the CLIPBOARD selection only when
 157         the user explicitly requests it (i.e. by selection @c "Copy" menu
 158         command) but putting the currently selected text into the PRIMARY selection
 159         automatically, without overwriting the normal clipboard contents with the
 160         currently selected text on the other platforms.
 161     */
 162     void UsePrimarySelection(bool primary = true);
 163 };
 164