![]() |
![]() |
![]() |
CodeSlayer Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <codeslayer/codeslayer-plugin.h> struct CodeSlayerPlugin; CodeSlayerPlugin * codeslayer_plugin_new (void
); const gchar * codeslayer_plugin_get_lib (CodeSlayerPlugin *plugin
); void codeslayer_plugin_set_lib (CodeSlayerPlugin *plugin
,const gchar *lib
); const gchar * codeslayer_plugin_get_version (CodeSlayerPlugin *plugin
); void codeslayer_plugin_set_version (CodeSlayerPlugin *plugin
,const gchar *version
); const gchar * codeslayer_plugin_get_name (CodeSlayerPlugin *plugin
); void codeslayer_plugin_set_name (CodeSlayerPlugin *plugin
,const gchar *name
); const gchar * codeslayer_plugin_get_description (CodeSlayerPlugin *plugin
); void codeslayer_plugin_set_description (CodeSlayerPlugin *plugin
,const gchar *description
); const gchar * codeslayer_plugin_get_authors (CodeSlayerPlugin *plugin
); void codeslayer_plugin_set_authors (CodeSlayerPlugin *plugin
,const gchar *authors
); const gchar * codeslayer_plugin_get_copyright (CodeSlayerPlugin *plugin
); void codeslayer_plugin_set_copyright (CodeSlayerPlugin *plugin
,const gchar *copyright
); const gchar * codeslayer_plugin_get_website (CodeSlayerPlugin *plugin
); void codeslayer_plugin_set_website (CodeSlayerPlugin *plugin
,const gchar *website
); gboolean codeslayer_plugin_is_configurable (CodeSlayerPlugin *plugin
); gboolean codeslayer_plugin_get_enabled (CodeSlayerPlugin *plugin
); void codeslayer_plugin_set_enabled (CodeSlayerPlugin *plugin
,gboolean enabled
); void codeslayer_plugin_set_data (CodeSlayerPlugin *plugin
,GObject *data
); void codeslayer_plugin_activate (CodeSlayerPlugin *plugin
); void codeslayer_plugin_deactivate (CodeSlayerPlugin *plugin
); void codeslayer_plugin_configure (CodeSlayerPlugin *plugin
);
"authors" gchar* : Read / Write "copyright" gchar* : Read / Write "description" gchar* : Read / Write "enabled" gboolean : Read / Write "lib" gchar* : Read / Write "name" gchar* : Read / Write "version" gchar* : Read / Write "website" gchar* : Read / Write
CodeSlayerPlugin * codeslayer_plugin_new (void
);
Creates a new CodeSlayerPlugin.
Returns : |
a new CodeSlayerPlugin. |
const gchar * codeslayer_plugin_get_lib (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
Returns : |
the shared library that will be loaded. |
void codeslayer_plugin_set_lib (CodeSlayerPlugin *plugin
,const gchar *lib
);
|
a CodeSlayerPlugin. |
|
the lib to set. |
const gchar * codeslayer_plugin_get_version (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
Returns : |
the version of the shared library. |
void codeslayer_plugin_set_version (CodeSlayerPlugin *plugin
,const gchar *version
);
|
a CodeSlayerPlugin. |
|
the version to set. |
const gchar * codeslayer_plugin_get_name (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
Returns : |
the human readable name of the plugin. |
void codeslayer_plugin_set_name (CodeSlayerPlugin *plugin
,const gchar *name
);
const gchar * codeslayer_plugin_get_description (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
Returns : |
the plugin description. |
void codeslayer_plugin_set_description (CodeSlayerPlugin *plugin
,const gchar *description
);
const gchar * codeslayer_plugin_get_authors (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
Returns : |
the plugin authors. |
void codeslayer_plugin_set_authors (CodeSlayerPlugin *plugin
,const gchar *authors
);
const gchar * codeslayer_plugin_get_copyright (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
Returns : |
the plugin copyright. |
void codeslayer_plugin_set_copyright (CodeSlayerPlugin *plugin
,const gchar *copyright
);
const gchar * codeslayer_plugin_get_website (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
Returns : |
the plugin website. |
void codeslayer_plugin_set_website (CodeSlayerPlugin *plugin
,const gchar *website
);
gboolean codeslayer_plugin_is_configurable (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
Returns : |
is TRUE if the plugin can be configured. |
gboolean codeslayer_plugin_get_enabled (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
Returns : |
is TRUE if the plugin is active. |
void codeslayer_plugin_set_enabled (CodeSlayerPlugin *plugin
,gboolean enabled
);
|
a CodeSlayerPlugin. |
|
is TRUE if the plugin is active. |
void codeslayer_plugin_set_data (CodeSlayerPlugin *plugin
,GObject *data
);
|
a CodeSlayerPlugin. |
|
a CodeSlayer object. |
void codeslayer_plugin_activate (CodeSlayerPlugin *plugin
);
Open the library and resolve the symbols.
|
a CodeSlayerPlugin. |
void codeslayer_plugin_deactivate (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
void codeslayer_plugin_configure (CodeSlayerPlugin *plugin
);
|
a CodeSlayerPlugin. |
"enabled"
property"enabled" gboolean : Read / Write
Whether or not the plugin is enabled.
Default value: TRUE