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::AddData}{wxclipboardadddata} 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 data objects are held by the clipboard,
  21     // so do not delete them in the app.
  22     wxTheClipboard->AddData( new wxTextDataObject("Some text") );
  23     wxTheClipboard->Close();
  24   }
  25
  26   // Read some text
  27   if (wxTheClipboard->Open())
  28   {
  29     if (wxTheClipboard->IsSupported( "STRING" ))
  30     {
  31       wxTextDataObject data;
  32       wxTheClipboard->GetData( &data );
  33       wxMessageBox( data.GetText() );
  34     }
  35     wxTheClipboard->Close();
  36   }
  37 \end{verbatim}
  38
  39 \wxheading{Derived from}
  40
  41 \helpref{wxObject}{wxobject}
  42
  43 \wxheading{Include files}
  44
  45 <wx/clipbrd.h>
  46
  47 \wxheading{See also}
  48
  49 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}
  50
  51 \latexignore{\rtfignore{\wxheading{Members}}}
  52
  53 \membersection{wxClipboard::wxClipboard}
  54
  55 \func{}{wxClipboard}{\void}
  56
  57 Constructor.
  58
  59 \membersection{wxClipboard::\destruct{wxClipboard}}
  60
  61 \func{}{\destruct{wxClipboard}}{\void}
  62
  63 Destructor.
  64
  65 \membersection{wxClipboard::AddData}\label{wxclipboardadddata}
  66
  67 \func{bool}{AddData}{\param{wxDataObject*}{ data}}
  68
  69 Call this function to add a data object to the clipboard. This function can be called several times
  70 to put different formats on the clipboard.
  71
  72 \membersection{wxClipboard::Clear}\label{wxclipboardclear}
  73
  74 \func{void}{Clear}{\void}
  75
  76 Clears the global clipboard object and the system's clipboard if possible.
  77
  78 \membersection{wxClipboard::Close}\label{wxclipboardclose}
  79
  80 \func{bool}{Close}{\void}
  81
  82 Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Open}{wxclipboardopen}.
  83
  84 \membersection{wxClipboard::GetData}\label{wxclipboardgetdata}
  85
  86 \func{bool}{GetData}{\param{wxDataObject*}{ data}}
  87
  88 Call this function to fill {\it data} with data on the clipboard, if available in the required
  89 format. Returns TRUE on success.
  90
  91 \membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}
  92
  93 \func{bool}{IsSupported}{\param{wxDataFormat}{ format}}
  94
  95 Returns TRUE if the format of the given data object is available on the clipboard.
  96
  97 \membersection{wxClipboard::Open}\label{wxclipboardopen}
  98
  99 \func{bool}{Open}{\void}
 100
 101 Call this function to open the clipboard before calling \helpref{wxClipboard::SetData}{wxclipboardsetdata}
 102 and \helpref{wxClipboard::GetData}{wxclipboardgetdata}.
 103
 104 Call \helpref{wxClipboard::Close}{wxclipboardclose} when you have finished with the clipboard. You
 105 should keep the clipboard open for only a very short time.
 106
 107 Returns TRUE on success. This should be tested (as in the sample shown above).
 108
 109 \membersection{wxClipboard::SetData}\label{wxclipboardsetdata}
 110
 111 \func{bool}{SetData}{\param{wxDataObject*}{ data}}
 112
 113 Call this function to set the data object to the clipboard. This function will
 114 clear all previous contents in the clipboard, so calling it several times
 115 does not make any sense.
 116
 117 \membersection{wxClipboard::UsePrimarySelection}\label{wxclipboarduseprimary}
 118
 119 \func{void}{UsePrimarySelection}{\param{bool}{ primary = TRUE}}
 120
 121 On platforms supporting it (currently only GTK), selects the so called
 122 PRIMARY SELECTION as the clipboard as opposed to the normal clipboard,
 123 if {\it primary} is TRUE.
 124
 125