Fix #934: Request to add image bookmarking/tagging within a folder
[geeqie.git] / src / options.h
1 /*
2  * Copyright (C) 2008 - 2016 The Geeqie Team
3  *
4  * Authors: Vladimir Nadvornik, Laurent Monin
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19  */
20
21 #ifndef OPTIONS_H
22 #define OPTIONS_H
23
24 typedef struct _ConfOptions ConfOptions;
25
26 struct _ConfOptions
27 {
28         /* ui */
29         gboolean progressive_key_scrolling;
30         guint keyboard_scroll_step;
31         gboolean place_dialogs_under_mouse;
32         gboolean mousewheel_scrolls;
33         gboolean image_lm_click_nav;
34         gboolean image_l_click_archive;
35         gboolean image_l_click_video;
36         gchar *image_l_click_video_editor;
37         gboolean show_icon_names;
38         gboolean show_star_rating;
39         gboolean draw_rectangle;
40         gboolean show_predefined_keyword_tree;
41         gboolean overunderexposed;
42         gboolean expand_menu_toolbar;
43
44         /* various */
45         gboolean tree_descend_subdirs;
46         gboolean view_dir_list_single_click_enter;
47
48         gboolean circular_selection_lists;
49
50         gboolean lazy_image_sync;
51         gboolean update_on_time_change;
52
53         guint duplicates_similarity_threshold;
54         guint duplicates_match;
55         gboolean duplicates_thumbnails;
56         guint duplicates_select_type;
57         gboolean rot_invariant_sim;
58         gboolean sort_totals;
59
60         gint open_recent_list_maxsize;
61         gint recent_folder_image_list_maxsize;
62         gint dnd_icon_size;
63         DnDAction dnd_default_action;
64         gint clipboard_selection;
65
66         gboolean save_window_positions;
67         gboolean use_saved_window_positions_for_new_windows;
68         gboolean save_window_workspace;
69         gboolean tools_restore_state;
70         gboolean save_dialog_window_positions;
71         gboolean show_window_ids;
72
73         gint log_window_lines;
74
75         gboolean marks_save;            /**< save marks on exit */
76         gchar *marks_tooltips[FILEDATA_MARKS_SIZE];
77
78         gboolean with_rename;
79         gboolean collections_on_top;
80         gboolean hide_window_in_fullscreen;
81
82         gchar *help_search_engine;
83
84         /**
85          * @struct info_comment
86          * info sidebar component height
87          */
88         struct {
89                 gint height;
90         } info_comment;
91
92         /**
93          * @struct info_keywords
94          * info sidebar component height
95          */
96         struct {
97                 gint height;
98         } info_keywords;
99
100         /**
101          * @struct info_title
102          * info sidebar component height
103          */
104         struct {
105                 gint height;
106         } info_title;
107
108         /**
109          * @struct info_rating
110          * info sidebar component height
111          */
112         struct {
113                 gint height;
114         } info_rating;
115
116         /**
117          * @struct info_headline
118          * info sidebar component height
119          */
120         struct {
121                 gint height;
122         } info_headline;
123
124         /* file ops */
125         struct {
126                 gboolean enable_in_place_rename;
127
128                 gboolean confirm_delete;
129                 gboolean confirm_move_to_trash;
130                 gboolean enable_delete_key;
131                 gboolean safe_delete_enable;
132                 gboolean use_system_trash;
133                 gchar *safe_delete_path;
134                 gint safe_delete_folder_maxsize;
135                 gboolean no_trash;
136         } file_ops;
137
138         /* image */
139         struct {
140                 gboolean exif_rotate_enable;
141                 guint scroll_reset_method;
142                 gboolean fit_window_to_image;
143                 gboolean limit_window_size;
144                 gint max_window_size;
145                 gboolean limit_autofit_size;
146                 gint max_autofit_size;
147                 gint max_enlargement_size;
148
149                 gint tile_cache_max;    /**< in megabytes */
150                 gint image_cache_max;   /**< in megabytes */
151                 gboolean enable_read_ahead;
152
153                 ZoomMode zoom_mode;
154                 gboolean zoom_2pass;
155                 gboolean zoom_to_fit_allow_expand;
156                 guint zoom_quality;
157                 gint zoom_increment;    /**< 100 is 1.0, 5 is 0.05, 200 is 2.0, etc. */
158                 ZoomStyle zoom_style;
159                 gboolean use_clutter_renderer;
160
161                 gboolean use_custom_border_color_in_fullscreen;
162                 gboolean use_custom_border_color;
163                 GdkColor border_color;
164                 GdkColor alpha_color_1;
165                 GdkColor alpha_color_2;
166
167                 gint tile_size;
168         } image;
169
170         /* thumbnails */
171         struct {
172                 gint max_width;
173                 gint max_height;
174                 gboolean enable_caching;
175                 gboolean cache_into_dirs;
176                 gboolean use_xvpics;
177                 gboolean spec_standard;
178                 guint quality;
179                 gboolean use_exif;
180                 gboolean use_color_management;
181                 gboolean use_ft_metadata;
182                 gint collection_preview;
183 //              gboolean use_ft_metadata_small;
184         } thumbnails;
185
186         /* file filtering */
187         struct {
188                 gboolean show_hidden_files;
189                 gboolean show_parent_directory;
190                 gboolean show_dot_directory;
191                 gboolean disable_file_extension_checks;
192                 gboolean disable;
193         } file_filter;
194
195         struct {
196                 gchar *ext;
197         } sidecar;
198
199         /* collections */
200         struct {
201                 gboolean rectangular_selection;
202         } collections;
203
204         /* shell */
205         struct {
206                 gchar *path;
207                 gchar *options;
208         } shell;
209
210         /* file sorting */
211         struct {
212                 SortType method;
213                 gboolean ascending;
214                 gboolean case_sensitive; /**< file sorting method (case) */
215                 gboolean natural;
216         } file_sort;
217
218         /* slideshow */
219         struct {
220                 gint delay;     /**< in tenths of a second */
221                 gboolean random;
222                 gboolean repeat;
223         } slideshow;
224
225         /* fullscreen */
226         struct {
227                 gint screen;
228                 gboolean clean_flip;
229                 gboolean disable_saver;
230                 gboolean above;
231         } fullscreen;
232
233         /* image overlay */
234         struct {
235                 gchar *template_string;
236                 gint x;
237                 gint y;
238                 guint16 text_red;
239                 guint16 text_green;
240                 guint16 text_blue;
241                 guint16 text_alpha;
242                 guint16 background_red;
243                 guint16 background_green;
244                 guint16 background_blue;
245                 guint16 background_alpha;
246                 gchar *font;
247         } image_overlay;
248
249         /* properties dialog */
250         struct {
251                 gchar *tabs_order;
252         } properties;
253
254         /* color profiles */
255         struct {
256                 gboolean enabled;
257                 gint input_type;
258                 gchar *input_file[COLOR_PROFILE_INPUTS];
259                 gchar *input_name[COLOR_PROFILE_INPUTS];
260                 gchar *screen_file;
261                 gboolean use_image;
262                 gboolean use_x11_screen_profile;
263                 gint render_intent;
264         } color_profile;
265
266         /* Helpers programs */
267         struct {
268                 struct {
269                         gchar *command_name;
270                         gchar *command_line;
271                 } html_browser;
272         } helpers;
273
274         /* Metadata */
275         struct {
276                 gboolean enable_metadata_dirs;
277
278                 gboolean save_in_image_file;
279                 gboolean save_legacy_IPTC;
280                 gboolean warn_on_write_problems;
281
282                 gboolean save_legacy_format;
283
284                 gboolean sync_grouped_files;
285
286                 gboolean confirm_write;
287                 gint confirm_timeout;
288                 gboolean confirm_after_timeout;
289                 gboolean confirm_on_image_change;
290                 gboolean confirm_on_dir_change;
291                 gboolean keywords_case_sensitive;
292                 gboolean write_orientation;
293                 gboolean sidecar_extended_name;
294
295                 gboolean check_spelling;
296         } metadata;
297
298         /* Stereo */
299         struct {
300                 gint mode;;
301                 gint fsmode;
302                 gboolean enable_fsmode;
303                 gint fixed_w, fixed_h;
304                 gint fixed_x1, fixed_y1;
305                 gint fixed_x2, fixed_y2;
306                 /**
307                  * @struct tmp
308                  * options in this struct are packed to mode and fsmode entries
309                  */
310                 struct {
311                         gboolean mirror_right;
312                         gboolean mirror_left;
313                         gboolean flip_right;
314                         gboolean flip_left;
315                         gboolean swap;
316                         gboolean temp_disable;
317                         gboolean fs_mirror_right;
318                         gboolean fs_mirror_left;
319                         gboolean fs_flip_right;
320                         gboolean fs_flip_left;
321                         gboolean fs_swap;
322                         gboolean fs_temp_disable;
323                 } tmp;
324         } stereo;
325
326         /* External preview extraction */
327         struct {
328                 gboolean enable;
329                 gchar *select; /**< path to executable */
330                 gchar *extract; /**< path to executable */
331         } external_preview;
332
333         /**
334          * @struct cp_mv_rn
335          * copy move rename
336          */
337         struct {
338                 gint auto_start;
339                 gchar *auto_end;
340                 gint auto_padding;
341                 gint formatted_start;
342         } cp_mv_rn;
343
344         /* log window */
345         struct {
346                 gboolean paused;
347                 gboolean line_wrap;
348                 gboolean timer_data;
349         } log_window;
350
351         /* star rating */
352         struct {
353                 gunichar star;
354                 gunichar rejected;
355         } star_rating;
356
357         /* Printer */
358         struct {
359                 gchar *image_font;
360                 gchar *page_font;
361                 gboolean show_image_text;
362                 gboolean show_page_text;
363                 gchar *page_text;
364                 gint image_text_position;
365                 gint page_text_position;
366                 gchar *template_string;
367         } printer;
368
369         /* Threads */
370         struct {
371                 gint duplicates;
372         } threads;
373
374         gchar *mouse_button_8; /**< user-definable mouse buttons */
375         gchar *mouse_button_9; /**< user-definable mouse buttons */
376
377         gboolean class_filter[FILE_FORMAT_CLASSES]; /**< class file filter */
378
379         gboolean read_metadata_in_idle;
380
381         gboolean disable_gpu; /**< GPU - see main.c */
382         gboolean override_disable_gpu; /**< GPU - see main.c */
383
384         GList *disabled_plugins;
385 };
386
387 extern ConfOptions *options;
388 extern CommandLine *command_line;
389
390 ConfOptions *init_options(ConfOptions *options);
391 void setup_default_options(ConfOptions *options);
392 void save_options(ConfOptions *options);
393 gboolean load_options(ConfOptions *options);
394
395 void copy_layout_options(LayoutOptions *dest, const LayoutOptions *src);
396 void free_layout_options_content(LayoutOptions *dest);
397 LayoutOptions *init_layout_options(LayoutOptions *options);
398
399 #endif /* OPTIONS_H */
400 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */