#include <glib.h>
#include <inttypes.h>
#include "common/debug.h"

Include dependency graph for selection.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	dt_selection_reload_from_database(selection) DT_DEBUG_TRACE_WRAPPER(DT_DEBUG_SQL, dt_selection_reload_from_database_real, (selection))

Functions
struct dt_selection_t *	dt_selection_new ()

void	dt_selection_free (struct dt_selection_t *selection)

struct dt_selection_t *	dt_selection_get_global (void)

void	dt_selection_init_global (void)

void	dt_selection_cleanup_global (void)

int32_t	dt_selection_get_first_id (struct dt_selection_t *selection)

void	dt_selection_clear (struct dt_selection_t *selection)

void	dt_selection_select (struct dt_selection_t *selection, int32_t imgid)

void	dt_selection_deselect (struct dt_selection_t *selection, int32_t imgid)

void	dt_selection_select_single (struct dt_selection_t *selection, int32_t imgid)

void	dt_selection_toggle (struct dt_selection_t *selection, int32_t imgid)

void	dt_selection_select_list (struct dt_selection_t selection, const GList list)

void	dt_selection_deselect_list (struct dt_selection_t selection, const GList list)

GList *	dt_selection_get_list (struct dt_selection_t *selection)

void	dt_selection_push (struct dt_selection_t *selection)

void	dt_selection_pop (struct dt_selection_t *selection)

int	dt_selection_get_length (struct dt_selection_t *selection)

gchar *	dt_selection_ids_to_string (struct dt_selection_t *selection)

gboolean	dt_selection_is_id_selected (struct dt_selection_t *selection, int32_t imgid)

void	dt_selection_reload_from_database_real (struct dt_selection_t *selection)

Detailed Description

The old design built selections from collections, through SQL, to ensure selections were always a subset of collections. That didn't work well with the GUI option to show/hide grouped images, because then, every SQL query needed to be modified according to a GUI parameter, which was complicated, hard to debug, tiring to maintain.

Collections now are immune to GUI parameters. It is in the thumbtable that we decide to show/hide the thumbnail widgets of grouped images, and collections contain all of them. In order to select grouped images depending on whether they are shown or not, it is also from the thumbtable that batch selection events need to be dispatched, using visible images. It is assumed that users expect selections to include everything visible but only what's visible and nothing more.

Because the thumbtable is populated from collections, we know it contains only valid imgid, and contains at most the whole current collection. So we can safely assume any imgid coming from the thumbtable is a valid image ID with regard to the current collection, without additional checks.

We synchronize here 2 representations of the selections:

a memory DB table: memory.selected_images, that is saved to be restored between reboots,
a GList of imgid, selection->ids, cached, that allows us direct access from C loops.

Selections subscribe to the COLLECTION_CHANGED signal to ensure the selected imgids are a subset of the current collection at all time. But that doesn't deal with images that might be hidden from GUI, for example image group members.

It is up to the thumbtable code (aka GUI) to resync selection imgids with visible widgets.

No insertions or deletions should be made into the main.selected_images database table, outside of selection.c. Interactions with selections should use the public API here.

SELECT imgid FROM main.seleted_images should be reserved to SQL JOIN, when fetching metadata from DB for the list of IDs. All other cases should iterate over the GList of imgids returned by dt_selection_get_list()

Definition in file selection.h.