| Gnome Scan Reference Manual | ||||
|---|---|---|---|---|
GnomeScanPlugin;
gchar* gnome_scan_plugin_get_name (GnomeScanPlugin *plugin);
GList* gnome_scan_plugin_get_params (GnomeScanPlugin *plugin);
GSList* gnome_scan_plugin_get_param_group (GnomeScanPlugin *plugin,
GQuark group);
void gnome_scan_plugin_configure (GnomeScanPlugin *plugin,
GnomeScanSettings *settings);
gboolean gnome_scan_plugin_work (GnomeScanPlugin *plugin,
gdouble *progress);
void gnome_scan_plugin_params_add (GnomeScanPlugin *plugin,
GParamSpec *param);
void gnome_scan_plugin_params_remove (GnomeScanPlugin *plugin,
GParamSpec *param);
void gnome_scan_plugin_params_clear (GnomeScanPlugin *plugin);
"blurb" gchararray : Read / Write / Construct Only "name" gchararray : Read / Write / Construct Only "params" gpointer : Read
A GnomeScanPlugin add a features to Gnome Scan. A plugin never
extends directly GnomeScanPlugin. Instead, you should see
GnomeScanner and GnomeScanSink. Basically, a plugin handle common
properties such as name, blurb and params. Each plugins as a per
instance list of params.
In the future, GnomeScanPlugin should be drop in favor of GeglOperation.
typedef struct {
GList *nodes;
GParamSpecPool *params;
} GnomeScanPlugin;
GnomeScanPlugin is the base class for GnomeScanner and
GnomeScanSink. The buffer property is considered as the output of
a GnomeScanner, and the input of a GnomeScanSink.
GList *nodes; |
|
GParamSpecPool *params; |
the pool of params |
gchar* gnome_scan_plugin_get_name (GnomeScanPlugin *plugin);
plugin : |
a GnomeScanPlugin |
| Returns : | the plugin name
|
GList* gnome_scan_plugin_get_params (GnomeScanPlugin *plugin);
Retrieve all instance paramters from plugin.
plugin : |
a GnomeScanPlugin |
| Returns : | a GList of GSParamSpec. |
GSList* gnome_scan_plugin_get_param_group (GnomeScanPlugin *plugin, GQuark group);
Return all instance parameters which have group as group.
plugin : |
a GnomeScanPlugin |
group : |
a group GQuark |
| Returns : | a GList of GSParamSpec. |
void gnome_scan_plugin_configure (GnomeScanPlugin *plugin, GnomeScanSettings *settings);
Search in settings value for its instance parameters.
plugin : |
a GnomeScanPlugin |
settings : |
a GnomeScanPlugin |
gboolean gnome_scan_plugin_work (GnomeScanPlugin *plugin, gdouble *progress);
Do an iteration of plugin work. Store the amount of work done in progress as a fraction, from 0 to 1. progress set to 1 means work completed.
plugin : |
a GnomeScanPlugin |
progress : |
a pointer to a place where to store progress |
| Returns : | Wether more work iteration needs to be done. |
void gnome_scan_plugin_params_add (GnomeScanPlugin *plugin, GParamSpec *param);
See: gnome-scan-param-specs
plugin : |
a GnomeScanPlugin |
param : |
a GSParamSpec |
void gnome_scan_plugin_params_remove (GnomeScanPlugin *plugin, GParamSpec *param);
Remove a param spec from the param list.
plugin : |
a GnomeScanPlugin |
param : |
a GSParamSpec |
void gnome_scan_plugin_params_clear (GnomeScanPlugin *plugin);
Remove all instance parameters from a plugin.
plugin : |
a GnomeScanPlugin |
blurb" property"blurb" gchararray : Read / Write / Construct Only
The plugin public blurb.
Default value: NULL
name" property"name" gchararray : Read / Write / Construct Only
The plugin public name.
Default value: NULL
void user_function (GnomeScanPlugin *scanplugin, gpointer arg1, gpointer user_data) : Run First
scanplugin : |
the object which received the signal. |
Param2 : |
|
user_data : |
user data set when the signal handler was connected. |