KUrl::List is a QList that contains KUrls with a few convenience methods. More...

#include <KUrl>

Inherits QList< KUrl >.

Public Types
enum	DecodeOptions { PreferLocalUrls, PreferKdeUrls }
Public Member Functions
	List ()
	List (const KUrl &url)
	List (const QList< KUrl > &list)
	List (const QStringList &list)
	operator QVariant () const
void	populateMimeData (QMimeData *mimeData, const KUrl::MetaDataMap &metaData=MetaDataMap(), MimeDataFlags flags=DefaultMimeDataFlags) const
void	populateMimeData (const KUrl::List &mostLocalUrls, QMimeData *mimeData, const KUrl::MetaDataMap &metaData=MetaDataMap(), MimeDataFlags flags=DefaultMimeDataFlags) const
QStringList	toStringList (KUrl::AdjustPathOption trailing) const
QStringList	toStringList () const
Static Public Member Functions
static bool	canDecode (const QMimeData *mimeData)
static KUrl::List	fromMimeData (const QMimeData mimeData, DecodeOptions decodeOptions, KUrl::MetaDataMap metaData=0)
static KUrl::List	fromMimeData (const QMimeData mimeData, KUrl::MetaDataMap metaData=0)
static QStringList	mimeDataTypes ()

Detailed Description

KUrl::List is a QList that contains KUrls with a few convenience methods.

See also:: KUrl; QList

Definition at line 146 of file kurl.h.

Member Enumeration Documentation

enum KUrl::List::DecodeOptions

Flags to be used in fromMimeData.

Since:: 4.2.3

Enumerator:

PreferLocalUrls

When the mimedata contains both KDE-style URLs (eg: desktop:/foo) and the "most local" version of the URLs (eg: file:///home/dfaure/Desktop/foo), decode it as local urls.

Useful in paste/drop operations that end up calling KIO, so that urls from other users work as well.

PreferKdeUrls

When the mimedata contains both KDE-style URLs (eg: desktop:/foo) and the "most local" version of the URLs (eg: file:///home/dfaure/Desktop/foo), decode it as the KDE-style URL.

Useful in DnD code e.g. when moving icons, and the kde-style url is used as identifier for the icons.

Definition at line 277 of file kurl.h.

Constructor & Destructor Documentation

KUrl::List::List ( ) [inline]

Creates an empty List.

Definition at line 152 of file kurl.h.

KUrl::List::List ( const KUrl & url )

Creates a list that contains the given URL as only item.

Parameters:

url	the url to add.

Definition at line 185 of file kurl.cpp.

KUrl::List::List ( const QStringList & list )

Creates a list that contains the URLs from the given list of strings.

Parameters:

list	the list containing the URLs as strings

Definition at line 195 of file kurl.cpp.

KUrl::List::List ( const QList< KUrl > & list )

Creates a list that contains the URLs from the given QList<KUrl>.

Parameters:

list	the list containing the URLs

Definition at line 190 of file kurl.cpp.

Member Function Documentation

bool KUrl::List::canDecode ( const QMimeData * mimeData ) [static]

Return true if mimeData contains URI data.

Definition at line 293 of file kurl.cpp.

KUrl::List KUrl::List::fromMimeData	(	const QMimeData *	mimeData,
		KUrl::MetaDataMap *	metaData = `0`
	)		`[static]`

Extract a list of KUrls from the contents of mimeData.

Decoding will fail if mimeData does not contain any URLs, or if at least one extracted URL is not valid.

Parameters:

mimeData	the mime data to extract from; cannot be 0
metaData	optional pointer to a map holding the metadata

Returns:: the list of urls

Definition at line 363 of file kurl.cpp.

KUrl::List KUrl::List::fromMimeData	(	const QMimeData *	mimeData,
		DecodeOptions	decodeOptions,
		KUrl::MetaDataMap *	metaData = `0`
	)		`[static]`

Extract a list of KUrls from the contents of mimeData.

Decoding will fail if mimeData does not contain any URLs, or if at least one extracted URL is not valid.

Parameters:

mimeData	the mime data to extract from; cannot be 0
decodeOptions	options for decoding
metaData	optional pointer to a map holding the metadata

Returns:: the list of urls

Since:: 4.2.3

Definition at line 305 of file kurl.cpp.

QStringList KUrl::List::mimeDataTypes ( ) [static]

Return the list of mimeTypes that can be decoded by fromMimeData.

Definition at line 299 of file kurl.cpp.

KUrl::List::operator QVariant ( ) const

Converts this KUrl::List to a QVariant, this allows to use KUrl::List in QVariant() constructor.

Definition at line 368 of file kurl.cpp.

void KUrl::List::populateMimeData	(	const KUrl::List &	mostLocalUrls,
		QMimeData *	mimeData,
		const KUrl::MetaDataMap &	metaData = `MetaDataMap()`,
		MimeDataFlags	flags = `DefaultMimeDataFlags`
	)		const

Adds URLs into the given QMimeData.

This should add both the KDE-style URLs (eg: desktop:/foo) and the "most local" version of the URLs (eg: file:///home/jbloggs/Desktop/foo) to the mimedata.

This method should be called on the KDE-style URLs.

 QMimeData* mimeData = new QMimeData();

 KUrl::List kdeUrls;
 kdeUrls << "desktop:/foo";
 kdeUrls << "desktop:/bar";

 KUrl::List normalUrls;
 normalUrls << "file:///home/jbloggs/Desktop/foo";
 normalUrls << "file:///home/jbloggs/Desktop/bar";

 kdeUrls.populateMimeData(normalUrls, mimeData);

Parameters:

mostLocalUrls	the "most local" urls
mimeData	the mime data object to populate
metaData	KIO metadata shipped in the mime data, which is used for instance to set a correct HTTP referrer (some websites require it for downloading e.g. an image)
flags	set NoTextExport to prevent setting plain/text data into `mimeData`. In such a case, `setExportAsText(false)` should be called.

Since:: 4.2

Definition at line 282 of file kurl.cpp.

void KUrl::List::populateMimeData	(	QMimeData *	mimeData,
		const KUrl::MetaDataMap &	metaData = `MetaDataMap()`,
		MimeDataFlags	flags = `DefaultMimeDataFlags`
	)		const

Adds URLs data into the given QMimeData.

By default, populateMimeData 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 adding other mime data which provides better plain text data.

WARNING: do not call this method multiple times on the same mimedata object, you can add urls only once. But you can add other things, e.g. images, XML...

Parameters:

mimeData	the QMimeData instance used to drag or copy this URL
metaData	KIO metadata shipped in the mime data, which is used for instance to set a correct HTTP referrer (some websites require it for downloading e.g. an image)
flags	set NoTextExport to prevent setting plain/text data into `mimeData` In such a case, setExportAsText( false ) should be called.

Definition at line 242 of file kurl.cpp.

QStringList KUrl::List::toStringList ( ) const

Converts the URLs of this list to a list of strings.

Returns:: the list of strings

Definition at line 205 of file kurl.cpp.

QStringList KUrl::List::toStringList ( KUrl::AdjustPathOption trailing ) const

Converts the URLs of this list to a list of strings.

Parameters:

trailing use to add or remove a trailing slash to/from the path.

Returns:: the list of strings

Since:: 4.6

Definition at line 210 of file kurl.cpp.

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

KDECore

KUrl::List Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

KDECore

kdelibs