docs/latex/wx/clipbrd.tex

   1 \section{\class{wxClipboard}}\label{wxclipboard}
   2
   3 A class for manipulating the clipboard. Note that this is not compatible with the
   4 clipboard class from wxWindows 1.xx, which has the same name but a different implementation.
   5
   6 To use the clipboard, you call member functions of the global {\bf wxTheClipboard} object.
   7
   8 See also the \helpref{wxDataObject overview}{wxdataobjectoverview} for further information.
   9
  10 Call \helpref{wxClipboard::Open}{wxclipboardopen} to get ownership of the clipboard. If this operation returns TRUE, you
  11 now own the clipboard. Call \helpref{wxClipboard::SetData}{wxclipboardsetdata} to put data
  12 on the clipboard, or \helpref{wxClipboard::GetData}{wxclipboardgetdata} to
  13 retrieve data from the clipboard. Call \helpref{wxClipboard::Close}{wxclipboardclose} to close
  14 the clipboard and relinquish ownership. You should keep the clipboard open only momentarily.
  15
  16 For example:
  17
  18 \begin{verbatim}
  19   // Write some text to the clipboard
  20   if (wxTheClipboard->Open())
  21   {
  22     // This data objects are held by the clipboard,
  23     // so do not delete them in the app.
  24     wxTheClipboard->SetData( new wxTextDataObject("Some text") );
  25     wxTheClipboard->Close();
  26   }
  27
  28   // Read some text
  29   if (wxTheClipboard->Open())
  30   {
  31     if (wxTheClipboard->IsSupported( wxDF_TEXT ))
  32     {
  33       wxTextDataObject data;
  34       wxTheClipboard->GetData( data );
  35       wxMessageBox( data.GetText() );
  36     }
  37     wxTheClipboard->Close();
  38   }
  39 \end{verbatim}
  40
  41 \wxheading{Derived from}
  42
  43 \helpref{wxObject}{wxobject}
  44
  45 \wxheading{Include files}
  46
  47 <wx/clipbrd.h>
  48
  49 \wxheading{See also}
  50
  51 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}
  52
  53 \latexignore{\rtfignore{\wxheading{Members}}}
  54
  55 \membersection{wxClipboard::wxClipboard}
  56
  57 \func{}{wxClipboard}{\void}
  58
  59 Constructor.
  60
  61 \membersection{wxClipboard::\destruct{wxClipboard}}
  62
  63 \func{}{\destruct{wxClipboard}}{\void}
  64
  65 Destructor.
  66
  67 \membersection{wxClipboard::AddData}\label{wxclipboardadddata}
  68
  69 \func{bool}{AddData}{\param{wxDataObject*}{ data}}
  70
  71 Call this function to add the data object to the clipboard. You may call
  72 this function repeatedly after having cleared the clipboard using \helpref{wxClipboard::Clear}{wxclipboardclear}.
  73
  74 After this function has been called, the clipboard owns the data, so do not delete
  75 the data explicitly.
  76
  77 \wxheading{See also}
  78
  79 \helpref{wxClipboard::SetData}{wxclipboardsetdata}
  80
  81 \membersection{wxClipboard::Clear}\label{wxclipboardclear}
  82
  83 \func{void}{Clear}{\void}
  84
  85 Clears the global clipboard object and the system's clipboard if possible.
  86
  87 \membersection{wxClipboard::Close}\label{wxclipboardclose}
  88
  89 \func{bool}{Close}{\void}
  90
  91 Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Open}{wxclipboardopen}.
  92
  93 \membersection{wxClipboard::GetData}\label{wxclipboardgetdata}
  94
  95 \func{bool}{GetData}{\param{wxDataObject\&}{ data}}
  96
  97 Call this function to fill {\it data} with data on the clipboard, if available in the required
  98 format. Returns TRUE on success.
  99
 100 \membersection{wxClipboard::IsOpened}\label{wxclipboardisopened}
 101
 102 \constfunc{bool}{IsOpened}{\void}
 103
 104 Returns TRUE if the clipboard has been opened.
 105
 106 \membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}
 107
 108 \func{bool}{IsSupported}{\param{const wxDataFormat\&}{ format}}
 109
 110 Returns TRUE if the format of the given data object is available on the clipboard.
 111
 112 \membersection{wxClipboard::Open}\label{wxclipboardopen}
 113
 114 \func{bool}{Open}{\void}
 115
 116 Call this function to open the clipboard before calling \helpref{wxClipboard::SetData}{wxclipboardsetdata}
 117 and \helpref{wxClipboard::GetData}{wxclipboardgetdata}.
 118
 119 Call \helpref{wxClipboard::Close}{wxclipboardclose} when you have finished with the clipboard. You
 120 should keep the clipboard open for only a very short time.
 121
 122 Returns TRUE on success. This should be tested (as in the sample shown above).
 123
 124 \membersection{wxClipboard::SetData}\label{wxclipboardsetdata}
 125
 126 \func{bool}{SetData}{\param{wxDataObject*}{ data}}
 127
 128 Call this function to set the data object to the clipboard. This function will
 129 clear all previous contents in the clipboard, so calling it several times
 130 does not make any sense.
 131
 132 After this function has been called, the clipboard owns the data, so do not delete
 133 the data explicitly.
 134
 135 \wxheading{See also}
 136
 137 \helpref{wxClipboard::AddData}{wxclipboardadddata}
 138
 139 \membersection{wxClipboard::UsePrimarySelection}\label{wxclipboarduseprimary}
 140
 141 \func{void}{UsePrimarySelection}{\param{bool}{ primary = TRUE}}
 142
 143 On platforms supporting it (currently only GTK), selects the so called
 144 PRIMARY SELECTION as the clipboard as opposed to the normal clipboard,
 145 if {\it primary} is TRUE.
 146
 147