KIO

KFileMetaInfo Class Reference

#include <kfilemetainfo.h>

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 KFileMetaDataItem objects.

Definition at line 56 of file kfilemetainfo.h.


Public Types
enum	What { Fastest = 0x1, TechnicalInfo = 0x4, ContentInfo = 0x8, ExternalSources = 0x10, Thumbnail = 0x20, LinkedData = 0x80, Everything = 0xffff }
Public Member Functions
	KFileMetaInfo (const QString &path, const QString &mimetype=QString(), WhatFlags w=Everything)
	KFileMetaInfo (const KUrl &url)
	KFileMetaInfo ()
	KFileMetaInfo (const KFileMetaInfo &)
	~KFileMetaInfo ()
const KFileMetaInfo &	operator= (KFileMetaInfo const &kfmi)
bool	applyChanges ()
const QHash< QString, KFileMetaInfoItem > &	items () const
KFileMetaInfoItem &	item (const QString &key)
const KFileMetaInfoItem &	item (const QString &key) const
bool	isValid () const
QStringList	preferredKeys () const
QStringList	supportedKeys () const
KFileMetaInfoGroupList	preferredGroups () const
KFileMetaInfoGroupList	supportedGroups () const
KFileMetaInfoGroupList	groups () const
QStringList	keys () const
const KUrl &	url () const
Friends
QDataStream &	operator>> (QDataStream &s, KFileMetaInfo &)
QDataStream &	operator<< (QDataStream &s, const KFileMetaInfo &)

Member Enumeration Documentation

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
LinkedData
Everything	read everything, even if it might take a while

Definition at line 64 of file kfilemetainfo.h.

Constructor & Destructor Documentation

KFileMetaInfo::KFileMetaInfo	(	const QString &	path,
		const QString &	mimetype = `QString()`,
		WhatFlags	w = `Everything`
	)			`[explicit]`

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

KFileMetaInfo::KFileMetaInfo ( const KUrl & url )

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

Definition at line 218 of file kfilemetainfo.cpp.

KFileMetaInfo::KFileMetaInfo ( )

Construct an empty, invalid KFileMetaInfo instance.

Definition at line 227 of file kfilemetainfo.cpp.

KFileMetaInfo::KFileMetaInfo ( const KFileMetaInfo & k )

Construct a KFileMetaInfo instance from another one.

Definition at line 229 of file kfilemetainfo.cpp.

KFileMetaInfo::~KFileMetaInfo ( )

Destructor.

Definition at line 236 of file kfilemetainfo.cpp.

Member Function Documentation

const KFileMetaInfo & KFileMetaInfo::operator= ( KFileMetaInfo const & kfmi )

Copy a KFileMetaInfo instance from another one.

Definition at line 232 of file kfilemetainfo.cpp.

bool KFileMetaInfo::applyChanges ( )

Save the changes made to this KFileMetaInfo instance.

Definition at line 239 of file kfilemetainfo.cpp.

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

Retrieve all the items.

Definition at line 264 of file kfilemetainfo.cpp.

KFileMetaInfoItem & KFileMetaInfo::item ( const QString & key )

Definition at line 277 of file kfilemetainfo.cpp.

const KFileMetaInfoItem & KFileMetaInfo::item ( const QString & key ) const

Definition at line 268 of file kfilemetainfo.cpp.

bool KFileMetaInfo::isValid ( ) const

Definition at line 281 of file kfilemetainfo.cpp.

QStringList KFileMetaInfo::preferredKeys ( ) const

Deprecated.

Definition at line 284 of file kfilemetainfo.cpp.

QStringList KFileMetaInfo::supportedKeys ( ) const

Deprecated.

Definition at line 285 of file kfilemetainfo.cpp.

KFileMetaInfoGroupList KFileMetaInfo::preferredGroups ( ) const

Deprecated.

Definition at line 288 of file kfilemetainfo.cpp.

KFileMetaInfoGroupList KFileMetaInfo::supportedGroups ( ) const

Deprecated.

Definition at line 292 of file kfilemetainfo.cpp.

KFileMetaInfoGroupList KFileMetaInfo::groups ( ) const

QStringList KFileMetaInfo::keys ( ) const

Definition at line 273 of file kfilemetainfo.cpp.

const KUrl & KFileMetaInfo::url ( ) const

Definition at line 260 of file kfilemetainfo.cpp.

Friends And Related Function Documentation

QDataStream& operator>>	(	QDataStream &	s,
		KFileMetaInfo &
	)			`[friend]`

Definition at line 45 of file kfilemetainfo.cpp.

QDataStream& operator<<	(	QDataStream &	s,
		const KFileMetaInfo &
	)			`[friend]`

Definition at line 48 of file kfilemetainfo.cpp.

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

KIO

KFileMetaInfo Class Reference

Detailed Description

Public Types

Public Member Functions

Friends

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

KIO

kdelibs