qgisplugin.h File Reference

#include <QString>

Include dependency graph for qgisplugin.h:

Go to the source code of this file.

Classes
class	QgisPlugin
	Abstract base class from which all plugins must inherit. More...

Macros
#define	SIP_NO_FILE
	QGIS - Plugin API. More...

Typedefs
typedef QString	category_t()
	Typedef for getting the category without instantiating the plugin. More...
typedef QgisPlugin *	create_t(QgisInterface *)
	Typedef for the function that returns a generic pointer to a plugin object. More...
typedef QString	description_t()
	Typedef for getting the description without instantiating the plugin. More...
typedef QString	experimental_t()
	Typedef for getting the experimental status without instantiating the plugin. More...
typedef QString	icon_t()
	Typedef for getting the plugin icon file name without instantiating the plugin. More...
typedef QString	name_t()
	Typedef for getting the name of the plugin without instantiating it. More...
typedef int	type_t()
	Typedef for getting the plugin type without instantiating the plugin. More...
typedef void	unload_t(QgisPlugin *)
	Typedef for the function to unload a plugin and free its resources. More...
typedef QString	version_t()
	Typedef for getting the plugin version without instantiating the plugin. More...

Macro Definition Documentation

#define SIP_NO_FILE

QGIS - Plugin API.

About QGis Plugins

Plugins provide additional functionality to QGis. Plugins must implement several required methods in order to be registered with QGis. These methods include: name:

• version
• description

All QGis plugins must inherit from the abstract base class QgisPlugin. This list will grow as the API is expanded.

In addition, a plugin must implement the classFactory and unload functions. Note that these functions must be declared as extern "C" in order to be resolved properly and prevent C++ name mangling.

Definition at line 38 of file qgisplugin.h.

Typedef Documentation

typedef QString category_t()

Typedef for getting the category without instantiating the plugin.

Definition at line 203 of file qgisplugin.h.

typedef QgisPlugin* create_t(QgisInterface *)

Typedef for the function that returns a generic pointer to a plugin object.

Definition at line 191 of file qgisplugin.h.

typedef QString description_t()

Typedef for getting the description without instantiating the plugin.

Definition at line 200 of file qgisplugin.h.

typedef QString experimental_t()

Typedef for getting the experimental status without instantiating the plugin.

Definition at line 215 of file qgisplugin.h.

typedef QString icon_t()

Typedef for getting the plugin icon file name without instantiating the plugin.

Definition at line 212 of file qgisplugin.h.

typedef QString name_t()

Typedef for getting the name of the plugin without instantiating it.

Definition at line 197 of file qgisplugin.h.

typedef int type_t()

Typedef for getting the plugin type without instantiating the plugin.

Definition at line 206 of file qgisplugin.h.

typedef void unload_t(QgisPlugin *)

Typedef for the function to unload a plugin and free its resources.

Definition at line 194 of file qgisplugin.h.

typedef QString version_t()

Typedef for getting the plugin version without instantiating the plugin.

Definition at line 209 of file qgisplugin.h.