KFileMetaInfo Class Reference
This is the class for objects that hold meta information about a file. More...
#include <kfilemetainfo.h>
Public Types | |
typedef KFileMimeTypeInfo::Hint | Hint |
typedef KFileMimeTypeInfo::Unit | Unit |
typedef KFileMimeTypeInfo::Attributes | Attributes |
enum | What { Fastest = 0x1, DontCare = 0x2, TechnicalInfo = 0x4, ContentInfo = 0x8, ExtenedAttr = 0x10, Thumbnail = 0x20, Preferred = 0x40, Everything = 0xffff } |
This is used to specify what a KFileMetaInfo object should read, so you can specify if you want to read "expensive" items or not. More... | |
Public Member Functions | |
KFileMetaInfo (const QString &path, const QString &mimeType=QString::null, uint what=Fastest) | |
The constructor. | |
KFileMetaInfo () | |
Default constructor. | |
KFileMetaInfo (const KFileMetaInfo &original) | |
Copy constructor. | |
const KFileMetaInfo & | operator= (const KFileMetaInfo &info) |
The assignment operator, so you can do e.g.:. | |
QStringList | groups () const |
QStringList | supportedGroups () const |
QStringList | preferredGroups () const |
QStringList | preferredKeys () const |
QStringList | supportedKeys () const |
QStringList | editableGroups () const |
KFileMetaInfoItem | item (const QString &key) const |
KFileMetaInfoItem | item (const KFileMetaInfoItem::Hint hint) const |
KFileMetaInfoItem | saveItem (const QString &key, const QString &preferredGroup=QString::null, bool createGroup=true) |
KFileMetaInfoGroup | group (const QString &key) const |
KFileMetaInfoGroup | operator[] (const QString &key) const |
bool | addGroup (const QString &name) |
Try to add the specified group. | |
bool | removeGroup (const QString &name) |
remove the specified group. | |
QStringList | removedGroups () |
bool | applyChanges () |
This method writes all pending changes of the meta info back to the file. | |
bool | contains (const QString &key) const |
bool | containsGroup (const QString &key) const |
const QVariant | value (const QString &key) const |
bool | isValid () const |
bool | isEmpty () const |
QString | mimeType () const |
QString | path () const |
Protected Member Functions | |
KFileMetaInfoGroup | appendGroup (const QString &name) |
KFilePlugin *const | plugin () const |
void | ref () |
void | deref () |
Protected Attributes | |
Data * | d |
Friends | |
class | KFilePlugin |
QDataStream & | operator>> (QDataStream &s, KFileMetaInfo &) |
QDataStream & | operator<< (QDataStream &s, const KFileMetaInfo &) |
Detailed Description
This is the class for objects that hold meta information about a file.The information is kept in form of a system of key/value pairs. See also KFileMetaInfoItem. This information is retrieved from the file through a plugin system, and this class is the main interface to it. If you want to write your own plugin, have a look at KFilePlugin. There are basically two different kinds of meta information: Fixed ones that the plugin knows about (e.g. an mp3 id3v1 tag has a well defined fixed list of fields), and variable keys that exist in mimetypes that support their own key/value system (comments in png files are of this type). Almost every file has fixed keys, but some also have variable keys.
The groups and the What enum are not yet supported, but already added to the interface so that adding support doesn't break compatibility.
Definition at line 853 of file kfilemetainfo.h.
Member Enumeration Documentation
|
This is used to specify what a KFileMetaInfo object should read, so you can specify if you want to read "expensive" items or not.
Definition at line 880 of file kfilemetainfo.h. |
Constructor & Destructor Documentation
|
The constructor. creating a KFileMetaInfo item through this will autoload the plugin belonging to the mimetype and try to get meta information about the specified file. If no info is available, you'll get an empty (not invalid) object. You can test for it with the isEmpty() method.
Definition at line 288 of file kfilemetainfo.cpp. References KMimeType::findByPath(), QString::isEmpty(), KFileMetaInfo(), plugin(), and KFilePlugin::readInfo(). |
|
Default constructor. This will create an invalid object (see isValid(). Definition at line 325 of file kfilemetainfo.cpp. Referenced by KFileMetaInfo(). |
|
Copy constructor.
Definition at line 318 of file kfilemetainfo.cpp. |
Member Function Documentation
|
The assignment operator, so you can do e.g.:.
|
|
Definition at line 345 of file kfilemetainfo.cpp. Referenced by contains(), and containsGroup(). |
|
Definition at line 355 of file kfilemetainfo.cpp. References KFileMimeTypeInfo::GroupInfo::attributes(). |
|
Try to add the specified group. This will only succeed if it is in the list of editableGroups(). Note that all non-variable items that belong to this group are automatically added as empty item. Definition at line 417 of file kfilemetainfo.cpp. References KFileMetaInfoGroup::appendItem(), KFileMimeTypeInfo::ItemInfo::attributes(), KFileMimeTypeInfo::GroupInfo::itemInfo(), KFileMimeTypeInfo::ItemInfo::key(), KStdAccel::name(), KFileMetaInfoGroup::setAdded(), and KFileMimeTypeInfo::GroupInfo::supportedKeys(). |
|
remove the specified group. This will only succeed if it is in the list of editableGroups(). Beware that this also removes all the items in that group, so always ask the user before removing it! Definition at line 453 of file kfilemetainfo.cpp. References KStdAccel::name(). |
|
This method writes all pending changes of the meta info back to the file. If any items are marked as removed, they are really removed from the list. The info object as well as all items are updated.
Definition at line 498 of file kfilemetainfo.cpp. References QMapConstIterator::data(), plugin(), and KFilePlugin::writeInfo(). |
|
Definition at line 550 of file kfilemetainfo.cpp. References KFileMetaInfoGroup::contains(), groups(), and KStdAccel::key(). |
|
Definition at line 561 of file kfilemetainfo.cpp. References groups(), and KStdAccel::key(). |
|
Definition at line 483 of file kfilemetainfo.cpp. Referenced by KFileItem::getToolTipText(), and KFileItem::metaInfo(). |
|
Definition at line 489 of file kfilemetainfo.cpp. Referenced by KFileItem::getToolTipText(). |
|
Definition at line 539 of file kfilemetainfo.cpp. Referenced by applyChanges(), and KFileMetaInfo(). |
The documentation for this class was generated from the following files: