• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDECore

KMimeType Class Reference

Represent a mime type, like "text/plain", and the data that is associated with it. More...

#include <kmimetype.h>

Inheritance diagram for KMimeType:

Inheritance graph
[legend]

List of all members.


Public Types

enum  FindByNameOption { DontResolveAlias, ResolveAliases = 1 }
typedef QList< Ptr > List
typedef KSharedPtr< KMimeType > Ptr

Public Member Functions

QStringList allParentMimeTypes () const
QString comment (const KUrl &url=KUrl()) const
QString iconName (const KUrl &url=KUrl()) const
bool is (const QString &mimeTypeName) const
bool isDefault () const
KDE_DEPRECATED QString parentMimeType () const
QStringList parentMimeTypes () const
QStringList patterns () const
virtual ~KMimeType ()

Static Public Member Functions

static List allMimeTypes ()
static QString defaultMimeType ()
static KMimeType::Ptr defaultMimeTypePtr ()
static QString extractKnownExtension (const QString &fileName)
static QString favIconForUrl (const KUrl &url)
static Ptr findByContent (const QByteArray &data, int *accuracy=0)
static Ptr findByFileContent (const QString &fileName, int *accuracy=0)
static Ptr findByNameAndContent (const QString &name, const QByteArray &data, mode_t mode=0, int *accuracy=0)
static Ptr findByPath (const QString &path, mode_t mode=0, bool fast_mode=false, int *accuracy=0)
static Ptr findByUrl (const KUrl &url, mode_t mode=0, bool is_local_file=false, bool fast_mode=false, int *accuracy=0)
static QString iconNameForUrl (const KUrl &url, mode_t mode=0)
static bool isBinaryData (const QString &fileName)
static bool isBufferBinaryData (const QByteArray &data)
static Ptr mimeType (const QString &name, FindByNameOption options=DontResolveAlias)

Protected Member Functions

void internalClearData ()
 KMimeType (KMimeTypePrivate &dd, const QString &name, const QString &comment)
 KMimeType (KMimeTypePrivate &dd)
 KMimeType (const QString &fullpath, const QString &name, const QString &comment)
 KMimeType (QDataStream &str, int offset)
void setParentMimeType (const QString &parent)
void setPatterns (const QStringList &patterns)

Detailed Description

Represent a mime type, like "text/plain", and the data that is associated with it.

The starting point you need is often the static methods.

KMimeType inherits KServiceType because "text/plain" can be used to find services (apps and components) "which can open text/plain".

See also:
KServiceType

Definition at line 46 of file kmimetype.h.


Member Typedef Documentation

typedef QList<Ptr> KMimeType::List

Reimplemented from KServiceType.

Definition at line 51 of file kmimetype.h.

typedef KSharedPtr<KMimeType> KMimeType::Ptr

Reimplemented from KServiceType.

Definition at line 50 of file kmimetype.h.


Member Enumeration Documentation

enum KMimeType::FindByNameOption

Enumerator:
DontResolveAlias 
ResolveAliases 

Definition at line 105 of file kmimetype.h.


Constructor & Destructor Documentation

KMimeType::~KMimeType (  )  [virtual]

Definition at line 516 of file kmimetype.cpp.

KMimeType::KMimeType ( QDataStream &  str,
int  offset 
) [protected]

For internal use only.

Construct a service from a stream.

The stream must already be positionned at the correct offset

Definition at line 485 of file kmimetype.cpp.

KMimeType::KMimeType ( const QString &  fullpath,
const QString &  name,
const QString &  comment 
) [protected]

Construct a mimetype and take all information from an XML file.

Parameters:
fullpath the path to the xml that describes the mime type
name the name of the mimetype (usually the end of the path)
comment the comment associated with the mimetype

Definition at line 474 of file kmimetype.cpp.

KMimeType::KMimeType ( KMimeTypePrivate &  dd  )  [protected]

Construct a mimetype from another mimetype's private object.

Parameters:
dd the private object

Definition at line 480 of file kmimetype.cpp.

