GwyAppDataForeachFunc ()

void
(*GwyAppDataForeachFunc) (GwyContainer *data,
                          gpointer user_data);

Type of function passed to gwy_app_data_browser_foreach().

GwyAppDataWatchFunc ()

void
(*GwyAppDataWatchFunc) (GwyContainer *data,
                        gint id,
                        GwyDataWatchEventType event,
                        gpointer user_data);

Type of function passed to gwy_app_data_browser_add_channel_watch().

Since: 2.21

gwy_app_data_browser_add ()

void
gwy_app_data_browser_add (GwyContainer *data);

Adds a data container to the application data browser.

The data browser takes a reference on the container so you can release yours.

gwy_app_data_browser_remove ()

void
gwy_app_data_browser_remove (GwyContainer *data);

Removed a data container from the application data browser.

gwy_app_data_browser_merge ()

void
gwy_app_data_browser_merge (GwyContainer *data);

Merges the data from a data container to the current one.

Since: 2.7

gwy_app_data_browser_get ()

GwyContainer *
gwy_app_data_browser_get (gint number);

Gets the data corresponding to a numerical identifier.

The identifier can be obtained with gwy_app_data_browser_get_number(). See its documentation for discussion.

Since: 2.41

gwy_app_data_browser_get_number ()

gint
gwy_app_data_browser_get_number (GwyContainer *data);

Gets the numerical identifier of data.

Each time a data container is added with gwy_app_data_browser_add() it is assigned a new unique numerical identifier. This number can be used in multi-data modules to remember and restore secondary data.

Note, however, that the number is only guaranteed to be unique within one process. It does not persist across different program invocations and it does not make sense to store it to the settings or other kinds of permanent storage.

Since: 2.41

gwy_app_data_browser_reset_visibility ()

gboolean
gwy_app_data_browser_reset_visibility (GwyContainer *data,
                                       GwyVisibilityResetType reset_type);

Resets visibility of all data objects in a container.

gwy_app_data_browser_set_keep_invisible ()

void
gwy_app_data_browser_set_keep_invisible
                               (GwyContainer *data,
                                gboolean keep_invisible);

Sets data browser behaviour for inaccessible data.

Normally, when all visual objects belonging to a file are closed the container is removed from the data browser and dereferenced, leading to its finalization. By setting keep_invisible to TRUE the container can be made to sit in the browser indefinitely.

gwy_app_data_browser_get_keep_invisible ()

gboolean
gwy_app_data_browser_get_keep_invisible
                               (GwyContainer *data);

Gets data browser behaviour for inaccessible data.

gwy_app_data_browser_select_data_view ()

void
gwy_app_data_browser_select_data_view (GwyDataView *data_view);

Switches application data browser to display container of data_view 's data and selects data_view 's data in the channel list.

gwy_app_data_browser_select_graph ()

void
gwy_app_data_browser_select_graph (GwyGraph *graph);

Switches application data browser to display container of graph 's data and selects graph 's data in the graph list.

gwy_app_data_browser_select_spectra ()

void
gwy_app_data_browser_select_spectra (GwySpectra *spectra);

Switches application data browser to display container of spectra 's data and selects spectra 's data in the graph list.

However, it is not actually supposed to work with spectra from a different container than those of the currently active channel, so do not try that for now.

Since: 2.7

gwy_app_data_browser_select_volume ()

void
gwy_app_data_browser_select_volume (GwyDataView *data_view);

Switches application data browser to display container of data and selects data_view 's volume data in the graph list.

Since: 2.32

gwy_app_data_browser_select_xyz ()

void
gwy_app_data_browser_select_xyz (GwyDataView *data_view);

Switches application data browser to display container of data and selects data_view 's XYZ data in the graph list.

Since: 2.45

gwy_app_data_browser_add_data_field ()

gint
gwy_app_data_browser_add_data_field (GwyDataField *dfield,
                                     GwyContainer *data,
                                     gboolean showit);

