kio Library API Documentation

KMimeMagic Class Reference

#include <kmimemagic.h>

List of all members.

Public Methods

 KMimeMagic ()
 Create a parser and initialize it with the KDE-global data: the "magic" config file as well as the snippets from share/config/magic.

 KMimeMagic (const QString &configFile)
 Create a parser and initialize it with the given config file.

 ~KMimeMagic ()
 Destroy the parser.

bool mergeConfig (const QString &configFile)
 Merge an existing parse table with the data from the given file.

bool mergeBufConfig (char *)
 Merge an existing parse table with the data from the given buffer.

void setFollowLinks (bool _enable)
 Enable/Disable follow-links.

KMimeMagicResultfindFileType (const QString &_filename)
 Try to find a MimeType for the given file.

KMimeMagicResultfindBufferType (const QByteArray &p)
 Same functionality as above, except data is not read from a file.

KMimeMagicResultfindBufferFileType (const QByteArray &, const QString &filename)
 Same functionality as findBufferType() but with additional capability of distinguishing between C-headers and C-Source.


Static Public Methods

KMimeMagic * self ()
 Returns a pointer to the unique KMimeMagic instance in this process.


Protected Attributes

KMimeMagicResultmagicResult
 The result type.


Detailed Description

Deprecated:
Use KMimeType::findByContent() instead May be removed in KDE 4.0 Determine auto-magically the type of file, not only by using its extension, but also by reading its contents.

Unless specified otherwise, KMimeMagic uses $KDEDIR/share/mimelnk/magic for this purpose.

To make KMimeMagic restore the 'atime' of a file after it opened it, add its directory in kmimemagicrc like: [Settings] atimeDirs=/tmp,/var/tmp,/home/dfaure/tmp This isn't done by default because it changes the 'ctime'. See kmimemagic.cpp for a full discussion on this issue.

The basic usage of KMimeMagic is :

The result is contained in the class KMimeMagicResult.

Definition at line 100 of file kmimemagic.h.


Constructor & Destructor Documentation

KMimeMagic::KMimeMagic  
 

Create a parser and initialize it with the KDE-global data: the "magic" config file as well as the snippets from share/config/magic.

Since:
3.1

Definition at line 2049 of file kmimemagic.cpp.

References KGlobal::dirs(), KStandardDirs::findAllResources(), and mergeConfig().

KMimeMagic::KMimeMagic const QString   configFile
 

Create a parser and initialize it with the given config file.

Definition at line 2061 of file kmimemagic.cpp.

KMimeMagic::~KMimeMagic  
 

Destroy the parser.

Definition at line 2090 of file kmimemagic.cpp.

References magicResult.


Member Function Documentation

bool KMimeMagic::mergeConfig const QString   configFile
 

Merge an existing parse table with the data from the given file.

Returns:
true on success.

Definition at line 2107 of file kmimemagic.cpp.

References QString::isEmpty().

Referenced by KMimeMagic().

bool KMimeMagic::mergeBufConfig char *   
 

Merge an existing parse table with the data from the given buffer.

Returns:
true on success.

Definition at line 2125 of file kmimemagic.cpp.

void KMimeMagic::setFollowLinks bool    _enable
 

Enable/Disable follow-links.

(Default is disabled.)

Definition at line 2142 of file kmimemagic.cpp.

KMimeMagicResult * KMimeMagic::findFileType const QString   _filename
 

Try to find a MimeType for the given file.

If no special MimeType is found, the default MimeType is returned. This function looks at the content of the file.

Returns:
A pointer to the result object. Do not delete the result object. After another call to KMimeMagic the returned result object changes its value since it is reused by KMimeMagic.

Definition at line 2205 of file kmimemagic.cpp.

References magicResult, KMimeMagicResult::setAccuracy(), KMimeMagicResult::setInvalid(), KMimeMagicResult::setMimeType(), and QString::stripWhiteSpace().

Referenced by KMimeType::findByFileContent(), and KMimeType::findByURL().

KMimeMagicResult * KMimeMagic::findBufferType const QByteArray   p
 

Same functionality as above, except data is not read from a file.

Instead a buffer can be supplied which is examined.

Returns:
A pointer to the result object. Do not delete the result object. After another call to KMimeMagic the returned result object changes its value since it is reused by KMimeMagic.

Definition at line 2148 of file kmimemagic.cpp.

References magicResult, KMimeMagicResult::setAccuracy(), KMimeMagicResult::setInvalid(), KMimeMagicResult::setMimeType(), and QString::stripWhiteSpace().

Referenced by findBufferFileType(), and KMimeType::findByContent().

KMimeMagicResult * KMimeMagic::findBufferFileType const QByteArray  ,
const QString   filename
 

Same functionality as findBufferType() but with additional capability of distinguishing between C-headers and C-Source.

For this purpose this function looks at the extension of the filename. This means that 'filename' can be a filename on some FTP server, too.

Returns:
A pointer to the result object. Do not delete the result object. After another call to KMimeMagic the returned result object changes its value since it is reused by KMimeMagic.

Definition at line 2194 of file kmimemagic.cpp.

References findBufferType().

KMimeMagic * KMimeMagic::self   [static]
 

Returns a pointer to the unique KMimeMagic instance in this process.

Definition at line 30 of file kmimemagic.cpp.

Referenced by KMimeType::findByContent(), KMimeType::findByFileContent(), and KMimeType::findByURL().


Member Data Documentation

KMimeMagicResult* KMimeMagic::magicResult [protected]
 

The result type.

Definition at line 196 of file kmimemagic.h.

Referenced by findBufferType(), findFileType(), and ~KMimeMagic().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:36 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001