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