Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KFileMetaInfoGroup Class Reference

#include <kfilemetainfo.h>

List of all members.

Public Methods

 KFileMetaInfoGroup (const KFileMetaInfoGroup &original)
const KFileMetaInfoGroup & operator= (const KFileMetaInfoGroup &info)
 KFileMetaInfoGroup ()
bool isValid () const
bool isEmpty () const
bool isModified () const
KFileMetaInfoItem operator[] (const QString &key) const
KFileMetaInfoItem item (const QString &key) const
KFileMetaInfoItem item (uint hint) const
const QVariant value (const QString &key) const
QStringList supportedKeys () const
bool supportsVariableKeys () const
bool contains (const QString &key) const
QStringList keys () const
QStringList preferredKeys () const
KFileMetaInfoItem addItem (const QString &key)
bool removeItem (const QString &key)


Detailed Description

This is one group of meta information items about a file (see KFileMetaInfo).

Definition at line 662 of file kfilemetainfo.h.


Constructor & Destructor Documentation

KFileMetaInfoGroup::KFileMetaInfoGroup (  const KFileMetaInfoGroup &    original ) 
 

Copy onstructor

KFileMetaInfoGroup::KFileMetaInfoGroup (    ) 
 

Default constructor. This creates an "invalid" item

Since:
3.1


Member Function Documentation

KFileMetaInfoItem KFileMetaInfoGroup::addItem (  const QString &    key ) 
 

add an item to the info. This is only possible if the specified key is in the supportedKeys list and not yet defined or if the group supports variable keys.

bool KFileMetaInfoGroup::contains (  const QString &    key )  const
 

Returns:
whether an item for this key exists.

bool KFileMetaInfoGroup::isEmpty (    ) 
 

Returns:
false if the object contains data, true if it's empty. An empty group is a group with no items (amazing, isn't it?)

bool KFileMetaInfoGroup::isModified (    ) 
 

Returns true if an item as added or removed from the group.

Returns:
true if an item was added or removed from the group, otherwise false.
Since:
3.1

bool KFileMetaInfoGroup::isValid (    ) 
 

Returns:
true if the item is valid, i.e. if it contains data, false if it's invalid (created with the default constructor and not been assigned anything), or if KFileMetaInfoGroup::item() didn't find your requested item)

KFileMetaInfoItem KFileMetaInfoGroup::item (  uint    hint )  const
 

Returns:
the item with the specified hint

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

This method searches for the specified item.

Returns:
the specified item if found, an invalid item, if not

Referenced by operator[](), and value().

QStringList KFileMetaInfoGroup::keys (    ) 
 

Returns:
a list of all keys in the order they were inserted.

const KFileMetaInfoGroup& KFileMetaInfoGroup::operator= (  const KFileMetaInfoGroup &    info ) 
 

The assignment operator, so you can do:

    KFileMetaInfoGroup group = info.group("Technical");
 

This will create a shared copy of the object. The actual data is automatically deleted if all copies go out of scope

KFileMetaInfoItem KFileMetaInfoGroup::operator[] (  const QString &    key )  const [inline]
 

operator for convenience. It does the same as item(), but you cannot specify a group to search in

Definition at line 729 of file kfilemetainfo.h.

References item(), and KStdAccel::key().

QStringList KFileMetaInfoGroup::preferredKeys (    ) 
 

Returns:
a list of all keys in preference order.

bool KFileMetaInfoGroup::removeItem (  const QString &    key ) 
 

remove this item from the meta info of the file. You cannot query KFileMetaInfo for a removed object, but you can query for a list of removed items with removedItems() if you need to. If you re-add it, its value will be cleared

QStringList KFileMetaInfoGroup::supportedKeys (    ) 
 

Use this method to get a list of keys in the specified group that the plugin knows about. No variable keys. For a group that doesn't support variable keys, all keys that this group may have are returned. For a group that does support them, the non-variable ones are returned. See KFileMetaInfo about variable keys

Returns:
the list of keys supported for this mimetype

bool KFileMetaInfoGroup::supportsVariableKeys (    ) 
 

Returns:
true if this group supports adding or removing arbitrary keys, false if not.

const QVariant KFileMetaInfoGroup::value (  const QString &    key )  const [inline]
 

Convenience function. Returns the value of the specified key. It does the same as item(key).value()

Definition at line 748 of file kfilemetainfo.h.

References item(), KStdAccel::key(), and KFileMetaInfoItem::value().


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:13 2003 for kdelibs by doxygen1.2.18