.TH "KFileMimeTypeInfo" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KFileMimeTypeInfo \- This class provides information about the capabilities that a \fBKFilePlugin\fP for a given mimetype has.  

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

.in +1c
.ti -1c
.RI "enum \fBAttributes\fP { \fBAddable\fP =  1, \fBRemovable\fP =  2, \fBModifiable\fP =  4, \fBCummulative\fP =  8, \fBAveraged\fP =  16, \fBMultiLine\fP =  32, \fBSqueezeText\fP =  64 }"
.br
.RI "\fIThis enum is used to specify some attributes that an item can have, which fit neither in the \fBHint\fP nor in the \fBUnit\fP enum. \fP"
.ti -1c
.RI "enum \fBHint\fP { \fBNoHint\fP =  0, \fBName\fP =  1, \fBAuthor\fP =  2, \fBDescription\fP =  3, \fBWidth\fP =  4, \fBHeight\fP =  5, \fBSize\fP =  6, \fBBitrate\fP =  7, \fBLength\fP =  8, \fBHidden\fP =  9, \fBThumbnail\fP =  10 }"
.br
.RI "\fIThis enum is mainly for items that have a special meaning for some applications. \fP"
.ti -1c
.RI "enum \fBUnit\fP { \fBNoUnit\fP =  0, \fBSeconds\fP =  1, \fBMilliSeconds\fP =  2, \fBBitsPerSecond\fP =  3, \fBPixels\fP =  4, \fBInches\fP =  5, \fBCentimeters\fP =  6, \fBBytes\fP =  7, \fBFramesPerSecond\fP =  8, \fBDotsPerInch\fP =  9, \fBBitsPerPixel\fP =  10, \fBHertz\fP =  11, \fBKiloBytes\fP =  12 }"
.br
.RI "\fIThis enum exists so that you can specify units for items, which you can usually use for integer items, so an application knows how to display it (e.g. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQValidator\fP * \fBcreateValidator\fP (const  \fBQString\fP &group, const  \fBQString\fP &key, \fBQObject\fP *parent=0, const  char *name=0) const "
.br
.RI "\fICreates a validator for this item. \fP"
.ti -1c
.RI "\fBQStringList\fP \fBsupportedGroups\fP () const "
.br
.RI "\fIReturns the list of all groups that the plugin for this mimetype supports. \fP"
.ti -1c
.RI "\fBQStringList\fP \fBtranslatedGroups\fP () const "
.br
.RI "\fISame as the above function, but returns the strings to display to the user. \fP"
.ti -1c
.RI "\fBQStringList\fP \fBpreferredGroups\fP () const "
.br
.RI "\fIThis returns the list of groups in the preferred order that's specified in the .desktop file. \fP"
.ti -1c
.RI "\fBQString\fP \fBmimeType\fP () const "
.br
.RI "\fIReturns the mimetype to which this info belongs. \fP"
.ti -1c
.RI "const  \fBGroupInfo\fP * \fBgroupInfo\fP (const  \fBQString\fP &group) const "
.br
.RI "\fIGet the group info for a specific group. \fP"
.ti -1c
.RI "\fBQStringList\fP \fBsupportedKeys\fP () const "
.br
.RI "\fIReturn a list of all supported keys without looking for a specific group. \fP"
.ti -1c
.RI "\fBQStringList\fP \fBpreferredKeys\fP () const "
.br
.RI "\fIReturn a list of all supported keys in preference order. \fP"
.ti -1c
.RI "\fBGroupInfo\fP * \fBaddGroupInfo\fP (const  \fBQString\fP &name, const  \fBQString\fP &translatedName)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBQString\fP \fBm_translatedName\fP"
.br
.ti -1c
.RI "\fBQStringList\fP \fBm_supportedKeys\fP"
.br
.ti -1c
.RI "uint \fBm_attr\fP"
.br
.ti -1c
.RI "\fBQDict\fP< \fBItemInfo\fP > \fBm_itemDict\fP"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBKFileMimeTypeInfo\fP (const  \fBQString\fP &mimeType)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBQDict\fP< \fBGroupInfo\fP > \fBm_groups\fP"
.br
.ti -1c
.RI "\fBQString\fP \fBm_mimeType\fP"
.br
.ti -1c
.RI "\fBQStringList\fP \fBm_preferredKeys\fP"
.br
.ti -1c
.RI "\fBQStringList\fP \fBm_preferredGroups\fP"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKFilePlugin\fP"
.br
.ti -1c
.RI "class \fBKFileMetaInfoProvider\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
This class provides information about the capabilities that a \fBKFilePlugin\fP for a given mimetype has. 

It includes a list of metainfo groups and items together with their type, a prefix, suffix and some other information about how to use, display or edit the items. 
.PP
Definition at line 47 of file kfilemetainfo.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKFileMimeTypeInfo::Attributes\fP"
.PP
This enum is used to specify some attributes that an item can have, which fit neither in the \fBHint\fP nor in the \fBUnit\fP enum. .IP "\(bu" 2
\fCAddable\fP The item or group can be added by a user 
.IP "\(bu" 2
\fCRemovable\fP It can be removed 
.IP "\(bu" 2
\fCModifiable\fP Its value can be edited (no meaning for a group) 
.IP "\(bu" 2
\fCCummulative\fP If an application wants to display information for more than one file, it may add up the values for this item (e.g. play time of an mp3 file) 
.IP "\(bu" 2
\fCAveraged\fP Similar to Cummulative, but the average should be calculated instead of the sum 
.IP "\(bu" 2
\fCMultiLine\fP This attribute says that a string item is likely to be more than one line long, so for editing, a widget capable for multline text should be used 
.IP "\(bu" 2
\fCSqueezeText\fP If the text for this item is very long, it should be squeezed to the size of the widget where it's displayed 
.PP

.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIMultiLine \fP\fP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.TP
\fB\fISqueezeText \fP\fP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 77 of file kfilemetainfo.h.
.SS "enum \fBKFileMimeTypeInfo::Hint\fP"
.PP
This enum is mainly for items that have a special meaning for some applications. .IP "\(bu" 2
\fCNoHint\fP No hint 
.IP "\(bu" 2
\fCName\fP The name or title of the document 
.IP "\(bu" 2
\fCAuthor\fP The one who created the contents of it 
.IP "\(bu" 2
\fCDescription\fP Some information about the document 
.IP "\(bu" 2
\fCWidth\fP A width in pixels 
.IP "\(bu" 2
\fCHeight\fP A height in pixels 
.IP "\(bu" 2
\fCSize\fP A size in pixels (witdh and height) 
.IP "\(bu" 2
\fCBitrate\fP For media files 
.IP "\(bu" 2
\fCLength\fP The length of the file, also for media files 
.IP "\(bu" 2
\fCHidden\fP The item is usually not shown to the user 
.IP "\(bu" 2
\fCThumbnail\fP The item is a thumbnail of the file 
.PP
Definition at line 104 of file kfilemetainfo.h.
.SS "enum \fBKFileMimeTypeInfo::Unit\fP"
.PP
This enum exists so that you can specify units for items, which you can usually use for integer items, so an application knows how to display it (e.g. a time in seconds in a hh:mm:ss form). You can either use one of those units, or if you don't find one that fits, you can add it yourself using a prefix and/or suffix.
.PP
.IP "\(bu" 2
\fCNoUnit\fP None of the listed units 
.IP "\(bu" 2
\fCSeconds\fP The item represents a time in seconds 
.IP "\(bu" 2
\fCMilliSeconds\fP The item represents a time in milliseconds 
.IP "\(bu" 2
\fCBitsPerSecond\fP A bit rate 
.IP "\(bu" 2
\fCPixels\fP For resolutions 
.IP "\(bu" 2
\fCInches\fP Sizes 
.IP "\(bu" 2
\fCCentimeters\fP Sizes 
.IP "\(bu" 2
\fCBytes\fP Some data/file size in bytes 
.IP "\(bu" 2
\fCKiloBytes\fP Some data/file size in kilobytes 
.IP "\(bu" 2
\fCFramesPerSecond\fP A frame rate 
.IP "\(bu" 2
\fCDotsPerInch\fP Resolution in DPI 
.IP "\(bu" 2
\fCBitsPerPixel\fP A bit depth 
.IP "\(bu" 2
\fCHertz\fP Sample rates and similar 
.PP

