class KMimeMagic

The goal of KMimeMagic is to determine auto-magically the type of file, not only using its extension, but also reading its contents. More...

Definition#include <kmimemagic.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Static Methods

Protected Static Methods

Protected Members


Detailed Description

The goal of KMimeMagic is to determine auto-magically the type of file, not only using its extension, but also reading its contents. Unless specified otherwise, KMimeMagic uses $KDEDIR/share/mimelnk/magic for this purpose.

The basic usage of KMimeMagic is : - get a pointer to it, using KMimeMagic::self() - use it for any file or buffer you want, using one of the three find...Type methods.

The result is contained in the class KMimeMagicResult

 KMimeMagic ( const QString & configFile )

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

KMimeMagic ()

Destroys the parser

bool  mergeConfig ( const QString & configFile )

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

Returns: true on success.

bool  mergeBufConfig (char *)

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

Returns: : true on success.

void  setFollowLinks ( bool _enable )

Enable/Disable follow-links. (Default is off)

KMimeMagicResult*  findFileType ( const QString & _filename )

Tries 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.

KMimeMagicResult*  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. The integer parameter supplies the lenght of the buffer.

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.

KMimeMagicResult *  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.

KMimeMagic*  self ()

[static]

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

KMimeMagicResult * magicResult

[protected]

The result type.


Generated by: root@porky.devel.redhat.com on Wed May 10 08:56:52 2000, using kdoc 2.0a35.