.TH "KFileMimeTypeInfo" kde3 "11 Jun 2005" "Version Version 3.4.1" "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. Represents the capabilities of a \fBKFilePlugin\fP for a given mimetype.  

.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, \fBCumulative\fP =  8, \fBCummulative\fP =  Cumulative, \fBAveraged\fP =  16, \fBMultiLine\fP =  32, \fBSqueezeText\fP =  64 }"
.br
.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
.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, \fBMillimeters\fP =  13 }"
.br
.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
.ti -1c
.RI "\fBQStringList\fP \fBsupportedGroups\fP () const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBtranslatedGroups\fP () const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBpreferredGroups\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBmimeType\fP () const "
.br
.ti -1c
.RI "const \fBGroupInfo\fP * \fBgroupInfo\fP (const \fBQString\fP &group) const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBsupportedKeys\fP () const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBpreferredKeys\fP () const "
.br
.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
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBGroupInfo\fP"
.br
.RI "\fIThis is the class for one group of items of a \fBKFileMimeTypeInfo\fP. Information about a meta information group. \fP"
.ti -1c
.RI "class \fBItemInfo\fP"
.br
.RI "\fIThis is the class for one item of a \fBKFileMimeTypeInfo\fP. \fP"
.in -1c
.SH "Detailed Description"
.PP 
This class provides information about the capabilities that a \fBKFilePlugin\fP for a given mimetype has. Represents the capabilities of a \fBKFilePlugin\fP for a given mimetype. 

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
\fBAuthor:\fP
.RS 4
Rolf Magnus 
.PP
Carsten Pfeiffer 
.RE
.PP

.PP
Definition at line 48 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 Hint nor in the Unit enum. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIAddable \fP\fP
The item or group can be added by a user. 
.TP
\fB\fIRemovable \fP\fP
It can be removed. 
.TP
\fB\fIModifiable \fP\fP
The value can be edited (no meaning for a group). 
.TP
\fB\fICumulative \fP\fP
If an application wants to display information for more than one file, it may add up the values for this item (e.g. 
.PP
play time of an mp3 file) 
.TP
\fB\fICummulative \fP\fP
\fBDeprecated\fP
.RS 4
Use \fBCumulative\fP instead
.RE
.PP

.TP
\fB\fIAveraged \fP\fP
Similar to Cumulative, but the average should be calculated instead of the sum. 
.TP
\fB\fIMultiLine \fP\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 
.PP
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP

.TP
\fB\fISqueezeText \fP\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
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP

.PP
Definition at line 62 of file kfilemetainfo.h.
.SS "enum \fBKFileMimeTypeInfo::Hint\fP"
.PP
This enum is mainly for items that have a special meaning for some applications. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fINoHint \fP\fP
No hint. 
.TP
\fB\fIName \fP\fP
The name or title of the document. 
.TP
\fB\fIAuthor \fP\fP
The one who created the contents of it. 
.TP
\fB\fIDescription \fP\fP
Description Some information about the document. 
.TP
\fB\fIWidth \fP\fP
The width in pixels. 
.TP
\fB\fIHeight \fP\fP
The height in pixels. 
.TP
\fB\fISize \fP\fP
The size in pixels (width and height). 
.TP
\fB\fIBitrate \fP\fP
For media files. 
.TP
\fB\fILength \fP\fP
The length of the file, also for media files. 
.TP
\fB\fIHidden \fP\fP
The item is usually not shown to the user. 
.TP
\fB\fIThumbnail \fP\fP
The item is a thumbnail picture of the file. 
.PP
Definition at line 87 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. 
.PP
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
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fINoUnit \fP\fP
None of the listed units. 
.TP
\fB\fISeconds \fP\fP
The item represents a time in seconds. 
.TP
\fB\fIMilliSeconds \fP\fP
The item represents a time in milliseconds. 
.TP
\fB\fIBitsPerSecond \fP\fP
A bit rate. 
.TP
\fB\fIPixels \fP\fP
For image dimensions and similar. 
.TP
\fB\fIInches \fP\fP
Sizes. 
.TP
\fB\fICentimeters \fP\fP
Sizes. 
.TP
\fB\fIBytes \fP\fP
Some data/file size in bytes. 
.TP
\fB\fIFramesPerSecond \fP\fP
A frame rate 
.PP
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP

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

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

.TP
\fB\fIHertz \fP\fP
Sample rates and similar 
.PP
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP

.TP
\fB\fIKiloBytes \fP\fP
Some data/file size in kilobytes 
.PP
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP

.TP
\fB\fIMillimeters \fP\fP
Sizes 
.PP
\fBSince:\fP
.RS 4
3.3. 
.RE
.PP

.PP
Definition at line 109 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 = \fC0\fP, const char * name = \fC0\fP) const"
.PP
Creates a validator for this item. 
.PP
Make sure to supply a proper \fCparent\fP argument or delete the validator yourself. 
.PP
\fBParameters:\fP
.RS 4
\fIgroup\fP the group of the item 
.br
\fIkey\fP the key of the item 
.br
\fIparent\fP the parent of the \fBQObject\fP, or 0 for a parent-less object 
.br
\fIname\fP the name of the \fBQObject\fP, can be 0 
.RE
.PP
\fBReturns:\fP
.RS 4
the validator. You are responsible for deleting it. 0 if creation failed 
.RE
.PP

.PP
Definition at line 1518 of file kfilemetainfo.cpp.
.PP
References KFilePlugin::createValidator(), and mimeType().
.SS "\fBQStringList\fP KFileMimeTypeInfo::supportedGroups () const"
.PP
Returns the list of all groups that the plugin for this mimetype supports. 
.PP
\fBReturns:\fP
.RS 4
the list of groups 
.RE
.PP

.PP
Definition at line 1480 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. 
.PP
\fBReturns:\fP
.RS 4
the list of groups 
.RE
.PP

.PP
Definition at line 1490 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. 
.PP
\fBReturns:\fP
.RS 4
the list of groups 
.RE
.PP

.PP
Definition at line 419 of file kfilemetainfo.h.
.SS "\fBQString\fP KFileMimeTypeInfo::mimeType () const\fC [inline]\fP"
.PP
Returns the mimetype to which this info belongs. 
.PP
\fBReturns:\fP
.RS 4
the mimetype of this info 
.RE
.PP

.PP
Definition at line 428 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. 
.PP
\fBParameters:\fP
.RS 4
\fIgroup\fP the group whose group info should be retrieved 
.RE
.PP
\fBReturns:\fP
.RS 4
a pointer to the info. 0 if it does not exist. Don't delete this object! 
.RE
.PP

.PP
Definition at line 1467 of file kfilemetainfo.cpp.
.PP
References QDict::find().
.SS "\fBQStringList\fP KFileMimeTypeInfo::supportedKeys () const"
.PP
Return a list of all supported keys without looking for a specific group. 
.PP
\fBReturns:\fP
.RS 4
the list of keys 
.RE
.PP

.PP
Definition at line 1500 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. 
.PP
\fBReturns:\fP
.RS 4
the list of keys 
.RE
.PP

.PP
Definition at line 456 of file kfilemetainfo.h.

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