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.

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

Macro Definition Documentation

SIP_NO_FILE

#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 39 of file qgisplugin.h.

Typedef Documentation

category_t

typedef const QString * category_t()

Typedef for getting the category without instantiating the plugin.

Definition at line 204 of file qgisplugin.h.

create_date_t

typedef const QString * create_date_t()

Typedef for getting the create date without instantiating the plugin.

Definition at line 219 of file qgisplugin.h.

create_t

typedef QgisPlugin * create_t(QgisInterface *)

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

Definition at line 192 of file qgisplugin.h.

description_t

typedef const QString * description_t()

Typedef for getting the description without instantiating the plugin.

Definition at line 201 of file qgisplugin.h.

experimental_t

typedef const QString * experimental_t()

Typedef for getting the experimental status without instantiating the plugin.

Definition at line 216 of file qgisplugin.h.

icon_t

typedef const QString * icon_t()

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

Definition at line 213 of file qgisplugin.h.

name_t

typedef const QString * name_t()

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

Definition at line 198 of file qgisplugin.h.

type_t

typedef int type_t()

Typedef for getting the plugin type without instantiating the plugin.

Definition at line 207 of file qgisplugin.h.

unload_t

typedef void unload_t(QgisPlugin *)

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

Definition at line 195 of file qgisplugin.h.

update_date_t

typedef const QString * update_date_t()

Typedef for getting the update date status without instantiating the plugin.

Definition at line 222 of file qgisplugin.h.

version_t

typedef const QString * version_t()

Typedef for getting the plugin version without instantiating the plugin.

Definition at line 210 of file qgisplugin.h.