.TH "KFileMetaInfoGroup" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KFileMetaInfoGroup \- This is one group of meta information items about a file (see \fBKFileMetaInfo\fP). A group of meta information items about a file.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kfilemetainfo.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "class \fBKFileMetaInfoGroup\fP (const \fBQString\fP &name, const \fBKFileMimeTypeInfo\fP *info)"
.br
.ti -1c
.RI "\fBKFileMetaInfoGroup\fP (const \fBKFileMetaInfoGroup\fP &original)"
.br
.ti -1c
.RI "const \fBKFileMetaInfoGroup\fP & \fBoperator=\fP (const \fBKFileMetaInfoGroup\fP &info)"
.br
.ti -1c
.RI "\fBKFileMetaInfoGroup\fP ()"
.br
.ti -1c
.RI "bool \fBisValid\fP () const "
.br
.ti -1c
.RI "bool \fBisEmpty\fP () const "
.br
.ti -1c
.RI "bool \fBisModified\fP () const "
.br
.ti -1c
.RI "\fBKFileMetaInfoItem\fP \fBoperator[]\fP (const \fBQString\fP &key) const "
.br
.ti -1c
.RI "\fBKFileMetaInfoItem\fP \fBitem\fP (const \fBQString\fP &key) const "
.br
.ti -1c
.RI "\fBKFileMetaInfoItem\fP \fBitem\fP (uint hint) const "
.br
.ti -1c
.RI "const \fBQVariant\fP \fBvalue\fP (const \fBQString\fP &key) const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBsupportedKeys\fP () const "
.br
.ti -1c
.RI "bool \fBsupportsVariableKeys\fP () const "
.br
.ti -1c
.RI "bool \fBcontains\fP (const \fBQString\fP &key) const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBkeys\fP () const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBpreferredKeys\fP () const "
.br
.ti -1c
.RI "\fBKFileMetaInfoItem\fP \fBaddItem\fP (const \fBQString\fP &key)"
.br
.ti -1c
.RI "bool \fBremoveItem\fP (const \fBQString\fP &key)"
.br
.ti -1c
.RI "\fBQStringList\fP \fBremovedItems\fP ()"
.br
.ti -1c
.RI "\fBQString\fP \fBname\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBtranslatedName\fP () const "
.br
.ti -1c
.RI "uint \fBattributes\fP () const "
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetAdded\fP ()"
.br
.ti -1c
.RI "\fBKFileMetaInfoItem\fP \fBappendItem\fP (const \fBQString\fP &key, const \fBQVariant\fP &value)"
.br
.ti -1c
.RI "void \fBref\fP ()"
.br
.ti -1c
.RI "void \fBderef\fP ()"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "Data * \fBd\fP"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKFilePlugin\fP"
.br
.ti -1c
.RI "class \fBKFileMetaInfo\fP"
.br
.ti -1c
.RI "KIO_EXPORT friend \fBQDataStream\fP & \fBoperator>>\fP (\fBQDataStream\fP &s, \fBKFileMetaInfoGroup\fP &)"
.br
.ti -1c
.RI "KIO_EXPORT friend \fBQDataStream\fP & \fBoperator<<\fP (\fBQDataStream\fP &s, const \fBKFileMetaInfoGroup\fP &)"
.br
.in -1c
.SH "Detailed Description"
.PP 
This is one group of meta information items about a file (see \fBKFileMetaInfo\fP). A group of meta information items about a file. 
.PP
Definition at line 664 of file kfilemetainfo.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KFileMetaInfoGroup::KFileMetaInfoGroup (const \fBKFileMetaInfoGroup\fP & original)"
.PP
Copy constructor. 
.PP
Definition at line 1168 of file kfilemetainfo.cpp.
.SS "KFileMetaInfoGroup::KFileMetaInfoGroup ()"
.PP
Default constructor. 
.PP
This creates an 'invalid' item 
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 1175 of file kfilemetainfo.cpp.
.SH "Member Function Documentation"
.PP 
.SS "const \fBKFileMetaInfoGroup\fP & KFileMetaInfoGroup::operator= (const \fBKFileMetaInfoGroup\fP & info)"
.PP
The assignment operator, so you can do: 
.PP
.nf
    KFileMetaInfoGroup group = info.group('Technical');

