Detailed Description

wxURLDataObject is a wxDataObject containing an URL and can be used e.g.

when you need to put an URL on or retrieve it from the clipboard:

wxURLDataObject(const wxString &url=wxEmptyString)

Constructor, may be used to initialize the URL.

#define wxTheClipboard

The backwards compatible access macro that returns the global clipboard object pointer.

Definition: clipbrd.h:12

Note: The actual base class of this class is not always wxDataObject itself, but rather either wxDataObjectComposite in wxMSW and wxGTK or wxTextDataObject in the other ports. Please don't rely on the exact base class, it is not guaranteed that it won't change in the future.

Library: wxCore

Public Member Functions
	wxURLDataObject (const wxString &url=wxEmptyString)
	Constructor, may be used to initialize the URL. More...

wxString	GetURL () const
	Returns the URL stored by this object, as a string. More...

void	SetURL (const wxString &url)
	Sets the URL stored by this object. More...

Public Member Functions inherited from wxDataObject
	wxDataObject ()
	Constructor. More...

virtual	~wxDataObject ()
	Destructor. More...

virtual void	GetAllFormats (wxDataFormat *formats, Direction dir=Get) const =0
	Copies all formats supported in the given direction dir to the array pointed to by formats. More...

virtual bool	GetDataHere (const wxDataFormat &format, void *buf) const =0
	The method will write the data of the format format to the buffer buf. More...

virtual size_t	GetDataSize (const wxDataFormat &format) const =0
	Returns the data size of the given format format. More...

virtual size_t	GetFormatCount (Direction dir=Get) const =0
	Returns the number of available formats for rendering or setting the data. More...

virtual wxDataFormat	GetPreferredFormat (Direction dir=Get) const =0
	Returns the preferred format for either rendering the data (if dir is `Get`, its default value) or for setting it. More...

virtual bool	SetData (const wxDataFormat &format, size_t len, const void *buf)
	Set the data in the format format of the length len provided in the buffer buf. More...

bool	IsSupported (const wxDataFormat &format, Direction dir=Get) const
	Returns true if this format is supported. More...

Additional Inherited Members
Public Types inherited from wxDataObject
enum	Direction { Get = 0x01 , Set = 0x02 , Both = 0x03 }

Constructor & Destructor Documentation

wxURLDataObject::wxURLDataObject ( const wxString & url = wxEmptyString )

Constructor, may be used to initialize the URL.

If url is empty, SetURL() can be used later.

wxString wxURLDataObject::GetURL ( ) const

Returns the URL stored by this object, as a string.

void wxURLDataObject::SetURL ( const wxString & url )

Sets the URL stored by this object.