documented wxURLDataObject

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@40773 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2006-08-23 13:47:22 +00:00
parent 0463eea95d
commit c959d91228
3 changed files with 68 additions and 0 deletions

View File

@@ -475,6 +475,7 @@ facilities.
\twocolitem{\helpref{wxTextDataObject}{wxtextdataobject}}{Text data object class}
\twocolitem{\helpref{wxFileDataObject}{wxfiledataobject}}{File data object class}
\twocolitem{\helpref{wxBitmapDataObject}{wxbitmapdataobject}}{Bitmap data object class}
\twocolitem{\helpref{wxURLDataObject}{wxurldataobject}}{URL data object class}
\twocolitem{\helpref{wxCustomDataObject}{wxcustomdataobject}}{Custom data object class}
\twocolitem{\helpref{wxClipboard}{wxclipboard}}{Clipboard class}
\twocolitem{\helpref{wxDropTarget}{wxdroptarget}}{Drop target class}

View File

@@ -391,6 +391,7 @@
\input upduievt.tex
\input uri.tex
\input url.tex
\input urldataob.tex
\input validatr.tex
\input variant.tex
\input view.tex

View File

@@ -0,0 +1,66 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name: urldataob.tex
%% Purpose: wxURLDataObject documentation
%% Author: Vadim Zeitlin
%% Created: 2006-08-23
%% RCS-ID: $Id$
%% Copyright: (c) 2006 Vadim Zeitlin
%% License: wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{\class{wxURLDataObject}}\label{wxurldataobject}
wxURLDataObject is a \helpref{wxDataObject}{wxdataobject} containing an URL
and can be used e.g. when you need to put an URL on or retrieve it from the
clipboard:
\begin{verbatim}
wxTheClipboard->SetData(new wxURLDataObject(url));
\end{verbatim}
\wxheading{Derived from}
Under MSW:
\helpref{wxDataObjectComposite}{wxdataobjectcomposite}\\
\helpref{wxDataObject}{wxdataobject}
Under the other platforms:
\helpref{wxTextDataObject}{wxtextdataobject}\\
\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
\helpref{wxDataObject}{wxdataobject}
\wxheading{Include files}
<wx/dataobj.h>
\wxheading{See also}
\helpref{Clipboard and drag and drop overview}{wxdndoverview},\\
\helpref{wxDataObject}{wxdataobject}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxURLDataObject::wxURLDataObject}\label{wxurldataobjectctor}
\func{}{wxURLDataObject}{\param{const wxString\& }{url = wxEmptyString}}
Constructor, may be used to initialize the URL. If \arg{url} is empty,
\helpref{SetURL}{wxurldataobjectseturl} can be used later.
\membersection{wxURLDataObject::GetURL}\label{wxurldataobjectgeturl}
\constfunc{wxString}{GetURL}{\void}
Returns the URL stored by this object, as a string.
\membersection{wxURLDataObject::SetURL}\label{wxurldataobjectseturl}
\func{void}{SetURL}{\param{const wxString\& }{url}}
Sets the URL stored by this object.