![]() |
![]() |
![]() |
Gwyddion Module Library Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#include <libgwymodule/gwymodule.h> void (*GwyGraphFunc) (GwyGraph *graph
,const gchar *name
); gboolean gwy_graph_func_register (const gchar *name
,GwyGraphFunc func
,const gchar *menu_path
,const gchar *stock_id
,guint sens_mask
,const gchar *tooltip
); void gwy_graph_func_run (const gchar *name
,GwyGraph *graph
); gboolean gwy_graph_func_exists (const gchar *name
); const gchar * gwy_graph_func_get_menu_path (const gchar *name
); const gchar * gwy_graph_func_get_stock_id (const gchar *name
); const gchar * gwy_graph_func_get_tooltip (const gchar *name
); guint gwy_graph_func_get_sensitivity_mask (const gchar *name
); void gwy_graph_func_foreach (GFunc function
,gpointer user_data
);
void (*GwyGraphFunc) (GwyGraph *graph
,const gchar *name
);
The type of graph function.
|
Graph (a GwyGraph) to operate on. |
|
Function name from as registered with gwy_graph_func_register()
(single-function modules can safely ignore this argument). |
gboolean gwy_graph_func_register (const gchar *name
,GwyGraphFunc func
,const gchar *menu_path
,const gchar *stock_id
,guint sens_mask
,const gchar *tooltip
);
Registers a graph function.
Note: the string arguments are not copied as modules are not expected to vanish. If they are constructed (non-constant) strings, do not free them. Should modules ever become unloadable they will get chance to clean-up.
|
Name of function to register. It should be a valid identifier and if a module registers only one function, module and function names should be the same. |
|
The function itself. |
|
Menu path under Graph menu. The menu path should be marked translatabe, but passed untranslated (to allow merging of translated and untranslated submenus). |
|
Stock icon id for toolbar. |
|
Sensitivity mask (a combination of GwyMenuSensFlags flags). Usually it is equal to GWY_MENU_FLAG_GRAPH, but it's possible to set other requirements. |
|
Tooltip for this function. |
Returns : |
Normally TRUE ; FALSE on failure. |
void gwy_graph_func_run (const gchar *name
,GwyGraph *graph
);
Runs a graph function identified by name
.
|
Graph function name. |
|
Graph (a GwyGraph). |
gboolean gwy_graph_func_exists (const gchar *name
);
Checks whether a graph function exists.
const gchar * gwy_graph_func_get_menu_path (const gchar *name
);
Gets menu path of a graph function.
The returned menu path is only the tail part registered by the function, i.e., without any leading "/Graph".
|
Graph function name. |
Returns : |
The menu path. The returned string is owned by the module. |
const gchar * gwy_graph_func_get_stock_id (const gchar *name
);
Gets stock icon id of a graph function.
|
Graph function name. |
Returns : |
The stock icon id. The returned string is owned by the module. |
const gchar * gwy_graph_func_get_tooltip (const gchar *name
);
Gets tooltip for a graph function.
|
Graph function name. |
Returns : |
The tooltip. The returned string is owned by the module. |
guint gwy_graph_func_get_sensitivity_mask (const gchar *name
);
Gets menu sensititivy mask for a graph function.
|
Graph function name. |
Returns : |
The menu item sensitivity mask (a combination of GwyMenuSensFlags flags). |
void gwy_graph_func_foreach (GFunc function
,gpointer user_data
);
Calls a function for each graph function.
|
Function to run for each graph function. It will get function
name (constant string owned by module system) as its first
argument, user_data as the second argument. |
|
Data to pass to function . |