.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIFramesPerSecond \fP\fP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.TP
\fB\fIDotsPerInch \fP\fP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.TP
\fB\fIBitsPerPixel \fP\fP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.TP
\fB\fIHertz \fP\fP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.TP
\fB\fIKiloBytes \fP\fP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 139 of file kfilemetainfo.h.
.SH "Member Function Documentation"
.PP 
.SS "\fBQValidator\fP * KFileMimeTypeInfo::createValidator (const \fBQString\fP & group, const \fBQString\fP & key, \fBQObject\fP * parent = 0, const char * name = 0) const"
.PP
Creates a validator for this item. Make sure to supply a proper parent argument or delete the validator yourself. Definition at line 1377 of file kfilemetainfo.cpp.
.PP
References KFilePlugin::createValidator(), KStdAccel::key(), mimeType(), and KStdAccel::name().
.SS "\fBQStringList\fP KFileMimeTypeInfo::supportedGroups () const"
.PP
Returns the list of all groups that the plugin for this mimetype supports. \fBReturns:\fP
.RS 4
the list of groups 
.RE
.PP
Definition at line 1339 of file kfilemetainfo.cpp.
.PP
References QDictIterator::current().
.SS "\fBQStringList\fP KFileMimeTypeInfo::translatedGroups () const"
.PP
Same as the above function, but returns the strings to display to the user. \fBReturns:\fP
.RS 4
the list of groups 
.RE
.PP
Definition at line 1349 of file kfilemetainfo.cpp.
.PP
References QDictIterator::current().
.SS "\fBQStringList\fP KFileMimeTypeInfo::preferredGroups () const\fC [inline]\fP"
.PP
This returns the list of groups in the preferred order that's specified in the .desktop file. \fBReturns:\fP
.RS 4
the list of groups 
.RE
.PP
Definition at line 434 of file kfilemetainfo.h.
.SS "\fBQString\fP KFileMimeTypeInfo::mimeType () const\fC [inline]\fP"
.PP
Returns the mimetype to which this info belongs. Definition at line 442 of file kfilemetainfo.h.
.PP
Referenced by createValidator().
.SS "const  \fBKFileMimeTypeInfo::GroupInfo\fP * KFileMimeTypeInfo::groupInfo (const \fBQString\fP & group) const"
.PP
Get the group info for a specific group. \fBReturns:\fP
.RS 4
a pointer to the info. Don't delete this object! 
.RE
.PP
Definition at line 1326 of file kfilemetainfo.cpp.
.PP
References QDict< GroupInfo >::find().
.SS "\fBQStringList\fP KFileMimeTypeInfo::supportedKeys () const"
.PP
Return a list of all supported keys without looking for a specific group. \fBReturns:\fP
.RS 4
the list of keys 
.RE
.PP
Definition at line 1359 of file kfilemetainfo.cpp.
.PP
References QDictIterator::current().
.SS "\fBQStringList\fP KFileMimeTypeInfo::preferredKeys () const\fC [inline]\fP"
.PP
Return a list of all supported keys in preference order. \fBReturns:\fP
.RS 4
the list of keys 
.RE
.PP
Definition at line 468 of file kfilemetainfo.h.

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