Skip to content
This repository
Newer
Older
100644 39 lines (25 sloc) 1.798 kb
8e070f9c » rkhaotix
2012-08-31 Criação do arquivo PLUGINS.md e exclusão do branch plugin-support
1 PostgreSQL Database Modeler - pgModeler
2 ---------------------------------------
3
e9ba67b6 » rkhaotix
2012-08-31 Fechamento da versão v0.2.0.
4 This document describes a simple way to create third party plugins on pgModeler. ATTENTION: Any plugin must be compiled using the most current source and libs of pgModeler.
8e070f9c » rkhaotix
2012-08-31 Criação do arquivo PLUGINS.md e exclusão do branch plugin-support
5
6 Basic Rules
7 -----------
8
9 To be used as a plugin your class must:
10
e9ba67b6 » rkhaotix
2012-08-31 Fechamento da versão v0.2.0.
11 * Inherit the class "PgModelerPlugin"
12 * Use the macro Q_INTERFACES in its declaration.
13 * Overloadthe methods PgModelerPlugin::obterRotuloPlugin(void) and PgModelerPlugin::executarPlugin(ModeloWidget *model)
8e070f9c » rkhaotix
2012-08-31 Criação do arquivo PLUGINS.md e exclusão do branch plugin-support
14
15 Plugin directory structure
16 --------------------------
17
18 The plugins in pgModeler must be within the "plugins" folder in its own directory and must have the following basic structure:
19
20
21 [PGMODELER_PLUGINS_DIR]/
22 +- pluginA/
23 +---(lib)*(pluginA.)(so|dylib|dll) (library)
24 +---pluginA.png (icon)
25
e9ba67b6 » rkhaotix
2012-08-31 Fechamento da versão v0.2.0.
26 * Library: it is the shared object that represents the plugin. The prefix (lib) and suffix (so|dylib|dll) are plataform dependent.
27 * Icon: it is a PNG image that represents the plugin on the plugins toolbar.
8e070f9c » rkhaotix
2012-08-31 Criação do arquivo PLUGINS.md e exclusão do branch plugin-support
28
29 The dummy plugin
30 ----------------
31
32 To assist in developing a plugin the DummyPlugin project was created. This basic project has the necessary coding to create plugins. It is recommended to use this as a reference in creating your own plugins.
33
34 Advanced plugins
35 ---------------
36
37 To create advanced plugins you need to study the source code of pgModeler (particularly the headers). The code is well documented but in Portuguese. If you want to create a plugin and have questions please contact me via e-mail.
38
e9ba67b6 » rkhaotix
2012-08-31 Fechamento da versão v0.2.0.
39 In the near future all the code will be cataloged and online documentation in English will be available to developers (help wanted!).
Something went wrong with that request. Please try again.