Fix missing translation
[geeqie.git] / src / layout.h
1 /*
2  * Copyright (C) 2004 John Ellis
3  * Copyright (C) 2008 - 2016 The Geeqie Team
4  *
5  * Author: John Ellis
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21
22 #ifndef LAYOUT_H
23 #define LAYOUT_H
24
25 #include <gtk/gtk.h>
26
27 #include "options.h"
28
29 struct AnimationData;
30 struct FileData;
31 struct FullScreenData;
32 struct ImageWindow;
33 struct SlideShowData;
34 struct ViewDir;
35 struct ViewFile;
36
37 #define LAYOUT_ID_CURRENT "_current_"
38 #define MAX_SPLIT_IMAGES 4
39
40 extern GList *layout_window_list;
41
42
43 enum LayoutLocation {
44         LAYOUT_HIDE   = 0,
45         LAYOUT_LEFT   = 1 << 0,
46         LAYOUT_RIGHT  = 1 << 1,
47         LAYOUT_TOP    = 1 << 2,
48         LAYOUT_BOTTOM = 1 << 3
49 };
50
51 struct LayoutWindow
52 {
53         LayoutOptions options;
54
55         FileData *dir_fd;
56
57         /* base */
58
59         GtkWidget *window;
60
61         GtkWidget *main_box;
62
63         GtkWidget *group_box;
64         GtkWidget *h_pane;
65         GtkWidget *v_pane;
66
67         /* menus, path selector */
68
69         GtkActionGroup *action_group;
70         GtkActionGroup *action_group_editors;
71         guint ui_editors_id;
72         GtkUIManager *ui_manager;
73         guint toolbar_merge_id[TOOLBAR_COUNT];
74         GList *toolbar_actions[TOOLBAR_COUNT];
75
76         GtkWidget *path_entry;
77
78         /* image */
79
80         LayoutLocation image_location;
81
82         ImageWindow *image;
83
84         ImageWindow *split_images[MAX_SPLIT_IMAGES];
85         ImageSplitMode split_mode;
86         gint active_split_image;
87
88         GtkWidget *split_image_widget;
89         GtkSizeGroup *split_image_sizegroup;
90
91         /* tools window (float) */
92
93         GtkWidget *tools;
94         GtkWidget *tools_pane;
95
96         GtkWidget *menu_tool_bar; /**< Combined menu and toolbar box */
97         GtkWidget *menu_bar; /**< referenced by lw, exist during whole lw lifetime */
98         /* toolbar */
99
100         GtkWidget *toolbar[TOOLBAR_COUNT]; /**< referenced by lw, exist during whole lw lifetime */
101
102         GtkWidget *back_button;
103
104         /* dir view */
105
106         LayoutLocation dir_location;
107
108         ViewDir *vd;
109         GtkWidget *dir_view;
110
111         /* file view */
112
113         LayoutLocation file_location;
114
115         ViewFile *vf;
116
117         GtkWidget *file_view;
118
119         GtkWidget *info_box; /**< status bar */
120         GtkWidget *info_progress_bar; /**< status bar */
121         GtkWidget *info_sort; /**< status bar */
122         GtkWidget *info_status; /**< status bar */
123         GtkWidget *info_details; /**< status bar */
124         GtkWidget *info_zoom; /**< status bar */
125         GtkWidget *info_pixel; /**< status bar */
126
127         /* slide show */
128
129         SlideShowData *slideshow;
130
131         /* full screen */
132
133         FullScreenData *full_screen;
134
135         /* misc */
136
137         GtkWidget *utility_box; /**< referenced by lw, exist during whole lw lifetime */
138         GtkWidget *utility_paned; /**< between image and bar */
139         GtkWidget *bar_sort;
140         GtkWidget *bar;
141
142         gboolean bar_sort_enabled; /**< Set during start-up, and checked when the editors have loaded */
143
144         GtkWidget *exif_window;
145         GtkWidget *sar_window; /**< Search and Run window */
146
147         AnimationData *animation;
148
149         GtkWidget *log_window;
150 };
151
152 LayoutWindow *layout_new(FileData *dir_fd, LayoutOptions *lop);
153 LayoutWindow *layout_new_with_geometry(FileData *dir_fd, LayoutOptions *lop,
154                                        const gchar *geometry);
155 LayoutWindow *layout_new_from_config(const gchar **attribute_names, const gchar **attribute_values, gboolean use_commandline);
156 void layout_update_from_config(LayoutWindow *lw, const gchar **attribute_names, const gchar **attribute_values);
157 LayoutWindow *layout_new_from_default();
158
159 void layout_close(LayoutWindow *lw);
160 void layout_free(LayoutWindow *lw);
161
162 gboolean layout_valid(LayoutWindow **lw);
163
164 void layout_show_config_window(LayoutWindow *lw);
165
166 void layout_apply_options(LayoutWindow *lw, LayoutOptions *lop);
167
168 void layout_sync_options_with_current_state(LayoutWindow *lw);
169 void layout_load_attributes(LayoutOptions *layout, const gchar **attribute_names, const gchar **attribute_values);
170 void layout_write_attributes(LayoutOptions *layout, GString *outstr, gint indent);
171 void layout_write_config(LayoutWindow *lw, GString *outstr, gint indent);
172
173
174 LayoutWindow *layout_find_by_image(ImageWindow *imd);
175 LayoutWindow *layout_find_by_image_fd(ImageWindow *imd);
176 LayoutWindow *layout_find_by_layout_id(const gchar *id);
177
178
179 const gchar *layout_get_path(LayoutWindow *lw);
180 gboolean layout_set_path(LayoutWindow *lw, const gchar *path);
181 gboolean layout_set_fd(LayoutWindow *lw, FileData *fd);
182
183 void layout_status_update_progress(LayoutWindow *lw, gdouble val, const gchar *text);
184 void layout_status_update_info(LayoutWindow *lw, const gchar *text);
185 void layout_status_update_image(LayoutWindow *lw);
186 void layout_status_update_all(LayoutWindow *lw);
187
188 GList *layout_list(LayoutWindow *lw);
189 guint layout_list_count(LayoutWindow *lw, gint64 *bytes);
190 FileData *layout_list_get_fd(LayoutWindow *lw, gint index);
191 gint layout_list_get_index(LayoutWindow *lw, FileData *fd);
192 void layout_list_sync_fd(LayoutWindow *lw, FileData *fd);
193
194 GList *layout_selection_list(LayoutWindow *lw);
195 /* return list of pointers to int for selection */
196 GList *layout_selection_list_by_index(LayoutWindow *lw);
197 guint layout_selection_count(LayoutWindow *lw, gint64 *bytes);
198 void layout_select_all(LayoutWindow *lw);
199 void layout_select_none(LayoutWindow *lw);
200 void layout_select_invert(LayoutWindow *lw);
201 void layout_select_list(LayoutWindow *lw, GList *list);
202
203 void layout_mark_to_selection(LayoutWindow *lw, gint mark, MarkToSelectionMode mode);
204 void layout_selection_to_mark(LayoutWindow *lw, gint mark, SelectionToMarkMode mode);
205
206 void layout_mark_filter_toggle(LayoutWindow *lw, gint mark);
207
208 void layout_refresh(LayoutWindow *lw);
209
210 void layout_thumb_set(LayoutWindow *lw, gboolean enable);
211
212 void layout_marks_set(LayoutWindow *lw, gboolean enable);
213
214 void layout_file_filter_set(LayoutWindow *lw, gboolean enable);
215
216 void layout_sort_set_files(LayoutWindow *lw, SortType type, gboolean ascend, gboolean case_sensitive);
217 gboolean layout_sort_get(LayoutWindow *lw, SortType *type, gboolean *ascend, gboolean *case_sensitive);
218
219 gboolean layout_geometry_get(LayoutWindow *lw, gint *x, gint *y, gint *w, gint *h);
220 gboolean layout_geometry_get_dividers(LayoutWindow *lw, gint *h, gint *v);
221
222 void layout_views_set(LayoutWindow *lw, DirViewType dir_view_type, FileViewType file_view_type);
223
224 void layout_views_set_sort_dir(LayoutWindow *lw, SortType method, gboolean ascend, gboolean case_sensitive);
225
226 void layout_status_update(LayoutWindow *lw, const gchar *text);
227
228 void layout_style_set(LayoutWindow *lw, gint style, const gchar *order);
229
230 void layout_menu_update_edit();
231 void layout_styles_update();
232 void layout_colors_update();
233
234
235 gboolean layout_geometry_get_tools(LayoutWindow *lw, gint *x, gint *y, gint *w, gint *h, gint *divider_pos);
236 void layout_tools_float_set(LayoutWindow *lw, gboolean popped, gboolean hidden);
237 gboolean layout_tools_float_get(LayoutWindow *lw, gboolean *popped, gboolean *hidden);
238
239 void layout_tools_float_toggle(LayoutWindow *lw);
240 void layout_tools_hide_toggle(LayoutWindow *lw);
241
242
243 void layout_selectable_toolbars_toggle(LayoutWindow *lw);
244 void layout_info_pixel_set(LayoutWindow *lw, gboolean show);
245
246 void layout_split_change(LayoutWindow *lw, ImageSplitMode mode);
247
248 void save_layout(LayoutWindow *lw);
249 gchar *layout_get_unique_id();
250 guint layout_window_count();
251
252 #endif
253 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */