.TH "KFileMimeTypeInfo::GroupInfo" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KFileMimeTypeInfo::GroupInfo \- This is the class for one group of items of a \fBKFileMimeTypeInfo\fP.  

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

.in +1c
.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 "const  \fBQString\fP & \fBname\fP () const "
.br
.RI "\fIUse this method to get the name of the group. \fP"
.ti -1c
.RI "const  \fBQString\fP & \fBtranslatedName\fP () const "
.br
.RI "\fIUse this method to get the string to display to the user as group name. \fP"
.ti -1c
.RI "const  \fBItemInfo\fP * \fBitemInfo\fP (const  \fBQString\fP &key) const "
.br
.RI "\fIA group object can contain sevaral item objects (of which you can get the names with \fBsupportedKeys\fP() . \fP"
.ti -1c
.RI "uint \fBattributes\fP () const "
.br
.RI "\fIGet the attributes of this group (see \fBAttributes\fP). \fP"
.ti -1c
.RI "bool \fBsupportsVariableKeys\fP () const "
.br
.ti -1c
.RI "const  \fBItemInfo\fP * \fBvariableItemInfo\fP () const "
.br
.RI "\fIIf the group supports variable keys, you can query their item info with this method. \fP"
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKFilePlugin\fP"
.br
.ti -1c
.RI "class \fBKFileMimeTypeInfo\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
This is the class for one group of items of a \fBKFileMimeTypeInfo\fP. 

It contains, among other things, the information about the group's name and a list of supported items. 
.PP
Definition at line 163 of file kfilemetainfo.h.
.SH "Member Function Documentation"
.PP 
.SS "\fBQStringList\fP KFileMimeTypeInfo::GroupInfo::supportedKeys () const\fC [inline]\fP"
.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 179 of file kfilemetainfo.h.
.PP
Referenced by KFileMetaInfo::addGroup().
.SS "const \fBQString\fP& KFileMimeTypeInfo::GroupInfo::name () const\fC [inline]\fP"
.PP
Use this method to get the name of the group. This string doesn't depend on the user's locale settings
.PP
\fBReturns:\fP
.RS 4
the group name 
.RE
.PP
Definition at line 190 of file kfilemetainfo.h.
.SS "const \fBQString\fP& KFileMimeTypeInfo::GroupInfo::translatedName () const\fC [inline]\fP"
.PP
Use this method to get the string to display to the user as group name. This may be different to \fBname\fP() and it returns the name in the user's language
.PP
\fBReturns:\fP
.RS 4
the translated group name 
.RE
.PP
Definition at line 202 of file kfilemetainfo.h.
.SS "const  \fBKFileMimeTypeInfo::ItemInfo\fP * KFileMimeTypeInfo::GroupInfo::itemInfo (const \fBQString\fP & key) const"
.PP
A group object can contain sevaral item objects (of which you can get the names with \fBsupportedKeys\fP() . With this method, you can get one of those item objects. See \fBItemInfo\fP
.PP
\fBReturns:\fP
.RS 4
a pointer to the item info. Don't delete this object! 
.RE
.PP
Definition at line 1403 of file kfilemetainfo.cpp.
.PP
References QDict< ItemInfo >::find(), and KStdAccel::key().
.PP
Referenced by KFileMetaInfo::addGroup(), and KFileMetaInfoGroup::addItem().
.SS "uint KFileMimeTypeInfo::GroupInfo::attributes () const\fC [inline]\fP"
.PP
Get the attributes of this group (see \fBAttributes\fP). \fBReturns:\fP
.RS 4
the attributes 
.RE
.PP
Definition at line 221 of file kfilemetainfo.h.
.PP
Referenced by KFileMetaInfo::editableGroups().
.SS "bool KFileMimeTypeInfo::GroupInfo::supportsVariableKeys () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
true if this group supports adding or removing arbitrary keys, false if not. 
.RE
.PP
Definition at line 230 of file kfilemetainfo.h.
.SS "const \fBItemInfo\fP* KFileMimeTypeInfo::GroupInfo::variableItemInfo () const\fC [inline]\fP"
.PP
If the group supports variable keys, you can query their item info with this method. The main reason for this is that you can get the type and attributes of variable keys.
.PP
\fBReturns:\fP
.RS 4
a pointer to the item info. Don't delete this object! 
.RE
.PP
Definition at line 242 of file kfilemetainfo.h.
.PP
Referenced by KFileMetaInfoGroup::addItem().

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