KUrlMimeData Namespace Reference
from PyKDE5.kcoreaddons.KUrlMimeData import *
Detailed Description
Utility functions for using URLs in QMimeData. In addition to QMimeData.setUrls() and QMimeData.urls(), these functions allow to:
- Store two sets of URLs, the KDE-specific URLs and the equivalent local-file URLs for compatibility with non-KDE applications - Store KIO metadata, such as the HTTP referrer for a given URL (some websites require it for downloading e.g. an image)
- Since:
- 5.0
Enumerations | |
DecodeOptions | { PreferLocalUrls, PreferKdeUrls } |
Functions | |
QStringList | mimeDataTypes () |
setMetaData ({QString:QString} metaData, QMimeData mimeData) | |
setUrls ([QUrl] urls, [QUrl] mostLocalUrls, QMimeData mimeData) | |
[QUrl] | urlsFromMimeData (QMimeData mimeData, KUrlMimeData::DecodeOptions decodeOptions=KUrlMimeData.DecodeOptions.PreferKdeUrls, {QString:QString} metaData=0) |
Enumeration Documentation
DecodeOptions |
Flags to be used in urlsFromMimeData.
- Enumerator:
-
PreferLocalUrls PreferKdeUrls
Function Documentation
QStringList mimeDataTypes | ( | ) |
Return the list of mimeTypes that can be decoded by urlsFromMimeData
setMetaData | ( | {QString:QString} | metaData, | |
QMimeData | mimeData | |||
) |
- Parameters:
-
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)
setUrls | ( | [QUrl] | urls, | |
[QUrl] | mostLocalUrls, | |||
QMimeData | mimeData | |||
) |
Adds URLs and KIO metadata into the given QMimeData.
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
[QUrl] urlsFromMimeData | ( | QMimeData | mimeData, | |
KUrlMimeData::DecodeOptions | decodeOptions=KUrlMimeData.DecodeOptions.PreferKdeUrls, | |||
{QString:QString} | metaData=0 | |||
) |
Extract a list of urls from the contents of mimeData.
Compared to QMimeData.urls(), this method has support for retrieving KDE-specific URLs when urls() would retrieve "most local URLs" instead.
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 which will hold the metadata after this call
- Returns:
- the list of urls