plugin.h
Go to the documentation of this file.00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028 #ifndef _HERAIA_PLUGIN_H_
00029 #define _HERAIA_PLUGIN_H_
00030
00031
00032
00033
00034
00035
00036
00037
00038 #define HERAIA_PLUGIN_API_VERSION 1
00039
00040
00041
00042
00043 typedef enum
00044 {
00045 HERAIA_PLUGIN_UNKNOWN = -1,
00046 HERAIA_PLUGIN_FILTER = 0,
00047 HERAIA_PLUGIN_ACTION = 1,
00048 } PluginType;
00049
00050
00051
00052
00053 typedef enum
00054 {
00055 PLUGIN_STATE_RUNNING,
00056 PLUGIN_STATE_INITIALIZING,
00057 PLUGIN_STATE_LOADED,
00058 PLUGIN_STATE_NEW,
00059 PLUGIN_STATE_EXITING,
00060 PLUGIN_STATE_NONE,
00061 } PluginState;
00062
00063
00064 typedef void (* InitProc) (heraia_window_t *);
00065 typedef void (* QuitProc) (void);
00066 typedef void (* RunProc) (GtkWidget *, gpointer);
00067 typedef void (* RefreshProc) (heraia_window_t *, void *);
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084 typedef int PluginPriority;
00085 #define HERAIA_PRIORITY_DEFAULT 0
00086 #define HERAIA_PRIORITY_HIGHEST 9999
00087 #define HERAIA_PRIORITY_LOWEST -9999
00088
00089
00090
00091
00092
00093
00094 typedef gboolean (* ImportFunction) (const gchar *filename, void *user_data);
00095
00096
00097 typedef gboolean (* ExportFunction) (const gchar *filename, void *user_data);
00098
00099
00100
00101
00102
00103
00104 typedef struct
00105 {
00106 char *extensions;
00107
00108 ImportFunction import;
00109 ExportFunction export;
00110 } plugin_filter_t;
00111
00112
00113
00114
00115
00116
00117 typedef struct
00118 {
00119 unsigned int api_version;
00120 PluginType type;
00121 PluginPriority priority;
00122 unsigned int id;
00123
00124 char *name;
00125 char *version;
00126 char *summary;
00127 char *description;
00128 char *author;
00129 char *homepage;
00130
00131 } plugin_info_t;
00132
00133
00134
00135
00136
00137 typedef struct
00138 {
00139 PluginState state;
00140 GModule *handle;
00141 char *path;
00142 char *filename;
00143 plugin_info_t *info;
00144 plugin_filter_t *filter;
00145 char *error;
00146 void *extra;
00147
00148 InitProc init_proc;
00149 QuitProc quit_proc;
00150 RunProc run_proc;
00151 RefreshProc refresh_proc;
00152
00153 GtkCheckMenuItem *cmi_entry;
00154 GladeXML *xml;
00155 window_prop_t *win_prop;
00156 } heraia_plugin_t;
00157
00158
00159
00160
00161
00162
00163 extern gboolean plugin_capable(void);
00164 extern heraia_plugin_t *new_plugin(void);
00165 extern void free_plugin(heraia_plugin_t *plugin);
00166 extern void load_plugins(heraia_window_t *main_window);
00167 extern void add_entry_to_plugins_menu(heraia_window_t *main_window, heraia_plugin_t *plugin);
00168 extern heraia_plugin_t *find_plugin_by_name(GList *plugins_list, gchar *name);
00169 extern gboolean load_plugin_glade_xml(heraia_window_t *main_window, heraia_plugin_t *plugin);
00170 extern void refresh_all_plugins(heraia_window_t *main_window);
00171
00172 #endif