progress.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2014, 2016-2017 Tobias Ellinghaus.
    Copyright (C) 2020 Pascal Obry.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2026 Guillaume Stutin.
    
    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_CONTROL_PROGRESS_H
#define DT_CONTROL_PROGRESS_H
 
#include <glib.h>
 
struct dt_control_t;
struct _dt_job_t;
 
struct _dt_progress_t;
typedef struct _dt_progress_t dt_progress_t;
 
typedef void (*dt_progress_cancel_callback_t)(dt_progress_t *progress, void *data);
 
/* init the progress system, basically making sure that any global progress bar is hidden */
void dt_control_progress_init(struct dt_control_t *control);
 
dt_progress_t *dt_control_progress_create(struct dt_control_t *control, gboolean has_progress_bar,
                                          const gchar *message);
void dt_control_progress_destroy(struct dt_control_t *control, dt_progress_t *progress);
 
void dt_control_progress_make_cancellable(struct dt_control_t *control, dt_progress_t *progress,
                                          dt_progress_cancel_callback_t cancel, void *data);
void dt_control_progress_attach_job(struct dt_control_t *control, dt_progress_t *progress,
                                    struct _dt_job_t *job);
void dt_control_progress_cancel(struct dt_control_t *control, dt_progress_t *progress);
 
void dt_control_progress_set_progress(struct dt_control_t *control, dt_progress_t *progress, double value);
double dt_control_progress_get_progress(dt_progress_t *progress);
 
const gchar *dt_control_progress_get_message(dt_progress_t *progress);
void dt_control_progress_set_message(struct dt_control_t *control, dt_progress_t *progress, const char *message);
 
typedef void (*dt_progress_foreach_callback_t)(const gchar *message, void *data);
void dt_control_progress_foreach(struct dt_control_t *control, dt_progress_foreach_callback_t callback,
                                 void *data);
 
void dt_control_progress_set_gui_data(dt_progress_t *progress, void *data);
void *dt_control_progress_get_gui_data(dt_progress_t *progress);
 
gboolean dt_control_progress_has_progress_bar(dt_progress_t *progress);
 
gboolean dt_control_progress_cancellable(dt_progress_t *progress);
 
#endif // DT_CONTROL_PROGRESS_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