Adds a data field to a data container.

The data browser takes a reference to dfield so usually you will want to release your reference, especially when done as the ‘create output’ step of a module function.

gwy_app_data_browser_add_graph_model ()

gint
gwy_app_data_browser_add_graph_model (GwyGraphModel *gmodel,
                                      GwyContainer *data,
                                      gboolean showit);

Adds a graph model to a data container.

The data browser takes a reference to gmodel so usually you will want to release your reference, especially when done as the ‘create output’ step of a module function.

gwy_app_data_browser_add_spectra ()

gint
gwy_app_data_browser_add_spectra (GwySpectra *spectra,
                                  GwyContainer *data,
                                  gboolean showit);

Adds a spectra object to a data container.

The data browser takes a reference to spectra so usually you will want to release your reference, especially when done as the ‘create output’ step of a module function.

Since: 2.7

gwy_app_data_browser_add_brick ()

gint
gwy_app_data_browser_add_brick (GwyBrick *brick,
                                GwyDataField *preview,
                                GwyContainer *data,
                                gboolean showit);

Adds a volume data brick to a data container.

The data browser takes a reference to brick (and preview if given) so usually you will want to release your reference, especially when done as the ‘create output’ step of a module function.

Since: 2.32

gwy_app_data_browser_add_surface ()

gint
gwy_app_data_browser_add_surface (GwySurface *surface,
                                  GwyContainer *data,
                                  gboolean showit);

Adds XYZ surface data to a data container.

The data browser takes a reference to surface so usually you will want to release your reference, especially when done as the ‘create output’ step of a module function.

Since: 2.45

gwy_app_data_browser_get_current ()

void
gwy_app_data_browser_get_current (GwyAppWhat what,
                                  ...);

Gets information about current objects.

All output arguments are always set to some value, even if the requested object does not exist. Object arguments are set to pointer to the object if it exists (no reference is added), or cleared to NULL if no such object exists.

Quark arguments are set to the corresponding key even if no such object is actually present (use object arguments to check for object presence) but the location where it would be stored is known. This is common with presentations and masks. They are be set to 0 if no corresponding location exists -- for example, when the current mask key is requested but the current data contains no channel (or there is no current data at all).

The rules for id arguments are similar to quarks, except they are set to -1 to indicate undefined result.

The current objects can change due to user interaction even during the execution of modal dialogs (typically used by modules). Therefore to achieve consistency one has to ask for the complete set of current objects at once.

gwy_app_data_browser_get_data_ids ()

gint *
gwy_app_data_browser_get_data_ids (GwyContainer *data);

Gets the list of all channels in a data container.

The function originally could be used only for data containers managed by the data browser. Since version 2.45 it can be used for all file-like data containers.

gwy_app_data_browser_get_graph_ids ()

gint *
gwy_app_data_browser_get_graph_ids (GwyContainer *data);

Gets the list of all graphs in a data container.

The function originally could be used only for data containers managed by the data browser. Since version 2.45 it can be used for all file-like data containers.

gwy_app_data_browser_get_spectra_ids ()

gint *
gwy_app_data_browser_get_spectra_ids (GwyContainer *data);

Gets the list of all spectra in a data container.

The function originally could be used only for data containers managed by the data browser. Since version 2.45 it can be used for all file-like data containers.

Since: 2.7

gwy_app_data_browser_get_volume_ids ()

gint *
gwy_app_data_browser_get_volume_ids (GwyContainer *data);

Gets the list of all volume data in a data container.

The function originally could be used only for data containers managed by the data browser. Since version 2.45 it can be used for all file-like data containers.

Since: 2.33

gwy_app_data_browser_get_xyz_ids ()

gint *
gwy_app_data_browser_get_xyz_ids (GwyContainer *data);

Gets the list of all XYZ data in a data container.

Since: 2.45

gwy_app_data_browser_find_data_by_title ()

