KURLDrag Class Reference

This class is to be used instead of QUriDrag when using KURL. More...

#include <kurldrag.h>

Inheritance diagram for KURLDrag:


Public Member Functions
virtual QByteArray	encodedData (const char *mime) const
virtual const char *	format (int i) const
	KURLDrag (const KURL::List &urls, const QMap< QString, QString > &metaData, QWidget dragSource=0, const char name=0)
	KURLDrag (const KURL::List &urls, QWidget dragSource=0, const char name=0)
QMap< QString, QString > &	metaData ()
void	setExportAsText (bool exp)
virtual	~KURLDrag ()
Static Public Member Functions
static bool	decode (const QMimeSource *e, KURL::List &urls, QMap< QString, QString > &metaData)
static bool	decode (const QMimeSource *e, KURL::List &urls)
static KURLDrag *	newDrag (const KURL::List &urls, const QMap< QString, QString > &metaData, QWidget dragSource=0, const char name=0) KDE_DEPRECATED
static KURLDrag *	newDrag (const KURL::List &urls, QWidget dragSource=0, const char name=0) KDE_DEPRECATED
static KURL	stringToUrl (const QCString &s)
static QString	urlToString (const KURL &url)
Protected Member Functions
	KURLDrag (const QStrList &urls, const QMap< QString, QString > &metaData, QWidget dragSource, const char name) KDE_DEPRECATED

Detailed Description

This class is to be used instead of QUriDrag when using KURL.

The reason is: QUriDrag (and the XDND/W3C standards) expect URLs to be encoded in UTF-8 (unicode), but KURL uses the current locale by default. The other reasons for using this class are:

it exports text/plain (for dropping/pasting into lineedits, mails etc.)
it has support for metadata, shipped as part of the dragobject This is important, for instance to set a correct HTTP referrer (some websites require it for downloading e.g. an image).

To create a drag object, use the KURLDrag constructor. To handle drops, use QUriDrag::canDecode() and KURLDrag::decode()

Definition at line 44 of file kurldrag.h.

Constructor & Destructor Documentation

KURLDrag::KURLDrag	(	const KURL::List &	urls,
		QWidget *	dragSource = `0`,
		const char *	name = `0`
	)

Constructs an object to drag the list of URLs in urls.

The dragSource and name arguments are passed on to QUriDrag, and the list of urls is converted to UTF-8 before being passed to QUriDrag.

Parameters:

	urls	the list of URLs
	dragSource	the parent of the QObject. Should be set when doing drag-n-drop, but should be 0 when copying to the clipboard
	name	the name of the QObject

Definition at line 37 of file kurldrag.cpp.

KURLDrag::KURLDrag	(	const KURL::List &	urls,
		const QMap< QString, QString > &	metaData,
		QWidget *	dragSource = `0`,
		const char *	name = `0`
	)

Constructs an object to drag the list of URLs in urls.

This version also includes metadata.

Parameters:

	urls	the list of URLs
	metaData	a map containing meta data
	dragSource	the parent of the QObject. Should be set when doing drag-n-drop, but should be 0 when copying to the clipboard
	name	the name of the QObject

See also:: metaData()

Definition at line 43 of file kurldrag.cpp.

KURLDrag::~KURLDrag ( ) [virtual]

Definition at line 50 of file kurldrag.cpp.

KURLDrag::KURLDrag	(	const QStrList &	urls,
		const QMap< QString, QString > &	metaData,
		QWidget *	dragSource,
		const char *	name
	)			`[protected]`

Deprecated:: Use a KURLDrag constructor with a KURL::List

Definition at line 292 of file kurldrag.cpp.

Member Function Documentation

bool KURLDrag::decode	(	const QMimeSource *	e,
		KURL::List &	urls,
		QMap< QString, QString > &	metaData
	)			`[static]`

Convenience method that decodes the contents of e into a list of KURLs and a set of metadata.

Decoding will fail if at least one decoded value is not a valid KURL. You should be using this one, if possible.

Parameters:

	e	the mime source
	urls	the list of urls will be written here
	metaData	the metadata map will be written here

Returns:: true if successful, false otherwise

Definition at line 127 of file kurldrag.cpp.

bool KURLDrag::decode	(	const QMimeSource *	e,
		KURL::List &	urls
	)			`[static]`

Convenience method that decodes the contents of e into a list of KURLs.

Decoding will fail if at least one decoded value is not a valid KURL.

Parameters:

	e	the mime source
	urls	the list of urls will be written here

Returns:: true if successful, false otherwise

Definition at line 87 of file kurldrag.cpp.

QByteArray KURLDrag::encodedData ( const char * mime ) const [virtual]

Reimplemented from superclass.

Definition at line 190 of file kurldrag.cpp.

const char * KURLDrag::format ( int i ) const [virtual]

Reimplemented from superclass.

Definition at line 173 of file kurldrag.cpp.

QMap<QString, QString>& KURLDrag::metaData ( ) [inline]

Meta-data to associate with those URLs.

This is an alternative way of setting the metadata: either use the constructor to pass it all at once, or use drag->metaData()["key"] = data;

See also:: KIO::TransferJob

Definition at line 100 of file kurldrag.h.

KURLDrag * KURLDrag::newDrag	(	const KURL::List &	urls,
		const QMap< QString, QString > &	metaData,
		QWidget *	dragSource = `0`,
		const char *	name = `0`
	)			`[static]`

Deprecated:: Is equivalent with "new KURLDrag(urls, metaData, dragSource, name)".

Definition at line 81 of file kurldrag.cpp.

KURLDrag * KURLDrag::newDrag	(	const KURL::List &	urls,
		QWidget *	dragSource = `0`,
		const char *	name = `0`
	)			`[static]`

Deprecated:: Is equivalent with "new KURLDrag(urls, dragSource, name)".

Definition at line 76 of file kurldrag.cpp.

void KURLDrag::setExportAsText ( bool exp )

By default, KURLDrag also exports the URLs as plain text, for e.g.

dropping onto a text editor. But in some cases this might not be wanted, e.g. if using the KURLDrag in a KMultipleDrag and another component of the multiple-drag provides better plain text data. In such a case, setExportAsText( false ) should be called.

Since:: 3.4

Definition at line 68 of file kurldrag.cpp.

KURL KURLDrag::stringToUrl ( const QCString & s ) [static]

Converts a string used for dragging to a URL.

Since:: 3.2

Definition at line 253 of file kurldrag.cpp.

QString KURLDrag::urlToString ( const KURL & url ) [static]

Converts a URL to a string representation suitable for dragging.

Since:: 3.2

Definition at line 261 of file kurldrag.cpp.

The documentation for this class was generated from the following files:

KDECore

KURLDrag Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

KDECore

API Reference