.TH "KFileMetaInfoGroup" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KFileMetaInfoGroup \- This is one group of meta information items about a file (see \fBKFileMetaInfo\fP).  

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

.in +1c
.ti -1c
.RI "\fBKFileMetaInfoGroup\fP (const  \fBQString\fP &name, const  \fBKFileMimeTypeInfo\fP *info)"
.br
.ti -1c
.RI "\fBKFileMetaInfoGroup\fP (const  \fBKFileMetaInfoGroup\fP &original)"
.br
.RI "\fICopy onstructor. \fP"
.ti -1c
.RI "const  \fBKFileMetaInfoGroup\fP & \fBoperator=\fP (const  \fBKFileMetaInfoGroup\fP &info)"
.br
.RI "\fIThe assignment operator, so you can do:. \fP"
.ti -1c
.RI "\fBKFileMetaInfoGroup\fP ()"
.br
.RI "\fIDefault constructor. \fP"
.ti -1c
.RI "bool \fBisValid\fP () const "
.br
.ti -1c
.RI "bool \fBisEmpty\fP () const "
.br
.ti -1c
.RI "bool \fBisModified\fP () const "
.br
.RI "\fIReturns true if an item as added or removed from the group. \fP"
.ti -1c
.RI "\fBKFileMetaInfoItem\fP \fBoperator[]\fP (const  \fBQString\fP &key) const "
.br
.RI "\fIoperator for convenience. \fP"
.ti -1c
.RI "\fBKFileMetaInfoItem\fP \fBitem\fP (const  \fBQString\fP &key) const "
.br
.RI "\fIThis method searches for the specified item. \fP"
.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
.RI "\fIConvenience function. \fP"
.ti -1c
.RI "\fBQStringList\fP \fBsupportedKeys\fP () const "
.br
.RI "\fIUse this method to get a list of keys in the specified group that the plugin knows about. \fP"
.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
.RI "\fIadd an item to the info. \fP"
.ti -1c
.RI "bool \fBremoveItem\fP (const  \fBQString\fP &key)"
.br
.RI "\fIremove this item from the meta info of the file. \fP"
.ti -1c
.RI "\fBQStringList\fP \fBremovedItems\fP ()"
.br
.ti -1c
.RI "\fBQString\fP \fBname\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 "\fBQDataStream\fP & \fBoperator>>\fP (\fBQDataStream\fP &s, \fBKFileMetaInfoGroup\fP &)"
.br
.ti -1c
.RI "\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). Definition at line 662 of file kfilemetainfo.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KFileMetaInfoGroup::KFileMetaInfoGroup (const \fBKFileMetaInfoGroup\fP & original)"
.PP
Copy onstructor. Definition at line 1037 of file kfilemetainfo.cpp.
.SS "KFileMetaInfoGroup::KFileMetaInfoGroup ()"
.PP
Default constructor. This creates an 'invalid' item 
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP
Definition at line 1044 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');
 
.PP
.PP
This will create a shared copy of the object. The actual data is automatically deleted if all copies go out of scope Definition at line 1054 of file kfilemetainfo.cpp.
.PP
References d.
.SS "bool KFileMetaInfoGroup::isValid () const"
.PP
\fBReturns:\fP
.RS 4
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 \fBKFileMetaInfoGroup::item\fP() didn't find your requested item) 
.RE
.PP
Definition at line 1067 of file kfilemetainfo.cpp.
.PP
Referenced by removeItem().
.SS "bool KFileMetaInfoGroup::isEmpty () const"
.PP
\fBReturns:\fP
.RS 4
false if the object contains data, true if it's empty. An empty group is a group with no items (amazing, isn't it?) 
.RE
.PP
Definition at line 1073 of file kfilemetainfo.cpp.
.SS "bool KFileMetaInfoGroup::isModified () const"
.PP
Returns true if an item as added or removed from the group. \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
Definition at line 1177 of file kfilemetainfo.cpp.
.SS "\fBKFileMetaInfoItem\fP KFileMetaInfoGroup::operator[] (const \fBQString\fP & key) const\fC [inline]\fP"
.PP
operator for convenience. It does the same as \fBitem\fP(), but you cannot specify a group to search in Definition at line 729 of file kfilemetainfo.h.
.PP
References item(), and KStdAccel::key().
.SS "\fBKFileMetaInfoItem\fP KFileMetaInfoGroup::item (const \fBQString\fP & key) const"
.PP
This method searches for the specified item. \fBReturns:\fP
.RS 4
the specified item if found, an invalid item, if not 
.RE
.PP
Definition at line 1142 of file kfilemetainfo.cpp.
.PP
References QMapIterator::data(), and KStdAccel::key().
.PP
Referenced by addItem(), operator[](), preferredKeys(), and value().
.SS "\fBKFileMetaInfoItem\fP KFileMetaInfoGroup::item (uint hint) const"
.PP
\fBReturns:\fP
.RS 4
the item with the specified hint 
.RE
.PP
Definition at line 1151 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. Returns the value of the specified key. It does the same as item(key).\fBvalue()\fP Definition at line 748 of file kfilemetainfo.h.
.PP
References item(), KStdAccel::key(), and 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. 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
Definition at line 1127 of file kfilemetainfo.cpp.
.SS "bool KFileMetaInfoGroup::supportsVariableKeys () const"
.PP
\fBReturns:\fP
.RS 4
true if this group supports adding or removing arbitrary keys, false if not. 
.RE
.PP
Definition at line 1132 of file kfilemetainfo.cpp.
.SS "bool KFileMetaInfoGroup::contains (const \fBQString\fP & key) const"
.PP
\fBReturns:\fP
.RS 4
whether an item for this key exists. 
.RE
.PP
Definition at line 1137 of file kfilemetainfo.cpp.
.PP
References KStdAccel::key().
.PP
Referenced by KFileMetaInfo::contains().
.SS "\fBQStringList\fP KFileMetaInfoGroup::keys () const"
.PP
\fBReturns:\fP
.RS 4
a list of all keys in the order they were inserted. 
.RE
.PP
Definition at line 1109 of file kfilemetainfo.cpp.
.PP
References QMapConstIterator::data().
.PP
Referenced by preferredKeys().
.SS "\fBQStringList\fP KFileMetaInfoGroup::preferredKeys () const"
.PP
\fBReturns:\fP
.RS 4
a list of all keys in preference order. 
.RE
.PP
Definition at line 1078 of file kfilemetainfo.cpp.
.PP
References KStdAccel::end(), item(), keys(), and preferredKeys().
.PP
Referenced by preferredKeys().
.SS "\fBKFileMetaInfoItem\fP KFileMetaInfoGroup::addItem (const \fBQString\fP & key)"
.PP
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. Definition at line 1202 of file kfilemetainfo.cpp.
.PP
References QMapIterator::data(), KFileMimeTypeInfo::ItemInfo::isVariableItem(), item(), KFileMimeTypeInfo::GroupInfo::itemInfo(), KStdAccel::key(), KFileMetaInfoItem::setAdded(), and KFileMimeTypeInfo::GroupInfo::variableItemInfo().
.SS "bool KFileMetaInfoGroup::removeItem (const \fBQString\fP & key)"
.PP
remove this item from the meta info of the file. 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 Definition at line 1235 of file kfilemetainfo.cpp.
.PP
References isValid(), and KStdAccel::key().

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