gint *
gwy_app_data_browser_find_data_by_title
                               (GwyContainer *data,
                                const gchar *titleglob);

Gets the list of all channels in a data container whose titles match the specified pattern.

The function originally could be used only for data containers managed by the data browser. Since version 2.49 it can be used for all file-like data containers.

Since: 2.21

gwy_app_data_browser_find_graphs_by_title ()

gint *
gwy_app_data_browser_find_graphs_by_title
                               (GwyContainer *data,
                                const gchar *titleglob);

Gets the list of all graphs in a data container whose titles match the specified pattern.

The function originally could be used only for data containers managed by the data browser. Since version 2.49 it can be used for all file-like data containers.

Since: 2.21

gwy_app_data_browser_find_spectra_by_title ()

gint *
gwy_app_data_browser_find_spectra_by_title
                               (GwyContainer *data,
                                const gchar *titleglob);

Gets the list of all spectra in a data container whose titles match the specified pattern.

The function originally could be used only for data containers managed by the data browser. Since version 2.49 it can be used for all file-like data containers.

Since: 2.21

gwy_app_data_browser_find_volume_by_title ()

gint *
gwy_app_data_browser_find_volume_by_title
                               (GwyContainer *data,
                                const gchar *titleglob);

Gets the list of all volume data in a data container whose titles match the specified pattern.

The function originally could be used only for data containers managed by the data browser. Since version 2.49 it can be used for all file-like data containers.

Since: 2.45

gwy_app_data_browser_find_xyz_by_title ()

gint *
gwy_app_data_browser_find_xyz_by_title
                               (GwyContainer *data,
                                const gchar *titleglob);

Gets the list of all XYZ data in a data container whose titles match the specified pattern.

The function originally could be used only for data containers managed by the data browser. Since version 2.49 it can be used for all file-like data containers.

Since: 2.45

gwy_app_data_clear_selections ()

void
gwy_app_data_clear_selections (GwyContainer *data,
                               gint id);

Clears all selections associated with a data channel.

This is the preferred selection handling after changes in data geometry as they have generally unpredictable effects on selections. Selection should not be removed because this is likely to make the current tool stop working.

gwy_app_data_browser_foreach ()

void
gwy_app_data_browser_foreach (GwyAppDataForeachFunc function,
                              gpointer user_data);

Calls a function for each data container managed by data browser.

gwy_app_data_browser_add_channel_watch ()

gulong
gwy_app_data_browser_add_channel_watch
                               (GwyAppDataWatchFunc function,
                                gpointer user_data);

Adds a watch function called when a channel changes.

The function is called whenever a channel is added, removed, its data changes or its metadata such as the title changes. If a channel is removed it may longer exist when the function is called.

Since: 2.21

gwy_app_data_browser_remove_channel_watch ()

void
gwy_app_data_browser_remove_channel_watch
                               (gulong id);

Removes a channel watch function.

Since: 2.21

gwy_app_data_browser_add_graph_watch ()

gulong
gwy_app_data_browser_add_graph_watch (GwyAppDataWatchFunc function,
                                      gpointer user_data);

Adds a watch function called when a graph changes.

The function is called whenever a graph is added, removed or its properties change. If a graph is removed it may longer exist when the function is called.

Since: 2.41

gwy_app_data_browser_remove_graph_watch ()

void
gwy_app_data_browser_remove_graph_watch
                               (gulong id);

Removes a graph watch function.

Since: 2.41

gwy_app_sync_data_items ()

void
gwy_app_sync_data_items (GwyContainer *source,
                         GwyContainer *dest,
                         gint from_id,
                         gint to_id,
                         gboolean delete_too,
                         ...);

Synchronizes auxiliary image data items between data containers.

gwy_app_sync_data_itemsv ()

void
gwy_app_sync_data_itemsv (GwyContainer *source,
                          GwyContainer *dest,
                          gint from_id,
                          gint to_id,
                          gboolean delete_too,
                          const GwyDataItem *items,
                          guint nitems);

