docs/latex/wx/urldataob.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        urldataob.tex
   3 %% Purpose:     wxURLDataObject documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Created:     2006-08-23
   6 %% RCS-ID:      $Id$
   7 %% Copyright:   (c) 2006 Vadim Zeitlin
   8 %% License:     wxWindows license
   9 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  10
  11 \section{\class{wxURLDataObject}}\label{wxurldataobject}
  12
  13 wxURLDataObject is a \helpref{wxDataObject}{wxdataobject} containing an URL
  14 and can be used e.g. when you need to put an URL on or retrieve it from the
  15 clipboard:
  16 \begin{verbatim}
  17     wxTheClipboard->SetData(new wxURLDataObject(url));
  18 \end{verbatim}
  19
  20
  21 \wxheading{Derived from}
  22
  23 Under MSW:
  24
  25 \helpref{wxDataObjectComposite}{wxdataobjectcomposite}\\
  26 \helpref{wxDataObject}{wxdataobject}
  27
  28 Under the other platforms:
  29
  30 \helpref{wxTextDataObject}{wxtextdataobject}\\
  31 \helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
  32 \helpref{wxDataObject}{wxdataobject}
  33
  34 \wxheading{Include files}
  35
  36 <wx/dataobj.h>
  37
  38 \wxheading{See also}
  39
  40 \helpref{Clipboard and drag and drop overview}{wxdndoverview},\\
  41 \helpref{wxDataObject}{wxdataobject}
  42
  43
  44 \latexignore{\rtfignore{\wxheading{Members}}}
  45
  46 \membersection{wxURLDataObject::wxURLDataObject}\label{wxurldataobjectctor}
  47
  48 \func{}{wxURLDataObject}{\param{const wxString\& }{url = wxEmptyString}}
  49
  50 Constructor, may be used to initialize the URL. If \arg{url} is empty,
  51 \helpref{SetURL}{wxurldataobjectseturl} can be used later.
  52
  53
  54 \membersection{wxURLDataObject::GetURL}\label{wxurldataobjectgeturl}
  55
  56 \constfunc{wxString}{GetURL}{\void}
  57
  58 Returns the URL stored by this object, as a string.
  59
  60
  61 \membersection{wxURLDataObject::SetURL}\label{wxurldataobjectseturl}
  62
  63 \func{void}{SetURL}{\param{const wxString\& }{url}}
  64
  65 Sets the URL stored by this object.
  66