Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

KBookmark::List Class

Bookmarks management library. More...

• Header: #include <List>
• CMake: find_package(KF6 REQUIRED COMPONENTS Bookmarks)
target_link_libraries(mytarget PRIVATE KF6::Bookmarks)
• Inherits: QList

List of all members, including inherited members

#Public Functions

• List()
• void populateMimeData(QMimeData *mimeData) const

#Static Public Members

• bool canDecode(const QMimeData *mimeData)
• KBookmark::List fromMimeData(const QMimeData *mimeData, QDomDocument &parentDocument)
• QStringList mimeDataTypes()

#Detailed Description

KBookmark::List is a QList that contains bookmarks with a few convenience methods.

See also KBookmark, QList

#Member Function Documentation

#List::List()

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

Return true if mimeData contains bookmarks

#[static] KBookmark::List List::fromMimeData(const QMimeData *mimeData, QDomDocument &parentDocument)

Extract a list of bookmarks from the contents of mimeData. Decoding will fail if mimeData does not contain any bookmarks.

mimeData the mime data to extract from; cannot be 0

parentDocument pass an empty QDomDocument here, it will be used as container for the bookmarks. You just need to make sure it stays alive longer (or just as long) as the returned bookmarks.

Returns the list of bookmarks

#[static] QStringList List::mimeDataTypes()

Return the list of mimeTypes that can be decoded by fromMimeData

#void List::populateMimeData(QMimeData *mimeData) const

Adds this list of bookmark into the given QMimeData.

mimeData the QMimeData instance used to drag or copy this bookmark