Synchronizes auxiliary image data items between data containers.

Since: 2.48

gwy_app_sync_volume_items ()

void
gwy_app_sync_volume_items (GwyContainer *source,
                           GwyContainer *dest,
                           gint from_id,
                           gint to_id,
                           gboolean delete_too,
                           ...);

Synchronizes auxiliary volume data items between data containers.

Only GWY_DATA_ITEM_GRADIENT, GWY_DATA_ITEM_TITLE, GWY_DATA_ITEM_META and GWY_DATA_ITEM_PREVIEW are valid items for volume data.

Since: 2.51

gwy_app_sync_volume_itemsv ()

void
gwy_app_sync_volume_itemsv (GwyContainer *source,
                            GwyContainer *dest,
                            gint from_id,
                            gint to_id,
                            gboolean delete_too,
                            const GwyDataItem *items,
                            guint nitems);

Synchronizes auxiliary volume data items between data containers.

Only GWY_DATA_ITEM_GRADIENT, GWY_DATA_ITEM_TITLE, GWY_DATA_ITEM_META and GWY_DATA_ITEM_PREVIEW are valid items for volume data.

Since: 2.51

gwy_app_data_browser_copy_channel ()

gint
gwy_app_data_browser_copy_channel (GwyContainer *source,
                                   gint id,
                                   GwyContainer *dest);

Copies a channel including all auxiliary data.

gwy_app_data_browser_copy_volume ()

gint
gwy_app_data_browser_copy_volume (GwyContainer *source,
                                  gint id,
                                  GwyContainer *dest);

Copies volume brick data including all auxiliary data.

Since: 2.32

gwy_app_data_browser_copy_xyz ()

gint
gwy_app_data_browser_copy_xyz (GwyContainer *source,
                               gint id,
                               GwyContainer *dest);

Copies XYZ surface data including all auxiliary data.

Since: 2.45

gwy_app_get_data_key_for_id ()

GQuark
gwy_app_get_data_key_for_id (gint id);

Calculates data field quark identifier from its id.

gwy_app_get_mask_key_for_id ()

GQuark
gwy_app_get_mask_key_for_id (gint id);

Calculates mask field quark identifier from its id.

gwy_app_get_show_key_for_id ()

GQuark
gwy_app_get_show_key_for_id (gint id);

Calculates presentation field quark identifier from its id.

gwy_app_get_graph_key_for_id ()

GQuark
gwy_app_get_graph_key_for_id (gint id);

Calculates graph model quark identifier from its id.

Since: 2.7

gwy_app_get_spectra_key_for_id ()

GQuark
gwy_app_get_spectra_key_for_id (gint id);

Calculates spectra quark identifier from its id.

Since: 2.7

gwy_app_get_brick_key_for_id ()

GQuark
gwy_app_get_brick_key_for_id (gint id);

Calculates data brick quark identifier from its id.

Since: 2.32

gwy_app_get_surface_key_for_id ()

GQuark
gwy_app_get_surface_key_for_id (gint id);

Calculates XYZ surface quark identifier from its id.

Since: 2.45

gwy_app_get_data_title_key_for_id ()

GQuark
gwy_app_get_data_title_key_for_id (gint id);

Calculates data field title quark identifier from its id.

Since: 2.43

gwy_app_get_data_range_type_key_for_id ()

GQuark
gwy_app_get_data_range_type_key_for_id
                               (gint id);

Calculates data field range type quark identifier from its id.

Since: 2.43

gwy_app_get_data_range_min_key_for_id ()

GQuark
gwy_app_get_data_range_min_key_for_id (gint id);

Calculates data field fixed range minimum quark identifier from its id.

Since: 2.43

gwy_app_get_data_range_max_key_for_id ()

GQuark
gwy_app_get_data_range_max_key_for_id (gint id);

Calculates data field fixed range maximum quark identifier from its id.

Since: 2.43

gwy_app_get_data_palette_key_for_id ()

GQuark
gwy_app_get_data_palette_key_for_id (gint id);

Calculates data field palette quark identifier from its id.

Since: 2.43

gwy_app_get_data_meta_key_for_id ()

GQuark
gwy_app_get_data_meta_key_for_id (gint id);

Calculates data field metadata quark identifier from its id.

Since: 2.43

gwy_app_get_brick_title_key_for_id ()

GQuark
gwy_app_get_brick_title_key_for_id (gint id);

Calculates data brick title quark identifier from its id.

Since: 2.43

gwy_app_get_brick_preview_key_for_id ()

GQuark
gwy_app_get_brick_preview_key_for_id (gint id);

Calculates data brick preview quark identifier from its id.

Since: 2.43

gwy_app_get_brick_palette_key_for_id ()

GQuark
gwy_app_get_brick_palette_key_for_id (gint id);

Calculates data brick palette quark identifier from its id.

Since: 2.43

gwy_app_get_brick_meta_key_for_id ()

GQuark
gwy_app_get_brick_meta_key_for_id (gint id);

Calculates data brick title quark identifier from its id.

Since: 2.43

gwy_app_get_surface_title_key_for_id ()

GQuark
gwy_app_get_surface_title_key_for_id (gint id);

Calculates data surface title quark identifier from its id.

Since: 2.45

gwy_app_get_surface_palette_key_for_id ()

GQuark
gwy_app_get_surface_palette_key_for_id
                               (gint id);

Calculates XYZ surface palette quark identifier from its id.

Since: 2.45

gwy_app_get_surface_meta_key_for_id ()

GQuark
gwy_app_get_surface_meta_key_for_id (gint id);

Calculates XYZ surface title quark identifier from its id.

Since: 2.45

gwy_app_get_surface_preview_key_for_id ()

GQuark
gwy_app_get_surface_preview_key_for_id
                               (gint id);

Calculates XYZ surface preview quark identifier from its id.

Since: 2.46

gwy_app_set_data_field_title ()

void
gwy_app_set_data_field_title (GwyContainer *data,
                              gint id,
                              const gchar *name);

Sets channel title.

gwy_app_get_data_field_title ()

gchar *
gwy_app_get_data_field_title (GwyContainer *data,
                              gint id);

Gets a data channel title.

This function should return a reasoanble title for untitled channels, channels with old titles, channels with and without a file, etc.

gwy_app_set_brick_title ()

void
gwy_app_set_brick_title (GwyContainer *data,
                         gint id,
                         const gchar *name);

Sets volume data title.

Since: 2.32

gwy_app_get_brick_title ()

gchar *
gwy_app_get_brick_title (GwyContainer *data,
                         gint id);

Gets a volume data brick title.

Since: 2.32

gwy_app_set_surface_title ()

void
gwy_app_set_surface_title (GwyContainer *data,
                           gint id,
                           const gchar *name);

Sets XYZ surface data title.

Since: 2.45

gwy_app_get_surface_title ()

gchar *
gwy_app_get_surface_title (GwyContainer *data,
                           gint id);

Gets an XYZ surface data title.

Since: 2.45

gwy_app_data_browser_show ()

void
gwy_app_data_browser_show (void);

Shows the data browser window.

If the window does not exist, it is created.

gwy_app_data_browser_restore ()

void
gwy_app_data_browser_restore (void);

Restores the data browser window.

The data browser window is always created (if it does not exist). If it should be visible according to settings, is shown at the saved position. Otherwise it is kept hidden until gwy_app_data_browser_show().

gwy_app_data_browser_shut_down ()

void
gwy_app_data_browser_shut_down (void);

Releases data browser resources and saves its state.

gwy_app_get_channel_thumbnail ()

GdkPixbuf *
gwy_app_get_channel_thumbnail (GwyContainer *data,
                               gint id,
                               gint max_width,
                               gint max_height);

Creates a channel thumbnail.

gwy_app_get_graph_thumbnail ()

GdkPixbuf *
gwy_app_get_graph_thumbnail (GwyContainer *data,
                             gint id,
                             gint max_width,
                             gint max_height);

Creates a graph thumbnail.

Note this function needs the GUI running (unlike the other thumbnail functions). It cannot be used in a console program.

Since: 2.45

gwy_app_get_volume_thumbnail ()

GdkPixbuf *
gwy_app_get_volume_thumbnail (GwyContainer *data,
                              gint id,
                              gint max_width,
                              gint max_height);

Creates a volume thumbnail.

Since: 2.33

gwy_app_get_xyz_thumbnail ()

GdkPixbuf *
gwy_app_get_xyz_thumbnail (GwyContainer *data,
                           gint id,
                           gint max_width,
                           gint max_height);

Creates an XYZ data thumbnail.

Since: 2.45

gwy_app_data_browser_select_data_field ()

void
gwy_app_data_browser_select_data_field
                               (GwyContainer *data,
                                gint id);

Makes a data field (channel) current in the data browser.

gwy_app_data_browser_select_graph_model ()

void
gwy_app_data_browser_select_graph_model
                               (GwyContainer *data,
                                gint id);

Makes a graph model (channel) current in the data browser.

gwy_app_data_browser_show_3d ()

void
gwy_app_data_browser_show_3d (GwyContainer *data,
                              gint id);

Shows a 3D window displaying a channel.

If a 3D window of the specified channel already exists, it is just presented to the user. If it does not exist, it is created.

The caller must ensure 3D display is available, for example by checking gwy_app_gl_is_ok().

gwy_app_find_window_for_channel ()

GtkWindow *
gwy_app_find_window_for_channel (GwyContainer *data,
                                 gint id);

Finds the window displaying a data channel.

gwy_app_find_window_for_graph ()

GtkWindow *
gwy_app_find_window_for_graph (GwyContainer *data,
                               gint id);

Finds the window displaying a graph model.

Since: 2.45

gwy_app_find_window_for_volume ()

GtkWindow *
gwy_app_find_window_for_volume (GwyContainer *data,
                                gint id);

Finds the window displaying given volume data.

Since: 2.42

gwy_app_find_window_for_xyz ()

GtkWindow *
gwy_app_find_window_for_xyz (GwyContainer *data,
                             gint id);

Finds the window displaying given XYZ data.

Since: 2.45

gwy_app_data_browser_get_gui_enabled ()

gboolean
gwy_app_data_browser_get_gui_enabled (void);

Reports whether creation of windows by the data-browser is enabled.

Since: 2.21

gwy_app_data_browser_set_gui_enabled ()

void
gwy_app_data_browser_set_gui_enabled (gboolean setting);

Globally enables or disables creation of widgets by the data-browser.

By default, the data-browser creates windows for data objects automatically, for instance when reconstructing view of a loaded file, after a module function creates a new channel or graph or when it is explicitly asked so by gwy_app_data_browser_show_3d(). Non-GUI applications that run module functions usually wish to disable GUI.

If GUI is disabled the data browser never creates windows showing data objects and also gwy_app_data_browser_show() becomes no-op.

Disabling GUI after widgets have been already created is a bad idea. Hence you should do so before loading files or calling module functions.

Since: 2.21

enum GwyAppWhat

Types of current objects that can be requested with gwy_app_data_browser_get_current().

enum GwyAppPage

Data browser page, corresponding to one of possible data types.

Since: 2.45

enum GwyDataItem

Type of auxiliary channel data.

enum GwyVisibilityResetType

Data object visibility reset type.

The precise behaviour of GWY_VISIBILITY_RESET_DEFAULT may be subject of further changes. It indicates the wish to restore saved visibilities and do something reasonable when there are no visibilities to restore.

enum GwyDataWatchEventType

Type of event reported to GwyAppDataWatchFunc watcher functions.

Since: 2.21