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 Call \helpref{wxClipboard::Open}{wxclipboardopen} to get ownership of the clipboard. If this operation returns TRUE, you
   9 now own the clipboard. Call \helpref{wxClipboard::SetData}{wxclipboardsetdata} to put data
  10 on the clipboard (one or more times), or \helpref{wxClipboard::GetData}{wxclipboardgetdata} to
  11 retrieve data from the clipboard. Call \helpref{wxClipboard::Close}{wxclipboardclose} to close
  12 the clipboard and relinquish ownership. You should keep the clipboard open only momentarily.
  13
  14 For example:
  15
  16 \begin{verbatim}
  17   // Write some text to the clipboard
  18   if (wxTheClipboard->Open())
  19   {
  20     // This object is held by the clipboard, so do not delete it in the app.
  21     wxTextDataObject* object = new wxTextDataObject("Some text");
  22     wxTheClipboard->SetData(& object);
  23     wxTheClipboard->Close();
  24   }
  25
  26   // Read some text
  27   if (wxTheClipboard->Open() && wxTheClipboard->IsSupportedFormat(wxDF_TEXT))
  28   {
  29     wxTextDataObject object;
  30     wxTheClipboard->GetData(& object);
  31     wxTheClipboard->Close();
  32
  33     wxMessageBox(object.GetText());
  34   }
  35 \end{verbatim}
  36
  37 \wxheading{Derived from}
  38
  39 \helpref{wxObject}{wxobject}
  40
  41 \wxheading{See also}
  42
  43 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}
  44
  45 \latexignore{\rtfignore{\wxheading{Members}}}
  46
  47 \membersection{wxClipboard::wxClipboard}
  48
  49 \func{}{wxClipboard}{\void}
  50
  51 Constructor.
  52
  53 \membersection{wxClipboard::\destruct{wxClipboard}}
  54
  55 \func{}{\destruct{wxClipboard}}{\void}
  56
  57 Destructor.
  58
  59 \membersection{wxClipboard::Clear}\label{wxclipboardclear}
  60
  61 \func{void}{Clear}{\void}
  62
  63 Clears the global clipboard object and the system's clipboard if possible.
  64
  65 \membersection{wxClipboard::Close}\label{wxclipboardclose}
  66
  67 \func{bool}{Close}{\void}
  68
  69 Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Close}{wxclipboardclose}.
  70
  71 \membersection{wxClipboard::GetData}\label{wxclipboardgetdata}
  72
  73 \func{bool}{GetData}{\param{wxDataObject*}{ data}}
  74
  75 Call this function to fill {\it data} with data on the clipboard, if available in the required
  76 format.
  77
  78 \membersection{wxClipboard::IsSupportedFormat}\label{wxclipboardissupportedformat}
  79
  80 \func{bool}{IsSupportedFormat}{\param{wxDataFormat}{ format}, \param{const wxString\&}{ id = ""}}
  81
  82 Returns TRUE if the given format is available on the clipboard.
  83
  84 \wxheading{Parameters}
  85
  86 \docparam{format}{The format. See \helpref{wxDataObject}{wxdataobject} for a list of formats.}
  87
  88 \docparam{id}{ If {\it format} is wxDF\_PRIVATE, {\it id} is the identifier of the private data format.}
  89
  90 \membersection{wxClipboard::Open}\label{wxclipboardopen}
  91
  92 \func{bool}{Open}{\void}
  93
  94 Call this function to open the clipboard before calling \helpref{wxClipboard::SetData}{wxclipboardsetdata}
  95 and \helpref{wxClipboard::GetData}{wxclipboardgetdata}.
  96
  97 Call \helpref{wxClipboard::Close}{wxclipboardclose} when you have finished with the clipboard. You
  98 should keep the clipboard open for only a very short time.
  99
 100 \membersection{wxClipboard::SetData}\label{wxclipboardsetdata}
 101
 102 \func{bool}{SetData}{\param{wxDataObject*}{ data}}
 103
 104 Call this function to set a data object to the clipboard. This function can be called several times
 105 to put different formats on the clipboard.
 106