Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

KFileMetaData::UserMetaData Class

The UserMetaData class can be used to read and set user meta data of files. More...

• Header: #include <KFileMetaData/UserMetaData>
• CMake: find_package(KF6 REQUIRED COMPONENTS FileMetaData)
target_link_libraries(mytarget PRIVATE KF6::FileMetaData)

List of all members, including inherited members
Deprecated members

#Public Types

• enum UserMetaData::Attribute
• enum UserMetaData::Error

#Public Functions

• UserMetaData(const QString &filePath)
• QString attribute(const QString &name) const (since 6.2)
• QString filePath() const
• bool hasAttribute(const QString &name) const (since 6.2)
• bool isSupported() const
• QString originEmailMessageId() const
• QString originEmailSender() const
• QString originEmailSubject() const
• QUrl originUrl() const
• KFileMetaData::UserMetaData::Attributes queryAttributes(KFileMetaData::UserMetaData::Attributes attributes = Attribute::Any) const
• int rating() const
• KFileMetaData::UserMetaData::Error setAttribute(const QString &name, const QString &value)
• KFileMetaData::UserMetaData::Error setOriginEmailMessageId(const QString &originEmailMessageId)
• KFileMetaData::UserMetaData::Error setOriginEmailSender(const QString &originEmailSender)
• KFileMetaData::UserMetaData::Error setOriginEmailSubject(const QString &originEmailSubject)
• KFileMetaData::UserMetaData::Error setOriginUrl(const QUrl &originUrl)
• KFileMetaData::UserMetaData::Error setRating(int rating)
• KFileMetaData::UserMetaData::Error setTags(const QStringList &tags)
• KFileMetaData::UserMetaData::Error setUserComment(const QString &userComment)
• QStringList tags() const
• QString userComment() const

#Detailed Description

#Member Type Documentation

#enum UserMetaData::Attribute

flags UserMetaData::Attributes

Constant
KFileMetaData::UserMetaData::None	0x0
KFileMetaData::UserMetaData::Any	None
KFileMetaData::UserMetaData::Tags	0x1
KFileMetaData::UserMetaData::Rating	0x2
KFileMetaData::UserMetaData::Comment	0x4
KFileMetaData::UserMetaData::OriginUrl	0x8
KFileMetaData::UserMetaData::OriginEmailSubject	0x10
KFileMetaData::UserMetaData::OriginEmailSender	0x20
KFileMetaData::UserMetaData::OriginEmailMessageId	0x40
KFileMetaData::UserMetaData::Other	0xffffff80
KFileMetaData::UserMetaData::All	0xffffffff

The Attributes type is a typedef for QFlags<Attribute>. It stores an OR combination of Attribute values.

#enum UserMetaData::Error

Constant	Value	Description
KFileMetaData::UserMetaData::NoError	0	i.e. Success
KFileMetaData::UserMetaData::UnknownError (since Qt 6.2)	1	An error that's not currently handled specifically
KFileMetaData::UserMetaData::NotSupported (since Qt 6.2)	2	Underlying filesystem does not provide extended attributes features
KFileMetaData::UserMetaData::NoSpace (since Qt 6.2)	3	There is insufficient space remaining to store the extended attribute
KFileMetaData::UserMetaData::MissingPermission (since Qt 6.2)	4	Process doesn't have write permission to the file or the file is marked append-only
KFileMetaData::UserMetaData::ValueTooBig (since Qt 6.2)	5	The value size exceeds the maximum size allowed per-value (64 kB for Linux VFS
KFileMetaData::UserMetaData::NameToolong (since Qt 6.2)	6	The attribute name is too long (255 bytes for Linux VFS)

#Member Function Documentation

#UserMetaData::UserMetaData(const QString &filePath)

#[since 6.2] QString UserMetaData::attribute(const QString &name) const

This function was introduced in Qt 6.2.

#QString UserMetaData::filePath() const

#[since 6.2] bool UserMetaData::hasAttribute(const QString &name) const

This function was introduced in Qt 6.2.

#bool UserMetaData::isSupported() const

#QString UserMetaData::originEmailMessageId() const

See also setOriginEmailMessageId()

#QString UserMetaData::originEmailSender() const

See also setOriginEmailSender()

#QString UserMetaData::originEmailSubject() const

See also setOriginEmailSubject()

#QUrl UserMetaData::originUrl() const

See also setOriginUrl()

#KFileMetaData::UserMetaData::Attributes UserMetaData::queryAttributes(KFileMetaData::UserMetaData::Attributes attributes = Attribute::Any) const

* Query list of available attributes * * Checks for the availability of the given attributes. May return * a superset of the input value when the file has attributes set * beyond the requested ones. * * If the input attribute mask is Attribute::Any, either Attribute::None * (the file has no user attributes) or Attribute::All (the file has at * least one attribute set) is returned. * *

#int UserMetaData::rating() const

See also setRating()

#KFileMetaData::UserMetaData::Error UserMetaData::setAttribute(const QString &name, const QString &value)

See also attribute()

#KFileMetaData::UserMetaData::Error UserMetaData::setOriginEmailMessageId(const QString &originEmailMessageId)

See also originEmailMessageId()

#KFileMetaData::UserMetaData::Error UserMetaData::setOriginEmailSender(const QString &originEmailSender)

See also originEmailSender()

#KFileMetaData::UserMetaData::Error UserMetaData::setOriginEmailSubject(const QString &originEmailSubject)

See also originEmailSubject()

#KFileMetaData::UserMetaData::Error UserMetaData::setOriginUrl(const QUrl &originUrl)

See also originUrl()

#KFileMetaData::UserMetaData::Error UserMetaData::setRating(int rating)

See also rating()

#KFileMetaData::UserMetaData::Error UserMetaData::setTags(const QStringList &tags)

See also tags()

#KFileMetaData::UserMetaData::Error UserMetaData::setUserComment(const QString &userComment)

See also userComment()

#QStringList UserMetaData::tags() const

See also setTags()

#QString UserMetaData::userComment() const

See also setUserComment()