Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KFileMimeTypeInfo Class Reference

#include <kfilemetainfo.h>

List of all members.

Public Types

enum  Attributes { , MultiLine = 32, SqueezeText = 64 }
enum  Hint
enum  Unit { ,
  FramesPerSecond = 8, DotsPerInch = 9, BitsPerPixel = 10, Hertz = 11,
  KiloBytes = 12
}

Public Methods

QValidator * createValidator (const QString &group, const QString &key, QObject *parent=0, const char *name=0) const
QStringList supportedGroups () const
QStringList translatedGroups () const
QStringList preferredGroups () const
QString mimeType () const
const GroupInfogroupInfo (const QString &group) const
QStringList supportedKeys () const
QStringList preferredKeys () const


Detailed Description

This class provides information about the capabilities that a KFilePlugin 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.

Definition at line 47 of file kfilemetainfo.h.


Member Enumeration Documentation

enum KFileMimeTypeInfo::Attributes
 

This enum is used to specify some attributes that an item can have, which fit neither in the Hint nor in the Unit enum.

  • Addable The item or group can be added by a user
  • Removable It can be removed
  • Modifiable Its value can be edited (no meaning for a group)
  • Cummulative 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)
  • Averaged Similar to Cummulative, but the average should be calculated instead of the sum
  • MultiLine 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
  • SqueezeText If the text for this item is very long, it should be squeezed to the size of the widget where it's displayed
Enumeration values:
MultiLine 
Since:
3.1
SqueezeText 
Since:
3.1

Definition at line 77 of file kfilemetainfo.h.

enum KFileMimeTypeInfo::Hint
 

This enum is mainly for items that have a special meaning for some applications.

  • NoHint No hint
  • Name The name or title of the document
  • Author The one who created the contents of it
  • Description Some information about the document
  • Width A width in pixels
  • Height A height in pixels
  • Size A size in pixels (witdh and height)
  • Bitrate For media files
  • Length The length of the file, also for media files
  • Hidden The item is usually not shown to the user
  • Thumbnail The item is a thumbnail of the file

Definition at line 104 of file kfilemetainfo.h.

enum KFileMimeTypeInfo::Unit
 

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.

  • NoUnit None of the listed units
  • Seconds The item represents a time in seconds
  • MilliSeconds The item represents a time in milliseconds
  • BitsPerSecond A bit rate
  • Pixels For resolutions
  • Inches Sizes
  • Centimeters Sizes
  • Bytes Some data/file size in bytes
  • KiloBytes Some data/file size in kilobytes
  • FramesPerSecond A frame rate
  • DotsPerInch Resolution in DPI
  • BitsPerPixel A bit depth
  • Hertz Sample rates and similar
Enumeration values:
FramesPerSecond 
Since:
3.1
DotsPerInch 
Since:
3.1
BitsPerPixel 
Since:
3.1
Hertz 
Since:
3.1
KiloBytes 
Since:
3.1

Definition at line 139 of file kfilemetainfo.h.


Member Function Documentation

QValidator* KFileMimeTypeInfo::createValidator const QString &    group,
const QString &    key,
QObject *    parent = 0,
const char *    name = 0
const
 

Creates a validator for this item. Make sure to supply a proper parent argument or delete the validator yourself.

const GroupInfo* KFileMimeTypeInfo::groupInfo const QString &    group const
 

Get the group info for a specific group.

Returns:
a pointer to the info. Don't delete this object!

QString KFileMimeTypeInfo::mimeType   const [inline]
 

Returns the mimetype to which this info belongs.

Definition at line 442 of file kfilemetainfo.h.

QStringList KFileMimeTypeInfo::preferredGroups   const [inline]
 

This returns the list of groups in the preferred order that's specified in the .desktop file.

Returns:
the list of groups

Definition at line 434 of file kfilemetainfo.h.

QStringList KFileMimeTypeInfo::preferredKeys   const [inline]
 

Return a list of all supported keys in preference order

Returns:
the list of keys

Definition at line 468 of file kfilemetainfo.h.

QStringList KFileMimeTypeInfo::supportedGroups  
 

Returns the list of all groups that the plugin for this mimetype supports.

Returns:
the list of groups

QStringList KFileMimeTypeInfo::supportedKeys  
 

Return a list of all supported keys without looking for a specific group

Returns:
the list of keys

QStringList KFileMimeTypeInfo::translatedGroups  
 

Same as the above function, but returns the strings to display to the user.

Returns:
the list of groups


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:13 2003 for kdelibs by doxygen1.2.18