Convert comments in .h files to Doxygen style comments
[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_video;
35         gchar *image_l_click_video_editor;
36         gboolean show_icon_names;
37         gboolean show_star_rating;
38         gboolean show_guidelines;
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 lazy_image_sync;
49         gboolean update_on_time_change;
50
51         guint duplicates_similarity_threshold;
52         guint duplicates_match;
53         gboolean duplicates_thumbnails;
54         guint duplicates_select_type;
55         gboolean rot_invariant_sim;
56         gboolean sort_totals;
57
58         gint open_recent_list_maxsize;
59         gint dnd_icon_size;
60         DnDAction dnd_default_action;
61         gint clipboard_selection;
62
63         gboolean save_window_positions;
64         gboolean use_saved_window_positions_for_new_windows;
65         gboolean save_window_workspace;
66         gboolean tools_restore_state;
67         gboolean save_dialog_window_positions;
68         gboolean show_window_ids;
69
70         gint log_window_lines;
71
72         gboolean marks_save;            /**< save marks on exit */
73         gchar *marks_tooltips[FILEDATA_MARKS_SIZE];
74
75         gboolean with_rename;
76         gboolean collections_on_top;
77         gboolean hide_window_in_fullscreen;
78
79         gchar *help_search_engine;
80
81         /**
82          * \struct info_comment
83          * info sidebar component height
84          */
85         struct {
86                 gint height;
87         } info_comment;
88
89         /**
90          * \struct info_keywords
91          * info sidebar component height
92          */
93         struct {
94                 gint height;
95         } info_keywords;
96
97         /**
98          * \struct info_title
99          * info sidebar component height
100          */
101         struct {
102                 gint height;
103         } info_title;
104
105         /**
106          * \struct info_rating
107          * info sidebar component height
108          */
109         struct {
110                 gint height;
111         } info_rating;
112
113         /* file ops */
114         struct {
115                 gboolean enable_in_place_rename;
116
117                 gboolean confirm_delete;
118                 gboolean confirm_move_to_trash;
119                 gboolean enable_delete_key;
120                 gboolean safe_delete_enable;
121                 gboolean use_system_trash;
122                 gchar *safe_delete_path;
123                 gint safe_delete_folder_maxsize;
124                 gboolean no_trash;
125         } file_ops;
126
127         /* image */
128         struct {
129                 gboolean exif_rotate_enable;
130                 gboolean exif_proof_rotate_enable;
131                 guint scroll_reset_method;
132                 gboolean fit_window_to_image;
133                 gboolean limit_window_size;
134                 gint max_window_size;
135                 gboolean limit_autofit_size;
136                 gint max_autofit_size;
137                 gint max_enlargement_size;
138
139                 gint tile_cache_max;    /**< in megabytes */
140                 gint image_cache_max;   /**< in megabytes */
141                 gboolean enable_read_ahead;
142
143                 ZoomMode zoom_mode;
144                 gboolean zoom_2pass;
145                 gboolean zoom_to_fit_allow_expand;
146                 guint zoom_quality;
147                 gint zoom_increment;    /**< 100 is 1.0, 5 is 0.05, 200 is 2.0, etc. */
148                 gboolean use_clutter_renderer;
149
150                 gboolean use_custom_border_color_in_fullscreen;
151                 gboolean use_custom_border_color;
152                 GdkColor border_color;
153                 GdkColor alpha_color_1;
154                 GdkColor alpha_color_2;
155         } image;
156
157         /* thumbnails */
158         struct {
159                 gint max_width;
160                 gint max_height;
161                 gboolean enable_caching;
162                 gboolean cache_into_dirs;
163                 gboolean use_xvpics;
164                 gboolean spec_standard;
165                 guint quality;
166                 gboolean use_exif;
167                 gboolean use_ft_metadata;
168                 gint collection_preview;
169 //              gboolean use_ft_metadata_small;
170         } thumbnails;
171
172         /* file filtering */
173         struct {
174                 gboolean show_hidden_files;
175                 gboolean show_parent_directory;
176                 gboolean show_dot_directory;
177                 gboolean disable_file_extension_checks;
178                 gboolean disable;
179         } file_filter;
180
181         struct {
182                 gchar *ext;
183         } sidecar;
184
185         /* collections */
186         struct {
187                 gboolean rectangular_selection;
188         } collections;
189
190         /* shell */
191         struct {
192                 gchar *path;
193                 gchar *options;
194         } shell;
195
196         /* file sorting */
197         struct {
198                 SortType method;
199                 gboolean ascending;
200                 gboolean case_sensitive; /**< file sorting method (case) */
201                 gboolean natural;
202         } file_sort;
203
204         /* slideshow */
205         struct {
206                 gint delay;     /**< in tenths of a second */
207                 gboolean random;
208                 gboolean repeat;
209         } slideshow;
210
211         /* fullscreen */
212         struct {
213                 gint screen;
214                 gboolean clean_flip;
215                 gboolean disable_saver;
216                 gboolean above;
217         } fullscreen;
218
219         /* image overlay */
220         struct {
221                 gchar *template_string;
222                 gint x;
223                 gint y;
224                 guint16 text_red;
225                 guint16 text_green;
226                 guint16 text_blue;
227                 guint16 text_alpha;
228                 guint16 background_red;
229                 guint16 background_green;
230                 guint16 background_blue;
231                 guint16 background_alpha;
232                 gchar *font;
233         } image_overlay;
234
235         /* properties dialog */
236         struct {
237                 gchar *tabs_order;
238         } properties;
239
240         /* color profiles */
241         struct {
242                 gboolean enabled;
243                 gint input_type;
244                 gchar *input_file[COLOR_PROFILE_INPUTS];
245                 gchar *input_name[COLOR_PROFILE_INPUTS];
246                 gchar *screen_file;
247                 gboolean use_image;
248                 gboolean use_x11_screen_profile;
249                 gint render_intent;
250         } color_profile;
251
252         /* Helpers programs */
253         struct {
254                 struct {
255                         gchar *command_name;
256                         gchar *command_line;
257                 } html_browser;
258         } helpers;
259
260         /* Metadata */
261         struct {
262                 gboolean enable_metadata_dirs;
263
264                 gboolean save_in_image_file;
265                 gboolean save_legacy_IPTC;
266                 gboolean warn_on_write_problems;
267
268                 gboolean save_legacy_format;
269
270                 gboolean sync_grouped_files;
271
272                 gboolean confirm_write;
273                 gint confirm_timeout;
274                 gboolean confirm_after_timeout;
275                 gboolean confirm_on_image_change;
276                 gboolean confirm_on_dir_change;
277                 gboolean keywords_case_sensitive;
278                 gboolean write_orientation;
279                 gboolean sidecar_extended_name;
280         } metadata;
281
282         /* Stereo */
283         struct {
284                 gint mode;;
285                 gint fsmode;
286                 gboolean enable_fsmode;
287                 gint fixed_w, fixed_h;
288                 gint fixed_x1, fixed_y1;
289                 gint fixed_x2, fixed_y2;
290                 /**
291                  * \struct tmp
292                  * options in this struct are packed to mode and fsmode entries
293                  */
294                 struct {
295                         gboolean mirror_right;
296                         gboolean mirror_left;
297                         gboolean flip_right;
298                         gboolean flip_left;
299                         gboolean swap;
300                         gboolean temp_disable;
301                         gboolean fs_mirror_right;
302                         gboolean fs_mirror_left;
303                         gboolean fs_flip_right;
304                         gboolean fs_flip_left;
305                         gboolean fs_swap;
306                         gboolean fs_temp_disable;
307                 } tmp;
308         } stereo;
309
310         /**
311          * \struct cp_mv_rn
312          * copy move rename
313          */
314         struct {
315                 gint auto_start;
316                 gchar *auto_end;
317                 gint auto_padding;
318                 gint formatted_start;
319         } cp_mv_rn;
320
321         /* log window */
322         struct {
323                 gboolean paused;
324                 gboolean line_wrap;
325                 gboolean timer_data;
326         } log_window;
327
328         /* star rating */
329         struct {
330                 gunichar star;
331                 gunichar rejected;
332         } star_rating;
333
334         /* Printer */
335         struct {
336                 gchar *image_font;
337                 gchar *page_font;
338                 gboolean show_image_text;
339                 gboolean show_page_text;
340                 gchar *page_text;
341                 gint image_text_position;
342                 gint page_text_position;
343                 gchar *template_string;
344         } printer;
345
346         gchar *mouse_button_8; /**< user-definable mouse buttons */
347         gchar *mouse_button_9; /**< user-definable mouse buttons */
348
349         gboolean class_filter[FILE_FORMAT_CLASSES]; /**< class file filter */
350
351         gboolean read_metadata_in_idle;
352
353         gboolean disable_gpu; /**< GPU - see main.c */
354         gboolean override_disable_gpu; /**< GPU - see main.c */
355
356         GList *disabled_plugins;
357 };
358
359 extern ConfOptions *options;
360 extern CommandLine *command_line;
361
362 ConfOptions *init_options(ConfOptions *options);
363 void setup_default_options(ConfOptions *options);
364 void save_options(ConfOptions *options);
365 gboolean load_options(ConfOptions *options);
366
367 void copy_layout_options(LayoutOptions *dest, const LayoutOptions *src);
368 void free_layout_options_content(LayoutOptions *dest);
369 LayoutOptions *init_layout_options(LayoutOptions *options);
370
371 #endif /* OPTIONS_H */
372 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */