Top | ![]() |
![]() |
![]() |
![]() |
void | (*GwyGraphFunc) () |
gboolean | gwy_graph_func_register () |
void | gwy_graph_func_run () |
gboolean | gwy_graph_func_exists () |
const gchar * | gwy_graph_func_get_menu_path () |
const gchar * | gwy_graph_func_get_stock_id () |
const gchar * | gwy_graph_func_get_tooltip () |
guint | gwy_graph_func_get_sensitivity_mask () |
void | gwy_graph_func_foreach () |
const gchar * | gwy_graph_func_current () |
void (*GwyGraphFunc) (GwyGraph *graph
,const gchar *name
);
The type of graph function.
graph |
Graph (a GwyGraph) to operate on. |
|
name |
Function name from as registered with |
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 |
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. |
|
func |
The function itself. |
|
menu_path |
Menu path under Graph menu. The menu path should be marked translatabe, but passed untranslated (to allow merging of translated and untranslated submenus). |
|
stock_id |
Stock icon id for toolbar. |
|
sens_mask |
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 |
Tooltip for this function. |
void gwy_graph_func_run (const gchar *name
,GwyGraph *graph
);
Runs a graph function identified by name
.
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".
const gchar *
gwy_graph_func_get_stock_id (const gchar *name
);
Gets stock icon id of a graph function.
const gchar *
gwy_graph_func_get_tooltip (const gchar *name
);
Gets tooltip for a graph function.
guint
gwy_graph_func_get_sensitivity_mask (const gchar *name
);
Gets menu sensititivy mask for a graph function.
void gwy_graph_func_foreach (GFunc function
,gpointer user_data
);
Calls a function for each graph function.
const gchar *
gwy_graph_func_current (void
);
Obtains the name of currently running graph function.
If no graph function is currently running, NULL
is returned.
If multiple nested functions are running (which is not usual but technically possible), the innermost function name is returned.
Since: 2.38