.fi
.PP
. 
.PP
This will create a shared copy of the object. The actual data is automatically deleted if all copies go out of scope 
.PP
Definition at line 1185 of file kfilemetainfo.cpp.
.PP
References d.
.SS "bool KFileMetaInfoGroup::isValid () const"
.PP
Returns true if the item is valid, i.e. 
.PP
if it contains data, false if it's invalid (created with the default constructor and not been assigned anything), or if \fBKFileMetaInfoGroup::item()\fP didn't find your requested item). 
.PP
\fBReturns:\fP
.RS 4
true if valid, false if invalid 
.RE
.PP

.PP
Definition at line 1198 of file kfilemetainfo.cpp.
.PP
Referenced by addItem(), attributes(), preferredKeys(), removeItem(), supportedKeys(), supportsVariableKeys(), and translatedName().
.SS "bool KFileMetaInfoGroup::isEmpty () const"
.PP
Returns false if the object contains data, true if it's empty. 
.PP
An empty group is a group with no items (amazing, isn't it?). 
.PP
\fBReturns:\fP
.RS 4
true if empty, false otherwise 
.RE
.PP

.PP
Definition at line 1204 of file kfilemetainfo.cpp.
.SS "bool KFileMetaInfoGroup::isModified () const"
.PP
Returns true if an item as added or removed from the group. 
.PP
\fBReturns:\fP
.RS 4
true if an item was added or removed from the group, otherwise false. 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 1314 of file kfilemetainfo.cpp.
.SS "\fBKFileMetaInfoItem\fP KFileMetaInfoGroup::operator[] (const \fBQString\fP & key) const\fC [inline]\fP"
.PP
Operator for convenience. 
.PP
It does the same as \fBitem()\fP, but you cannot specify a group to search in 
.PP
Definition at line 733 of file kfilemetainfo.h.
.SS "\fBKFileMetaInfoItem\fP KFileMetaInfoGroup::item (const \fBQString\fP & key) const"
.PP
This method searches for the specified item. 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key of the item to search 
.RE
.PP
\fBReturns:\fP
.RS 4
the specified item if found, an invalid item, if not 
.RE
.PP

.PP
Definition at line 1278 of file kfilemetainfo.cpp.
.PP
References QMapIterator::data().
.SS "\fBKFileMetaInfoItem\fP KFileMetaInfoGroup::item (uint hint) const"
.PP
Returns the item with the given \fChint\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIhint\fP the hint of the item 
.RE
.PP
\fBReturns:\fP
.RS 4
the item with the specified \fChint\fP 
.RE
.PP

.PP
Definition at line 1287 of file kfilemetainfo.cpp.
.PP
References QMapIterator::data().
.SS "const \fBQVariant\fP KFileMetaInfoGroup::value (const \fBQString\fP & key) const\fC [inline]\fP"
.PP
Convenience function. 
.PP
Returns the value of the specified key. It does the same as item(key).\fBvalue()\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key of the item to search 
.RE
.PP
\fBReturns:\fP
.RS 4
the value with the given key 
.RE
.PP

.PP
Definition at line 757 of file kfilemetainfo.h.
.PP
References KFileMetaInfoItem::value().
.SS "\fBQStringList\fP KFileMetaInfoGroup::supportedKeys () const"
.PP
Use this method to get a list of keys in the specified group that the plugin knows about. 
.PP
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 \fBKFileMetaInfo\fP about variable keys
.PP
\fBReturns:\fP
.RS 4
the list of keys supported for this mimetype 
.RE
.PP

.PP
Definition at line 1261 of file kfilemetainfo.cpp.
.PP
References isValid().
.SS "bool KFileMetaInfoGroup::supportsVariableKeys () const"
.PP
Returns true if this group supports adding or removing arbitrary keys, false if not. 
.PP
\fBReturns:\fP
.RS 4
true is variable keys are supported, false otherwise 
.RE
.PP

.PP
Definition at line 1267 of file kfilemetainfo.cpp.
.PP
References isValid().
.SS "bool KFileMetaInfoGroup::contains (const \fBQString\fP & key) const"
.PP
Checks whether an item with the given \fCkey\fP exists. 
.PP
\fBReturns:\fP
.RS 4
true if an item for this \fCkey\fP exists. 
.RE
.PP

.PP
Definition at line 1273 of file kfilemetainfo.cpp.
.PP
Referenced by KFileMetaInfo::contains().
.SS "\fBQStringList\fP KFileMetaInfoGroup::keys () const"
.PP
Returns a list of all keys. 
.PP
\fBReturns:\fP
.RS 4
a list of all keys in the order they were inserted. 
.RE
.PP

.PP
Definition at line 1237 of file kfilemetainfo.cpp.
.PP
References QMapConstIterator::data(), kdWarning(), and QMapConstIterator::key().
.PP
Referenced by preferredKeys().
.SS "\fBQStringList\fP KFileMetaInfoGroup::preferredKeys () const"
.PP
Returns a list of all keys in preference order. 
.PP
\fBReturns:\fP
.RS 4
a list of all keys in preference order. 
.RE
.PP

.PP
Definition at line 1209 of file kfilemetainfo.cpp.
.PP
References isValid(), keys(), and preferredKeys().
.PP
Referenced by preferredKeys().
.SS "\fBKFileMetaInfoItem\fP KFileMetaInfoGroup::addItem (const \fBQString\fP & key)"
.PP
Add an item to the info. 
.PP
This is only possible if the specified \fCkey\fP is in the supportedKeys list and not yet defined or if the group supports variable keys. 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key of the item 
.RE
.PP
\fBReturns:\fP
.RS 4
the \fBKFileMetaInfoItem\fP for the given \fCkey\fP 
.RE
.PP

.PP
Definition at line 1340 of file kfilemetainfo.cpp.
.PP
References QMapIterator::data(), isValid(), KFileMimeTypeInfo::ItemInfo::isVariableItem(), KFileMimeTypeInfo::GroupInfo::itemInfo(), KFileMetaInfoItem::setAdded(), and KFileMimeTypeInfo::GroupInfo::variableItemInfo().
.PP
Referenced by KFileMetaInfo::saveItem().
.SS "bool KFileMetaInfoGroup::removeItem (const \fBQString\fP & key)"
.PP
Remove this item from the meta info of the file. 
.PP
You cannot query \fBKFileMetaInfo\fP for a removed object, but you can query for a list of removed items with \fBremovedItems()\fP if you need to. If you re-add it, its value will be cleared. 
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key of the removed item 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP

.PP
Definition at line 1374 of file kfilemetainfo.cpp.
.PP
References isValid(), and kdDebug().
.SS "\fBQStringList\fP KFileMetaInfoGroup::removedItems ()"
.PP
Returns a list of all removed items. 
.PP
\fBReturns:\fP
.RS 4
a list of all removed items 
.RE
.PP

.PP
Definition at line 1402 of file kfilemetainfo.cpp.
.SS "\fBQString\fP KFileMetaInfoGroup::name () const"
.PP
The name of this group. 
.PP
\fBReturns:\fP
.RS 4
the name of this group 
.RE
.PP

.PP
Definition at line 1298 of file kfilemetainfo.cpp.
.SS "\fBQString\fP KFileMetaInfoGroup::translatedName () const"
.PP
The translated name of this group. 
.PP
\fBReturns:\fP
.RS 4
the translated name of this group 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 1255 of file kfilemetainfo.cpp.
.PP
References isValid().
.SS "uint KFileMetaInfoGroup::attributes () const"
.PP
Returns the attributes of this item. 
.PP
\fBReturns:\fP
.RS 4
the attributes 
.RE
.PP

.PP
Definition at line 1303 of file kfilemetainfo.cpp.
.PP
References isValid().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
