KFileMetaInfo Class Reference

#include <kfilemetainfo.h>

Public Types
enum	What {   Fastest = 0x1, TechnicalInfo = 0x4, ContentInfo = 0x8, ExternalSources = 0x10,   Thumbnail = 0x20, LinkedData = 0x80, Everything = 0xffff }
typedef QFlags< What >	WhatFlags

Public Member Functions
	KFileMetaInfo ()
	KFileMetaInfo (const KFileMetaInfo &)
	KFileMetaInfo (const QString &path, const QString &mimetype=QString(), WhatFlags w=Everything)
	KFileMetaInfo (const QUrl &url)
	~KFileMetaInfo ()
bool	applyChanges ()
KFileMetaInfoGroupList	groups () const
bool	isValid () const
KFileMetaInfoItem &	item (const QString &key)
const KFileMetaInfoItem &	item (const QString &key) const
const QHash< QString, KFileMetaInfoItem > &	items () const
QStringList	keys () const
KFileMetaInfo &	operator= (KFileMetaInfo const &kfmi)
KFileMetaInfoGroupList	preferredGroups () const
QStringList	preferredKeys () const
KFileMetaInfoGroupList	supportedGroups () const
QStringList	supportedKeys () const
QUrl	url () const

Detailed Description

KFileMetaInfo provides metadata extracted from a file or other resource.

When instantiating an instance of this class, the metadata related to it will be retrieved and stored in the instance. The data can be inspected through KFileMetaInfoItem objects.

Definition at line 58 of file kfilemetainfo.h.

Member Enumeration Documentation

What

enum KFileMetaInfo::What

This is used to specify what a KFileMetaInfo object should read, so you can specify if you want to read "expensive" items or not.

This is like a preset which can be customized by passing additional parameters to constructors.

Enumerator
Fastest	do the fastest possible read and omit all items that might need a significantly longer time than the others
TechnicalInfo	extract technical details about the file, like e.g. play time, resolution or a compressioni type
ContentInfo	read information about the content of the file like comments or id3 tags
ExternalSources	read external metadata sources such as filesystem based extended attributes if they are supported for the filesystem; RDF storages etc
Thumbnail	only read the file's thumbnail, if it contains one
Everything	read everything, even if it might take a while

Definition at line 67 of file kfilemetainfo.h.

Constructor & Destructor Documentation

KFileMetaInfo() [1/4]

KFileMetaInfo::KFileMetaInfo ( const QString &  path, const QString &  mimetype = QString(), KFileMetaInfo::WhatFlags  w = Everything  )

explicit

Construct a KFileMetaInfo that contains metainformation about the resource pointed to by path.

When w is not Everything, a limit of 64kbytes is imposed on the file size.

Definition at line 293 of file kfilemetainfo.cpp.

KFileMetaInfo() [2/4]

KFileMetaInfo::KFileMetaInfo

(

const QUrl &

url

)

Construct a KFileMetaInfo that contains metainformation about the resource pointed to by url.

Note

that c'tor is not thread-safe

Definition at line 311 of file kfilemetainfo.cpp.

KFileMetaInfo() [3/4]

KFileMetaInfo::KFileMetaInfo

(

)

Construct an empty, invalid KFileMetaInfo instance.

Definition at line 324 of file kfilemetainfo.cpp.

KFileMetaInfo() [4/4]

KFileMetaInfo::KFileMetaInfo

(

const KFileMetaInfo &

k

)

Construct a KFileMetaInfo instance from another one.

Definition at line 328 of file kfilemetainfo.cpp.

~KFileMetaInfo()

KFileMetaInfo::~KFileMetaInfo

(

)

Destructor.

Definition at line 338 of file kfilemetainfo.cpp.

Member Function Documentation

applyChanges()

bool KFileMetaInfo::applyChanges

(

)

Save the changes made to this KFileMetaInfo instance.

Definition at line 342 of file kfilemetainfo.cpp.

items()

const QHash< QString, KFileMetaInfoItem > & KFileMetaInfo::items

(

)

const

Retrieve all the items.

Definition at line 367 of file kfilemetainfo.cpp.

operator=()

KFileMetaInfo & KFileMetaInfo::operator=

(

KFileMetaInfo const &

kfmi

)

Copy a KFileMetaInfo instance from another one.

Definition at line 332 of file kfilemetainfo.cpp.

preferredGroups()

KFileMetaInfoGroupList KFileMetaInfo::preferredGroups

(

)

const

Deprecated.

Definition at line 404 of file kfilemetainfo.cpp.

preferredKeys()

QStringList KFileMetaInfo::preferredKeys

(

)

const

Deprecated.

Definition at line 393 of file kfilemetainfo.cpp.

supportedGroups()

KFileMetaInfoGroupList KFileMetaInfo::supportedGroups

(

)

const

Deprecated.

Definition at line 411 of file kfilemetainfo.cpp.

supportedKeys()

QStringList KFileMetaInfo::supportedKeys

(

)

const

Deprecated.

Definition at line 398 of file kfilemetainfo.cpp.

---

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

• kfilemetainfo.h
• kfilemetainfo.cpp