common/styles.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2010 calca.
    Copyright (C) 2010 Henrik Andersson.
    Copyright (C) 2012 Frédéric Grollier.
    Copyright (C) 2012 johannes hanika.
    Copyright (C) 2012-2013 Jérémy Rosen.
    Copyright (C) 2012-2014, 2020-2021 Pascal Obry.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2013-2017 Tobias Ellinghaus.
    Copyright (C) 2016 Roman Lebedev.
    Copyright (C) 2018 Edgardo Hoszowski.
    Copyright (C) 2020 Aldric Renaudin.
    Copyright (C) 2020 Chris Elston.
    Copyright (C) 2020-2021 Hubert Kowalski.
    Copyright (C) 2020 Philippe Weyland.
    Copyright (C) 2021 Hanno Schwalm.
    Copyright (C) 2022 Diederik Ter Rahe.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2025-2026 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/>.
*/
 
#pragma once
 
#include "common/darktable.h"
#include "common/history_merge.h"
#include "develop/blend.h"
#include "develop/imageop.h"
 
#include <glib.h>
#include <inttypes.h>
#include <sqlite3.h>
 
typedef struct dt_style_t
{
  gchar *name;
  gchar *description;
} dt_style_t;
 
typedef enum dt_style_applymode_t
{
  DT_STYLE_HISTORY_APPEND = 0,
  DT_STYLE_HISTORY_OVERWRITE = 1
} dt_style_applymode_t;
 
typedef struct dt_style_item_t
{
  int num, selimg_num, enabled, multi_priority;
  int iop_order;
  gchar *name, *operation, *multi_name;
  int module_version, blendop_version;
  dt_iop_params_t *params;
  dt_develop_blend_params_t *blendop_params;
  int32_t params_size, blendop_params_size;
} dt_style_item_t;
 
void dt_style_free(gpointer data);
void dt_style_item_free(gpointer data);
 
gboolean dt_styles_create_from_image(const char *name, const char *description,
                                     const int32_t imgid, GList *items, gboolean copy_iop_order);
 
void dt_styles_create_from_list(const GList *list);
 
void dt_styles_create_from_style(const char *name, const char *newname, const char *description,
                                 GList *filter, const int32_t imgid, GList *update,
                                 gboolean copy_iop_order, const gboolean update_iop_order);
 
void dt_styles_update(const char *name, const char *newname, const char *description, GList *filter,
                      const int32_t imgid, GList *update,
                      const gboolean copy_iop_order, const gboolean update_iop_order);
 
void dt_multiple_styles_apply_to_list(GList *styles, const GList *list, gboolean duplicate);
 
void dt_styles_apply_style_item(dt_develop_t *dev, dt_style_item_t *style_item);
 
void dt_styles_apply_to_image(const char *name, const gboolean duplicate, const int32_t imgid);
int dt_styles_apply_to_image_merge(const char *name, const int style_id, const int32_t newimgid,
                                   const dt_history_merge_strategy_t mode, dt_hm_batch_state_t *batch);
 
void dt_styles_delete_by_name_adv(const char *name, const gboolean raise);
 
void dt_styles_delete_by_name(const char *name);
 
dt_style_t *dt_styles_get_by_name(const char *name);
 
int32_t dt_styles_get_id_by_name(const char *name);
 
gboolean dt_styles_exists(const char *name);
 
gboolean dt_styles_has_module_order(const char *name);
 
GList *dt_styles_get_list(const char *filter);
 
GList *dt_styles_get_item_list(const char *name, gboolean params, int32_t imgid);
 
char *dt_styles_get_item_list_as_string(const char *name);
 
gchar *dt_styles_get_description(const char *name);
 
void dt_styles_save_to_file(const char *style_name, const char *filedir, gboolean overwrite);
 
void dt_styles_import_from_file(const char *style_path);
 
void dt_styles_cleanup(void);
 
// 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