selection.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2011 Henrik Andersson.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2013 Jérémy Rosen.
    Copyright (C) 2013-2014, 2016 Tobias Ellinghaus.
    Copyright (C) 2016 Roman Lebedev.
    Copyright (C) 2018 Rick Yorgason.
    Copyright (C) 2020-2021 Aldric Renaudin.
    Copyright (C) 2020-2021 Pascal Obry.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2022 Philippe Weyland.
    Copyright (C) 2023, 2025 Aurélien PIERRE.
    
    darktable is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    
    darktable is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    along with darktable.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef DT_COMMON_SELECTION_H
#define DT_COMMON_SELECTION_H
 
#include <glib.h>
#include <inttypes.h>
 
#include "common/debug.h"
 
struct dt_selection_t;
 
struct dt_selection_t *dt_selection_new();
void dt_selection_free(struct dt_selection_t *selection);
 
// Interim accessor (Strategy B, doc/globals-migration.md): implemented by the module itself; long-term the handle should be carried on the job/view context (Strategy C).
// NULL in a GUI-less process (ansel-cli): the selection is lighttable state, created by
// dt_gui_gtk_init() through dt_selection_init_global(). Every public function here accepts a
// NULL selection and degrades to a no-op / neutral result, so shared code paths need no guard.
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);
 
#define dt_selection_reload_from_database(selection) DT_DEBUG_TRACE_WRAPPER(DT_DEBUG_SQL, dt_selection_reload_from_database_real, (selection))
 
#endif // DT_COMMON_SELECTION_H
 
// clang-format off
// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
// vim: shiftwidth=2 expandtab tabstop=2 cindent
// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
// clang-format on