KMimeType::KMimeType ( KMimeTypePrivate &  dd,
const QString &  name,
const QString &  comment 
) [protected]

Construct a mimetype based on another mimetype's private object.

Allows the name and comment to be overridden.

Parameters:
dd the private object
name the name of the mimetype
comment the comment associated with the mimetype

Definition at line 468 of file kmimetype.cpp.


Member Function Documentation

KMimeType::List KMimeType::allMimeTypes (  )  [static]

Get all the mimetypes.

Useful for showing the list of available mimetypes. More memory consuming than the ones above, don't use unless really necessary.

Returns:
the list of all existing KMimeTypes

Definition at line 165 of file kmimetype.cpp.

QStringList KMimeType::allParentMimeTypes (  )  const

Return all parent mimetypes of this mimetype, direct or indirect.

This includes the parent(s) of its parent(s), etc. If this mimetype is an alias, the list also contains the canonical name for this mimetype.

The usual reason to use this method is to look for a setting which is stored per mimetype (like PreviewJob does).

Since:
4.1

Definition at line 660 of file kmimetype.cpp.

QString KMimeType::comment ( const KUrl &  url = KUrl()  )  const

Returns the descriptive comment associated with the MIME type.

The url argument is unused, but provided so that KMimeType derived classes can use it.

Returns:
The descriptive comment associated with the MIME type, if any.

Definition at line 569 of file kmimetype.cpp.

QString KMimeType::defaultMimeType (  )  [static]

Returns the name of the default mimetype.

Always application/octet-stream, but this method exists for performance purposes.

Returns:
the name of the default mime type, always "application/octet-stream"

Definition at line 670 of file kmimetype.cpp.

KMimeType::Ptr KMimeType::defaultMimeTypePtr (  )  [static]

Returns the default mimetype.

Always application/octet-stream. This can be used to check the result of mimeType(name).

Returns:
the "application/octet-stream" mimetype pointer.

Definition at line 96 of file kmimetype.cpp.

QString KMimeType::extractKnownExtension ( const QString &  fileName  )  [static]

Determines the extension from a filename (or full path) using the mimetype database.

This allows to extract "tar.bz2" for foo.tar.bz2 but still return "txt" for my.doc.with.dots.txt

Definition at line 420 of file kmimetype.cpp.

QString KMimeType::favIconForUrl ( const KUrl &  url  )  [static]

