class KMimeMagic

Public Methods

•  KMimeMagic ( const QString & configFile )
•  ~KMimeMagic ()
• bool  mergeConfig ( const QString & configFile )
• bool  mergeBufConfig (char *)
• void  setFollowLinks ( bool _enable )
• KMimeMagicResult*  findFileType ( const QString & _filename )
• KMimeMagicResult*  findBufferType ( const QByteArray &p )
• KMimeMagicResult *  findBufferFileType ( const QByteArray &, const QString & filename )

Public Static Methods

• static KMimeMagic*  self ()

Protected Static Methods

• static void  initStatic ()

Protected Members

• KMimeMagicResult * magicResult
• static KMimeMagic* s_pSelf

Detailed Description

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 :

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

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

Destroy the parser.

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

Returns: true on success.

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

Returns: true on success.

Enable/Disable follow-links.

(Default is disabled.)

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.

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.

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.

[static]

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

[protected]

[protected static]

The result type.

[protected]