---

KFilePlugin Class Reference

#include <kfilemetainfo.h>

List of all members.

Public Methods
virtual bool	readInfo (KFileMetaInfo &info, uint what=KFileMetaInfo::Fastest)=0
virtual bool	writeInfo (const KFileMetaInfo &) const
virtual QValidator *	createValidator (const QString &, const QString &, const QString &, QObject *, const char *) const
Protected Methods
KFileMimeTypeInfo *	addMimeTypeInfo (const QString &mimeType)

---

Detailed Description

Baseclass for a meta info plugin. If you want to write your own plugin, you need to derive from this class.

In your plugin, you need to create a factory for the KFilePlugin

Example:

 typedef KGenericFactory<MyPlugin> MyFactory;
 K_EXPORT_COMPONENT_FACTORY(kfile_foo, MyFactory("kfile_foo"));
  

and then just overwrite the methods your plugin supports. If your plugin can only read data, it is sufficient to only write a readInfo() method. If you also want to support changing data and writing it back into the file, you usually need all methods.

Definition at line 1078 of file kfilemetainfo.h.

---

Member Function Documentation

KFileMimeTypeInfo* KFilePlugin::addMimeTypeInfo (  const QString &    mimeType )  [protected]

Call this in your constructor

virtual QValidator* KFilePlugin::createValidator (  const QString &   , const QString &   , const QString &   , QObject *   , const char *    )  const [inline, virtual]

This method should create an appropriate validator for the specified item if it's editable or return a null pointer if not. If you don't have any editable items, you don't need this method. If you you don't need any validation, e.g. you accept any input, you can simply return 0L, or not reimplement this method at all. Definition at line 1113 of file kfilemetainfo.h.

virtual bool KFilePlugin::readInfo (  KFileMetaInfo &    info, uint    what = KFileMetaInfo::Fastest )  [pure virtual]

Read the info from the file in this method and insert it into the provided KFileMetaInfo object. You can get the path to the file with info.path()

virtual bool KFilePlugin::writeInfo (  const KFileMetaInfo &    )  const [inline, virtual]

Similar to the above method, but for writing the info back to the file. If you don't have any writable keys, don't implement this method Definition at line 1100 of file kfilemetainfo.h.

---

The documentation for this class was generated from the following file:

• kfilemetainfo.h

---