Return the "favicon" (see http://www.favicon.com) for the given url, if available.

Does NOT attempt to download the favicon, it only returns one that is already available.

If unavailable, returns QString().

Parameters:
url the URL of the favicon
Returns:
the name of the favicon, or QString()

Definition at line 548 of file kmimetype.cpp.

KMimeType::Ptr KMimeType::findByContent ( const QByteArray &  data,
int *  accuracy = 0 
) [static]

Tries to find out the MIME type of a data chunk by looking for certain magic numbers and characteristic strings in it.

Parameters:
data the data to examine
accuracy If not a null pointer, *accuracy is set to the accuracy of the match (which is in the range 0..100)
Returns:
a pointer to the KMimeType. 0 if the type can not be found this way.

Definition at line 427 of file kmimetype.cpp.

KMimeType::Ptr KMimeType::findByFileContent ( const QString &  fileName,
int *  accuracy = 0 
) [static]

Tries to find out the MIME type of a file by looking for certain magic numbers and characteristic strings in it.

This function is similar to the previous one. Note that the file name is not used for determining the file type, it is just used for loading the file's contents.

Parameters:
fileName the path to the file
accuracy If not a null pointer, *accuracy is set to the accuracy of the match (which is in the range 0..100)
Returns:
a pointer to the KMimeType, or the default mimetype (application/octet-stream) if the file cannot be opened.

Definition at line 436 of file kmimetype.cpp.

KMimeType::Ptr KMimeType::findByNameAndContent ( const QString &  name,
const QByteArray &  data,
mode_t  mode = 0,
int *  accuracy = 0 
) [static]

Tries to find out the MIME type of filename/url and a data chunk.

Whether to trust the extension or the data depends on the results of both approaches, and is determined automatically.

This method is useful for instance in the get() method of kioslaves, and anywhere else where a filename is associated with some data which is available immediately.

Parameters:
name the filename or url representing this data. Only used for the extension, not used as a local filename.
data the data to examine when the extension isn't conclusive in itself
mode the mode of the file (used, for example, to identify executables)
accuracy If not a null pointer, *accuracy is set to the accuracy of the match (which is in the range 0..100)

Definition at line 411 of file kmimetype.cpp.

KMimeType::Ptr KMimeType::findByPath ( const QString &  path,
mode_t  mode = 0,
bool  fast_mode = false,
int *  accuracy = 0 
) [static]

Finds a KMimeType with the given url.

This function looks at mode_t first. If that does not help it looks at the extension. This is fine for FTP, FILE, TAR and friends, but is not for HTTP ( cgi scripts! ). You should use KRun instead, but this function returns immediately while KRun is async. If no extension matches, then the file contents will be examined if the URL is a local file, or "application/octet-stream" is returned otherwise.

Equivalent to

 KUrl u;
 u.setPath(path);
 return findByUrl( u, mode, true, fast_mode );

Parameters:
path the path to the file
mode the mode of the file (used, for example, to identify executables)
fast_mode If set to true no disk access is allowed to find out the mimetype. The result may be suboptimal, but it is fast.
accuracy If not a null pointer, *accuracy is set to the accuracy of the match (which is in the range 0..100)
Returns:
A pointer to the matching mimetype. 0 is never returned.

Definition at line 403 of file kmimetype.cpp.

KMimeType::Ptr KMimeType::findByUrl ( const KUrl &  url,
mode_t  mode = 0,
bool  is_local_file = false,
bool  fast_mode = false,
int *  accuracy = 0 
) [static]

Finds a KMimeType with the given url.

This function looks at mode_t first. If that does not help it looks at the extension. This is fine for FTP, FILE, TAR and friends, but is not for HTTP ( cgi scripts! ). You should use KRun instead, but this function returns immediately while KRun is async. If no extension matches, then the file contents will be examined if the URL is a local file, or "application/octet-stream" is returned otherwise.

Parameters:
url Is the right most URL with a filesystem protocol. It is up to you to find out about that if you have a nested URL. For example "http://localhost/mist.gz#gzip:/decompress" would have to pass the "http://..." URL part, while "file:/tmp/x.tar#tar:/src/test.gz#gzip:/decompress" would have to pass the "tar:/..." part of the URL, since gzip is a filter protocol and not a filesystem protocol.
mode the mode of the file (used, for example, to identify executables)
is_local_file true if the file is local; false if not, or if you don't know.
fast_mode If set to true no disk access is allowed to find out the mimetype. The result may be suboptimal, but it is fast.
accuracy if set, the accuracy of the result, between 0 and 100. For instance, when the extension was used to determine the mimetype, the accuracy is set to 80, as per the shared-mime spec. Some 'magic' rules (used when !fast_mode) have an accuracy > 80 (and have priority over the filename, others are < 80).
Returns:
A pointer to the matching mimetype. 0 is never returned. Very Important: Don't store the result in a KMimeType* !

Definition at line 390 of file kmimetype.cpp.

QString KMimeType::iconName ( const KUrl &  url = KUrl()  )  const

Return the filename of the icon associated with the mimetype.

Use KIconLoader::loadMimeTypeIcon to load the icon.

The url argument is unused, but is provided so that KMimeType-derived classes can use it (e.g. KFolderType uses the URL to return one out of 2 icons)

Returns:
The path to the icon associated with this MIME type.

Definition at line 677 of file kmimetype.cpp.

QString KMimeType::iconNameForUrl ( const KUrl &  url,
mode_t  mode = 0 
) [static]

Return the filename of the icon associated with the mimetype, for a given url.

Use KIconLoader::loadMimeTypeIcon to load the icon.

Parameters:
url URL for the file
mode the mode of the file. The mode may modify the icon with overlays that show special properties of the icon. Use 0 for default
Returns:
the name of the icon. The name of a default icon if there is no icon for the mime type

Definition at line 520 of file kmimetype.cpp.

void KMimeType::internalClearData (  )  [protected]

For internal use only.

for kbuildsycoca. Don't ever use this, or else...

Definition at line 702 of file kmimetype.cpp.

bool KMimeType::is ( const QString &  mimeTypeName  )  const

Do not use name()=="somename" anymore, to check for a given mimetype.

For mimetype inheritance to work, use is("somename") instead. Warning, do not use inherits(), that's the servicetype inheritance concept! is() also supports mimetype aliases.

Definition at line 615 of file kmimetype.cpp.

bool KMimeType::isBinaryData ( const QString &  fileName  )  [static]

Returns whether a file has an internal format that is not human readable.

This is much more generic than "not mime->is(text/plain)". Many application file formats (like rtf and postscript) are based on text, but text that the user should rarely ever see.

Definition at line 459 of file kmimetype.cpp.

bool KMimeType::isBufferBinaryData ( const QByteArray &  data  )  [static]

Returns whether a buffer has an internal format that is not human readable.

This is much more generic than "not mime->is(text/plain)". Many application file formats (like rtf and postscript) are based on text, but text that the user should rarely ever see.

Definition at line 170 of file kmimetype.cpp.

bool KMimeType::isDefault (  )  const

Return true if this mimetype is the default mimetype.

Definition at line 103 of file kmimetype.cpp.

KMimeType::Ptr KMimeType::mimeType ( const QString &  name,
FindByNameOption  options = DontResolveAlias 
) [static]

Retrieve a pointer to the mime type name.

Very important: Don't store the result in a KMimeType* !

Also note that you get a new KMimeType pointer every time you call this. Don't ever write code that compares mimetype pointers, compare names instead.

Parameters:
name the name of the mime type
options controls how the mime type is searched for
Returns:
the pointer to the KMimeType with the given name, or 0 if not found
See also:
KServiceType::serviceType

Definition at line 160 of file kmimetype.cpp.

QString KMimeType::parentMimeType (  )  const

If this mimetype is a subclass of another mimetype, return the name of the parent.

Returns:
the parent mime type, or QString() if not set
Deprecated:
this method does not support multiple inheritance, which is actually part of the shared-mime-info standard. Use is(), parentMimeTypes(), or allParentMimeTypes() instead of parentMimeType()

Definition at line 575 of file kmimetype.cpp.

QStringList KMimeType::parentMimeTypes (  )  const

If this mimetype is a subclass of one or more other mimetypes, return the list of those mimetypes.

For instance a application/javascript is a special kind of text/plain, so the definition of application/javascript says sub-class-of type="text/plain"

Another example: application/x-shellscript is a subclass of two other mimetypes, application/x-executable and text/plain.

(Note that this notion doesn't map to the servicetype inheritance mechanism, since an application that handles the specific type doesn't necessarily handle the base type. The opposite is true though.)

Returns:
the list of parent mimetypes
Since:
4.1

Definition at line 626 of file kmimetype.cpp.

QStringList KMimeType::patterns (  )  const

Retrieve the list of patterns associated with the MIME Type.

Returns:
a list of file globs that describe the file names (or, usually, the extensions) of files with this mime type

Definition at line 683 of file kmimetype.cpp.

void KMimeType::setParentMimeType ( const QString &  parent  )  [protected]

For internal use only.

for kbuildsycoca. Don't ever use this, or else...

Definition at line 695 of file kmimetype.cpp.

void KMimeType::setPatterns ( const QStringList &  patterns  )  [protected]

For internal use only.

for kbuildsycoca. Don't ever use this, or else...

Definition at line 689 of file kmimetype.cpp.


The documentation for this class was generated from the following files:
  • kmimetype.h
  • kmimetype.cpp

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal