Fix typo in Readme file
[geeqie.git] / src / menu.cc
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 #include "main.h"
23 #include "menu.h"
24
25 #include "collect-io.h"
26 #include "collect-table.h"
27 #include "editors.h"
28 #include "pixbuf-util.h"
29 #include "ui-fileops.h"
30 #include "ui-menu.h"
31
32 static GtkWidget *real_submenu_add_alter(GtkWidget *menu, GCallback func, gpointer data,
33                                          GtkAccelGroup *accel_group);
34
35 /*
36  *-----------------------------------------------------------------------------
37  * menu utils
38  *-----------------------------------------------------------------------------
39  */
40
41 static GtkWidget *add_menu_item(GtkWidget *menu, gchar *label, GtkAccelGroup *accel_group,
42                                 guint accel_key, guint accel_mods, GCallback func, gpointer data)
43 {
44         GtkWidget *item;
45
46         item = gtk_menu_item_new_with_label(label);
47         gtk_widget_add_accelerator(item, "activate", accel_group, accel_key, static_cast<GdkModifierType>(accel_mods), GTK_ACCEL_VISIBLE);
48         g_signal_connect(G_OBJECT(item), "activate", func, data);
49         gtk_menu_shell_append(GTK_MENU_SHELL(menu), item);
50         gtk_widget_show(item);
51
52         return item;
53 }
54
55 gpointer submenu_item_get_data(GtkWidget *menu)
56 {
57         if (!gtk_widget_get_parent(menu) || !GTK_IS_MENU(gtk_widget_get_parent(menu))) return NULL;
58
59         return g_object_get_data(G_OBJECT(gtk_widget_get_parent(menu)), "submenu_data");
60 }
61
62 /*
63  *-----------------------------------------------------------------------------
64  * edit menu
65  *-----------------------------------------------------------------------------
66  */
67 static void edit_item_destroy_cb(GtkWidget *UNUSED(widget), gpointer data)
68 {
69         g_free(data);
70 }
71
72 static void add_edit_items(GtkWidget *menu, GCallback func, GList *fd_list)
73 {
74         GList *editors_list = editor_list_get();
75         GList *work = editors_list;
76
77         while (work)
78                 {
79                 const EditorDescription *editor = static_cast<const EditorDescription *>(work->data);
80                 work = work->next;
81                 gboolean active = TRUE;
82
83                 if (fd_list && EDITOR_ERRORS(editor_command_parse(editor, fd_list, FALSE, NULL)))
84                         active = FALSE;
85
86                 if (active)
87                         {
88                         GtkWidget *item;
89                         const gchar *stock_id = NULL;
90                         gchar *key = g_strdup(editor->key);
91
92                         if (editor->icon && register_theme_icon_as_stock(key, editor->icon))
93                                 stock_id = key;
94
95                         item = menu_item_add_stock(menu, editor->name, stock_id, func, key);
96                         g_signal_connect(G_OBJECT(item), "destroy", G_CALLBACK(edit_item_destroy_cb), key);
97                         }
98                 }
99
100         g_list_free(editors_list);
101 }
102
103
104 GtkWidget *submenu_add_edit(GtkWidget *menu, GtkWidget **menu_item, GCallback func, gpointer data, GList *fd_list)
105 {
106         GtkWidget *item;
107         GtkWidget *submenu;
108         GtkAccelGroup *accel_group;
109
110         accel_group = gtk_accel_group_new();
111         item = menu_item_add(menu, _("_Plugins"), NULL, NULL);
112
113         submenu = gtk_menu_new();
114         g_object_set_data(G_OBJECT(submenu), "submenu_data", data);
115         gtk_menu_set_accel_group(GTK_MENU(submenu), accel_group);
116         g_object_set_data(G_OBJECT(submenu), "accel_group", accel_group);
117
118         add_edit_items(submenu, func, fd_list);
119
120         gtk_menu_item_set_submenu(GTK_MENU_ITEM(item), submenu);
121
122         if (menu_item) *menu_item = item;
123
124         return submenu;
125 }
126
127 /*
128  *-----------------------------------------------------------------------------
129  * sorting
130  *-----------------------------------------------------------------------------
131  */
132
133 gchar *sort_type_get_text(SortType method)
134 {
135         switch (method)
136                 {
137                 case SORT_SIZE:
138                         return _("Sort by size");
139                         break;
140                 case SORT_TIME:
141                         return _("Sort by date");
142                         break;
143                 case SORT_CTIME:
144                         return _("Sort by file creation date");
145                         break;
146                 case SORT_EXIFTIME:
147                         return _("Sort by Exif date original");
148                         break;
149                 case SORT_EXIFTIMEDIGITIZED:
150                         return _("Sort by Exif date digitized");
151                         break;
152                 case SORT_NONE:
153                         return _("Unsorted");
154                         break;
155                 case SORT_PATH:
156                         return _("Sort by path");
157                         break;
158                 case SORT_RATING:
159                         return _("Sort by rating");
160                         break;
161                 case SORT_CLASS:
162                         return _("Sort by class");
163                         break;
164                 case SORT_NAME:
165                 default:
166                         return _("Sort by name");
167                         break;
168                 }
169
170         return _("");
171 }
172
173 static GtkWidget *submenu_add_sort_item(GtkWidget *menu,
174                                         GCallback func, SortType type,
175                                         gboolean show_current, SortType show_type)
176 {
177         GtkWidget *item;
178
179         if (show_current)
180                 {
181                 item = menu_item_add_radio(menu,
182                                            sort_type_get_text(type), GINT_TO_POINTER((gint)type), (type == show_type),
183                                            func, GINT_TO_POINTER((gint)type));
184                 }
185         else
186                 {
187                 item = menu_item_add(menu, sort_type_get_text(type),
188                                      func, GINT_TO_POINTER((gint)type));
189                 }
190
191         return item;
192 }
193
194 GtkWidget *submenu_add_sort(GtkWidget *menu, GCallback func, gpointer data,
195                             gboolean include_none, gboolean include_path,
196                             gboolean show_current, SortType type)
197 {
198         GtkWidget *submenu;
199
200         submenu = gtk_menu_new();
201         g_object_set_data(G_OBJECT(submenu), "submenu_data", data);
202
203         submenu_add_sort_item(submenu, func, SORT_NAME, show_current, type);
204         submenu_add_sort_item(submenu, func, SORT_TIME, show_current, type);
205         submenu_add_sort_item(submenu, func, SORT_CTIME, show_current, type);
206         submenu_add_sort_item(submenu, func, SORT_EXIFTIME, show_current, type);
207         submenu_add_sort_item(submenu, func, SORT_EXIFTIMEDIGITIZED, show_current, type);
208         submenu_add_sort_item(submenu, func, SORT_SIZE, show_current, type);
209         submenu_add_sort_item(submenu, func, SORT_RATING, show_current, type);
210         submenu_add_sort_item(submenu, func, SORT_CLASS, show_current, type);
211         if (include_path) submenu_add_sort_item(submenu, func, SORT_PATH, show_current, type);
212         if (include_none) submenu_add_sort_item(submenu, func, SORT_NONE, show_current, type);
213
214         if (menu)
215                 {
216                 GtkWidget *item;
217
218                 item = menu_item_add(menu, _("Sort"), NULL, NULL);
219                 gtk_menu_item_set_submenu(GTK_MENU_ITEM(item), submenu);
220                 return item;
221                 }
222
223         return submenu;
224 }
225
226 GtkWidget *submenu_add_dir_sort(GtkWidget *menu, GCallback func, gpointer data,
227                             gboolean include_none, gboolean include_path,
228                             gboolean show_current, SortType type)
229 {
230         GtkWidget *submenu;
231
232         submenu = gtk_menu_new();
233         g_object_set_data(G_OBJECT(submenu), "submenu_data", data);
234
235         submenu_add_sort_item(submenu, func, SORT_NAME, show_current, type);
236         submenu_add_sort_item(submenu, func, SORT_TIME, show_current, type);
237         if (include_path) submenu_add_sort_item(submenu, func, SORT_PATH, show_current, type);
238         if (include_none) submenu_add_sort_item(submenu, func, SORT_NONE, show_current, type);
239
240         if (menu)
241                 {
242                 GtkWidget *item;
243
244                 item = menu_item_add(menu, _("Sort"), NULL, NULL);
245                 gtk_menu_item_set_submenu(GTK_MENU_ITEM(item), submenu);
246                 return item;
247                 }
248
249         return submenu;
250 }
251
252 gchar *zoom_type_get_text(ZoomMode method)
253 {
254         switch (method)
255                 {
256                 case ZOOM_RESET_ORIGINAL:
257                         return _("Zoom to original size");
258                         break;
259                 case ZOOM_RESET_FIT_WINDOW:
260                         return _("Fit image to window");
261                         break;
262                 case ZOOM_RESET_NONE:
263                         return _("Leave Zoom at previous setting");
264                         break;
265                 default:
266                         return _("Zoom to original size");
267                         break;
268                 }
269
270         return _("");
271 }
272
273 static GtkWidget *submenu_add_zoom_item(GtkWidget *menu,
274                                         GCallback func, ZoomMode mode,
275                                         gboolean show_current, ZoomMode show_mode)
276 {
277         GtkWidget *item;
278
279         if (show_current)
280                 {
281                 item = menu_item_add_radio(menu,
282                                            zoom_type_get_text(mode), GINT_TO_POINTER((gint)mode), (mode == show_mode),
283                                            func, GINT_TO_POINTER((gint)mode));
284                 }
285         else
286                 {
287                 item = menu_item_add(menu, zoom_type_get_text(mode),
288                                      func, GINT_TO_POINTER((gint)mode));
289                 }
290
291         return item;
292 }
293
294 GtkWidget *submenu_add_zoom(GtkWidget *menu, GCallback func, gpointer data,
295                             gboolean UNUSED(include_none), gboolean UNUSED(include_path),
296                             gboolean show_current, ZoomMode mode)
297 {
298         GtkWidget *submenu;
299
300         if (!menu)
301                 {
302                 submenu = gtk_menu_new();
303                 g_object_set_data(G_OBJECT(submenu), "submenu_data", data);
304                 }
305         else
306                 {
307                 submenu = menu;
308                 }
309
310         submenu_add_zoom_item(submenu, func, ZOOM_RESET_ORIGINAL, show_current, mode);
311         submenu_add_zoom_item(submenu, func, ZOOM_RESET_FIT_WINDOW, show_current, mode);
312         submenu_add_zoom_item(submenu, func, ZOOM_RESET_NONE, show_current, mode);
313
314         if (menu)
315                 {
316                 GtkWidget *item;
317
318                 item = menu_item_add(menu, _("Zoom"), NULL, NULL);
319                 gtk_menu_item_set_submenu(GTK_MENU_ITEM(item), submenu);
320                 return item;
321                 }
322
323         return submenu;
324 }
325
326 /*
327  *-----------------------------------------------------------------------------
328  * altering
329  *-----------------------------------------------------------------------------
330  */
331
332 gchar *alter_type_get_text(AlterType type)
333 {
334         switch (type)
335                 {
336                 case ALTER_ROTATE_90:
337                         return _("Rotate clockwise 90°");
338                         break;
339                 case ALTER_ROTATE_90_CC:
340                         return _("Rotate counterclockwise 90°");
341                         break;
342                 case ALTER_ROTATE_180:
343                         return _("Rotate 180°");
344                         break;
345                 case ALTER_MIRROR:
346                         return _("Mirror");
347                         break;
348                 case ALTER_FLIP:
349                         return _("Flip");
350                         break;
351                 case ALTER_NONE:
352                         return _("Original state");
353                         break;
354                 default:
355                         break;
356                 }
357
358         return _("");
359 }
360
361 static void submenu_add_alter_item(GtkWidget *menu, GCallback func, AlterType type,
362                                    GtkAccelGroup *accel_group, guint accel_key, guint accel_mods)
363 {
364         if (accel_group)
365                 {
366                 add_menu_item(menu, alter_type_get_text(type), accel_group,
367                               accel_key, accel_mods, func, GINT_TO_POINTER((gint)type));
368
369                 }
370         else
371                 {
372                 menu_item_add(menu, alter_type_get_text(type), func, GINT_TO_POINTER((gint)type));
373                 }
374 }
375
376 static GtkWidget *real_submenu_add_alter(GtkWidget *menu, GCallback func, gpointer data,
377                                          GtkAccelGroup *accel_group)
378 {
379         GtkWidget *submenu;
380
381         submenu = gtk_menu_new();
382         g_object_set_data(G_OBJECT(submenu), "submenu_data", data);
383
384         submenu_add_alter_item(submenu, func, ALTER_ROTATE_90, accel_group, ']', 0);
385         submenu_add_alter_item(submenu, func, ALTER_ROTATE_90_CC, accel_group, '[', 0);
386         submenu_add_alter_item(submenu, func, ALTER_ROTATE_180, accel_group, 'R', GDK_SHIFT_MASK);
387         submenu_add_alter_item(submenu, func, ALTER_MIRROR, accel_group, 'M', GDK_SHIFT_MASK);
388         submenu_add_alter_item(submenu, func, ALTER_FLIP, accel_group, 'F', GDK_SHIFT_MASK);
389         submenu_add_alter_item(submenu, func, ALTER_NONE, accel_group, 'O', GDK_SHIFT_MASK);
390
391         if (menu)
392                 {
393                 GtkWidget *item;
394
395                 item = menu_item_add(menu, _("_Orientation"), NULL, NULL);
396                 gtk_menu_item_set_submenu(GTK_MENU_ITEM(item), submenu);
397                 return item;
398                 }
399
400         return submenu;
401 }
402
403 GtkWidget *submenu_add_alter(GtkWidget *menu, GCallback func, gpointer data)
404 {
405         GtkAccelGroup *accel;
406
407         accel = gtk_accel_group_new();
408         return real_submenu_add_alter(menu, func, data, accel); //last accel gr
409 }
410
411 /*
412  *-----------------------------------------------------------------------------
413  * collections
414  *-----------------------------------------------------------------------------
415  */
416
417 /**
418  * @brief Add submenu consisting of "New collection", and list of existing collections to a right-click menu.
419  * @param[in] menu 
420  * @param[in] func 
421  * @param[in] collection_list Type gchar
422  * @param[in] data 
423  * 
424  *  Used by all image windows
425  */
426 static void add_collection_list(GtkWidget *menu, GCallback func,
427                                                                 GList *collection_list, gpointer UNUSED(data))
428 {
429         GList *work;
430         gint index = 0; /* index to existing collection list menu item selected */
431
432         work = collection_list;
433         while (work)
434                 {
435                 const gchar *collection_name = static_cast<const gchar *>(work->data);
436
437                 menu_item_add(menu, collection_name, func,
438                                                                                                         GINT_TO_POINTER(index));
439                 work = work->next;
440                 index++;
441                 }
442 }
443
444 GtkWidget *submenu_add_collections(GtkWidget *menu, GtkWidget **menu_item,
445                                                                                 GCallback func, gpointer data)
446 {
447         GtkWidget *item;
448         GtkWidget *submenu;
449         GList *collection_list = NULL;
450
451         item = menu_item_add(menu, _("_Add to Collection"), NULL, NULL);
452
453         submenu = gtk_menu_new();
454         g_object_set_data(G_OBJECT(submenu), "submenu_data", data);
455
456         menu_item_add_stock_sensitive(submenu, _("New collection"),
457                                         GTK_STOCK_INDEX, TRUE, G_CALLBACK(func), GINT_TO_POINTER(-1));
458         menu_item_add_divider(submenu);
459
460         collect_manager_list(&collection_list,NULL,NULL);
461         add_collection_list(submenu, func, collection_list, data);
462
463         gtk_menu_item_set_submenu(GTK_MENU_ITEM(item), submenu);
464         if (menu_item) *menu_item = item;
465
466         g_list_free(collection_list);
467
468         return submenu;
469 }
470
471 /**
472  * @brief Add file selection list to a collection
473  * @param[in] selection_list Selection list of ::_FileData
474  * @param[in] data Index to the collection list menu item selected, or -1 for new collection
475  * 
476  * 
477  */
478 void pop_menu_collections(GList *selection_list, gpointer data)
479 {
480         CollectWindow *cw;
481         gchar *collection_name;
482         GList *collection_list = NULL;
483         gchar *name;
484         const gint index = GPOINTER_TO_INT(data);
485
486         if (index >= 0)
487                 {
488                 collect_manager_list(&collection_list, NULL, NULL);
489                 collection_name = static_cast<gchar *>(g_list_nth_data(collection_list, index));
490                 name = collection_path(collection_name);
491                 cw = collection_window_new(name);
492                 g_free(name);
493                 string_list_free(collection_list);
494                 }
495         else
496                 {
497                 cw = collection_window_new(NULL);
498                 }
499
500         collection_table_add_filelist(cw->table, selection_list);
501 }
502
503 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */