#include <QString>
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 QgisPlugin * | create_t(QgisInterface *) |
| Typedef for the function that returns a generic pointer to a plugin object. 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... | |
Functions | |
| const typedef QString * | category_t () |
| Typedef for getting the category without instantiating the plugin. More... | |
| const typedef QString * | create_date_t () |
| Typedef for getting the create date without instantiating the plugin. More... | |
| const typedef QString * | description_t () |
| Typedef for getting the description without instantiating the plugin. More... | |
| const typedef QString * | experimental_t () |
| Typedef for getting the experimental status without instantiating the plugin. More... | |
| const typedef QString * | icon_t () |
| Typedef for getting the plugin icon file name without instantiating the plugin. More... | |
| const typedef QString * | name_t () |
| Typedef for getting the name of the plugin without instantiating it. More... | |
| const typedef QString * | update_date_t () |
| Typedef for getting the update date status without instantiating the plugin. More... | |
| const typedef QString * | version_t () |
| Typedef for getting the plugin version without instantiating the plugin. More... | |
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
◆ 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.
◆ 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.
Function Documentation
◆ category_t()
| const typedef QString* category_t | ( | ) |
Typedef for getting the category without instantiating the plugin.
◆ create_date_t()
| const typedef QString* create_date_t | ( | ) |
Typedef for getting the create date without instantiating the plugin.
◆ description_t()
| const typedef QString* description_t | ( | ) |
Typedef for getting the description without instantiating the plugin.
◆ experimental_t()
| const typedef QString* experimental_t | ( | ) |
Typedef for getting the experimental status without instantiating the plugin.
◆ icon_t()
| const typedef QString* icon_t | ( | ) |
Typedef for getting the plugin icon file name without instantiating the plugin.
◆ name_t()
| const typedef QString* name_t | ( | ) |
Typedef for getting the name of the plugin without instantiating it.
◆ update_date_t()
| const typedef QString* update_date_t | ( | ) |
Typedef for getting the update date status without instantiating the plugin.
◆ version_t()
| const typedef QString* version_t | ( | ) |
Typedef for getting the plugin version without instantiating the plugin.
