| 1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2 | %% Name: dobjcomp.tex |
| 3 | %% Purpose: wxDataObjectComposite documentation |
| 4 | %% Author: Vadim Zeitlin |
| 5 | %% Modified by: |
| 6 | %% Created: 02.11.99 |
| 7 | %% RCS-ID: $Id$ |
| 8 | %% Copyright: (c) Vadim Zeitlin |
| 9 | %% License: wxWindows license |
| 10 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 11 | |
| 12 | \section{\class{wxDataObjectComposite}}\label{wxdataobjectcomposite} |
| 13 | |
| 14 | wxDataObjectComposite is the simplest |
| 15 | \helpref{wxDataObject}{wxdataobject} derivation which may be used to support |
| 16 | multiple formats. It contains several |
| 17 | \helpref{wxDataObjectSimple}{wxdataobjectsimple} objects and supports any |
| 18 | format supported by at least one of them. Only one of these data objects is |
| 19 | {\it preferred} (the first one if not explicitly changed by using the second |
| 20 | parameter of \helpref{Add}{wxdataobjectcompositeadd}) and its format determines |
| 21 | the preferred format of the composite data object as well. |
| 22 | |
| 23 | See \helpref{wxDataObject}{wxdataobject} documentation for the reasons why you |
| 24 | might prefer to use wxDataObject directly instead of wxDataObjectComposite for |
| 25 | efficiency reasons. |
| 26 | |
| 27 | \wxheading{Virtual functions to override} |
| 28 | |
| 29 | None, this class should be used directly. |
| 30 | |
| 31 | \wxheading{Derived from} |
| 32 | |
| 33 | \helpref{wxDataObject}{wxdataobject} |
| 34 | |
| 35 | \wxheading{Include files} |
| 36 | |
| 37 | <wx/dataobj.h> |
| 38 | |
| 39 | \wxheading{Library} |
| 40 | |
| 41 | \helpref{wxCore}{librarieslist} |
| 42 | |
| 43 | \wxheading{See also} |
| 44 | |
| 45 | \helpref{Clipboard and drag and drop overview}{wxdndoverview}, |
| 46 | \helpref{wxDataObject}{wxdataobject}, |
| 47 | \helpref{wxDataObjectSimple}{wxdataobjectsimple}, |
| 48 | \helpref{wxFileDataObject}{wxfiledataobject}, |
| 49 | \helpref{wxTextDataObject}{wxtextdataobject}, |
| 50 | \helpref{wxBitmapDataObject}{wxbitmapdataobject} |
| 51 | |
| 52 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 53 | |
| 54 | \membersection{wxDataObjectComposite::wxDataObjectComposite}\label{wxdataobjectcompositewxdataobjectcomposite} |
| 55 | |
| 56 | \func{}{wxDataObjectComposite}{\void} |
| 57 | |
| 58 | The default constructor. |
| 59 | |
| 60 | \membersection{wxDataObjectComposite::Add}\label{wxdataobjectcompositeadd} |
| 61 | |
| 62 | \func{void}{Add}{ |
| 63 | \param{wxDataObjectSimple }{*dataObject}, |
| 64 | \param{bool }{preferred = false}} |
| 65 | |
| 66 | Adds the {\it dataObject} to the list of supported objects and it becomes the |
| 67 | preferred object if {\it preferred} is true. |
| 68 | |
| 69 | |
| 70 | \membersection{wxDataObjectComposite::GetReceivedFormat}\label{wxdataobjectcompositegetreceivedformat} |
| 71 | |
| 72 | \constfunc{wxDataFormat}{GetReceivedFormat}{} |
| 73 | |
| 74 | Report the format passed to the SetData method. This should be the |
| 75 | format of the data object within the composite that recieved data from |
| 76 | the clipboard or the DnD operation. You can use this method to find |
| 77 | out what kind of data object was recieved. |
| 78 | |