docs/latex/wx/dobjcomp.tex

   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:     wxWidgets 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{See also}
  40
  41 \helpref{Clipboard and drag and drop overview}{wxdndoverview},
  42 \helpref{wxDataObject}{wxdataobject},
  43 \helpref{wxDataObjectSimple}{wxdataobjectsimple},
  44 \helpref{wxFileDataObject}{wxfiledataobject},
  45 \helpref{wxTextDataObject}{wxtextdataobject},
  46 \helpref{wxBitmapDataObject}{wxbitmapdataobject}
  47
  48 \latexignore{\rtfignore{\wxheading{Members}}}
  49
  50 \membersection{wxDataObjectComposite::wxDataObjectComposite}\label{wxdataobjectcompositewxdataobjectcomposite}
  51
  52 \func{}{wxDataObjectComposite}{\void}
  53
  54 The default constructor.
  55
  56 \membersection{wxDataObjectComposite::Add}\label{wxdataobjectcompositeadd}
  57
  58 \func{void}{Add}{
  59     \param{wxDataObjectSimple }{*dataObject},
  60     \param{bool }{preferred = false}}
  61
  62 Adds the {\it dataObject} to the list of supported objects and it becomes the
  63 preferred object if {\it preferred} is true.
  64
  65