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

KFileMetaInfoItem Class Reference

#include <kfilemetainfo.h>

List of all members.

Public Methods

 KFileMetaInfoItem (const KFileMetaInfoItem &item)
const KFileMetaInfoItem & operator= (const KFileMetaInfoItem &item)
 KFileMetaInfoItem ()
QString key () const
QString translatedKey () const
const QVariant & value () const
QString string (bool mangle=true) const
bool setValue (const QVariant &value)
QVariant::Type type () const
bool isEditable () const
bool isRemoved () const
bool isModified () const
QString prefix () const
QString suffix () const
uint hint () const
uint unit () const
uint attributes () const
bool isValid () const


Detailed Description

This is one item of the meta information about a file (see KFileMetaInfo).

Definition at line 499 of file kfilemetainfo.h.


Constructor & Destructor Documentation

KFileMetaInfoItem::KFileMetaInfoItem (  const KFileMetaInfoItem &    item ) 
 

Copy onstructor

KFileMetaInfoItem::KFileMetaInfoItem (    ) 
 

Default constructor. This creates an "invalid" item


Member Function Documentation

uint KFileMetaInfoItem::attributes (    ) 
 

Returns:
the atttributes for this item. See KFileMimeTypeInfo::Attributes

uint KFileMetaInfoItem::hint (    ) 
 

Returns:
the hint for this item. See KFileMimeTypeInfo::Hint

bool KFileMetaInfoItem::isEditable (    ) 
 

You can query if the application can edit the item and write it back to the file with this method. Note that this doesn't ensure that you have write access to the file and that enough space is available.

Returns:
true if the item's value can be changed, false if not

bool KFileMetaInfoItem::isModified (    ) 
 

If you change an item, it is marked as "dirty". On the next KFileMetaInfo::applyChanges() , the change will be written to the file. With this method, you can ask if this item is dirty.

Returns:
true if the item contains changes that have not yet been written back into the file. Removing or adding an item counts as such a change

bool KFileMetaInfoItem::isRemoved (    ) 
 

If you remove an item, it is only marked for removal for the file. On the next KFileMetaInfo::applyChanges() , it will be removed from the file. With this method, you can ask if the item is marked for removal.

Returns:
true if the item was removed, false if not

bool KFileMetaInfoItem::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)

QString KFileMetaInfoItem::key (    ) 
 

Returns:
the key of this item

const KFileMetaInfoItem& KFileMetaInfoItem::operator= (  const KFileMetaInfoItem &    item ) 
 

The assignment operator, so you can do:

    KFileMetaInfoItem item = info.item("Title");
 

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

QString KFileMetaInfoItem::prefix (    ) 
 

This method returns a translated prefix to be displayed before the value. Think e.g. of the $ in $30

Returns:
the prefix

bool KFileMetaInfoItem::setValue (  const QVariant &    value ) 
 

changes the value of the item

QString KFileMetaInfoItem::string (  bool    mangle = true )  const
 

Returns:
a string containing the value, if possible. If not, QString::null is returned. if mangle is true, the string will already contain prefix and suffix

QString KFileMetaInfoItem::suffix (    ) 
 

This method returns a translated suffix to be displayed after the value. Think of the kbps in 128kbps *

Returns:
the suffix

QString KFileMetaInfoItem::translatedKey (    ) 
 

Returns:
a translation of the key for displaying to the user. If the plugin provides translation to the key, it's also in the user's language

QVariant::Type KFileMetaInfoItem::type (    ) 
 

convenience method. It does the same as value()->type()

Returns:
the type of the item

uint KFileMetaInfoItem::unit (    ) 
 

Returns:
the unit for this item. See KFileMimeTypeInfo::Unit

const QVariant& KFileMetaInfoItem::value (    ) 
 

Returns:
the value of the item.

Referenced by KFileMetaInfoGroup::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