From c959d9122863e4a8e6a780217e43a6f2b68bafc3 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Wed, 23 Aug 2006 13:47:22 +0000 Subject: [PATCH] documented wxURLDataObject git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@40773 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/category.tex | 1 + docs/latex/wx/classes.tex | 1 + docs/latex/wx/urldataob.tex | 66 +++++++++++++++++++++++++++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 docs/latex/wx/urldataob.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index a4843b42e2..1a6ceda264 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -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} diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 4c8ef85674..40f5af0b1a 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -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 diff --git a/docs/latex/wx/urldataob.tex b/docs/latex/wx/urldataob.tex new file mode 100644 index 0000000000..688ed2634b --- /dev/null +++ b/docs/latex/wx/urldataob.tex @@ -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} + + + +\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. + -- 2.45.2