fixed usage of deprecated functions - patch by Omari Stephens
[geeqie.git] / src / ui_tree_edit.c
1 /*
2  * (SLIK) SimpLIstic sKin functions
3  * (C) 2004 John Ellis
4  * Copyright (C) 2008 The Geeqie Team
5  *
6  * Author: John Ellis
7  *
8  * This software is released under the GNU General Public License (GNU GPL).
9  * Please read the included file COPYING for more information.
10  * This software comes with no warranty of any kind, use at your own risk!
11  */
12
13 #ifdef HAVE_CONFIG_H
14 #  include "config.h"
15 #endif
16 #include "intl.h"
17
18 #include <stdio.h>
19 #include <stdlib.h>
20 #include <string.h>
21
22 #include <gtk/gtk.h>
23 #include <gdk/gdkkeysyms.h>
24
25 #include "ui_tree_edit.h"
26
27 /*
28  *-------------------------------------------------------------------
29  * cell popup editor
30  *-------------------------------------------------------------------
31  */
32
33 static void tree_edit_close(TreeEditData *ted)
34 {
35         gtk_grab_remove(ted->window);
36         gdk_keyboard_ungrab(GDK_CURRENT_TIME);
37         gdk_pointer_ungrab(GDK_CURRENT_TIME);
38
39         gtk_widget_destroy(ted->window);
40
41         g_free(ted->old_name);
42         g_free(ted->new_name);
43         gtk_tree_path_free(ted->path);
44
45         g_free(ted);
46 }
47
48 static void tree_edit_do(TreeEditData *ted)
49 {
50         ted->new_name = g_strdup(gtk_entry_get_text(GTK_ENTRY(ted->entry)));
51
52         if (strcmp(ted->new_name, ted->old_name) != 0)
53                 {
54                 if (ted->edit_func)
55                         {
56                         if (ted->edit_func(ted, ted->old_name, ted->new_name, ted->edit_data))
57                                 {
58                                 /* hmm, should the caller be required to set text instead ? */
59                                 }
60                         }
61                 }
62 }
63
64 static gint tree_edit_click_end_cb(GtkWidget *widget, GdkEventButton *event, gpointer data)
65 {
66         TreeEditData *ted = data;
67
68         tree_edit_do(ted);
69         tree_edit_close(ted);
70
71         return TRUE;
72 }
73
74 static gint tree_edit_click_cb(GtkWidget *widget, GdkEventButton *event, gpointer data)
75 {
76         TreeEditData *ted = data;
77
78         gint x, y;
79         gint w, h;
80
81         gint xr, yr;
82
83         xr = (gint)event->x_root;
84         yr = (gint)event->y_root;
85
86         gdk_window_get_origin(ted->window->window, &x, &y);
87         gdk_drawable_get_size(ted->window->window, &w, &h);
88
89         if (xr < x || yr < y || xr > x + w || yr > y + h)
90                 {
91                 /* gobble the release event, so it does not propgate to an underlying widget */
92                 g_signal_connect(G_OBJECT(ted->window), "button_release_event",
93                                  G_CALLBACK(tree_edit_click_end_cb), ted);
94                 return TRUE;
95                 }
96         return FALSE;
97 }
98
99 static gint tree_edit_key_press_cb(GtkWidget *widget, GdkEventKey *event, gpointer data)
100 {
101         TreeEditData *ted = data;
102
103         switch (event->keyval)
104                 {
105                 case GDK_Return:
106                 case GDK_KP_Enter:
107                 case GDK_Tab:           /* ok, we are going to intercept the focus change
108                                            from keyboard and act like return was hit */
109                 case GDK_ISO_Left_Tab:
110                 case GDK_Up:
111                 case GDK_Down:
112                 case GDK_KP_Up:
113                 case GDK_KP_Down:
114                 case GDK_KP_Left:
115                 case GDK_KP_Right:
116                         tree_edit_do(ted);
117                         tree_edit_close(ted);
118                         break;
119                 case GDK_Escape:
120                         tree_edit_close(ted);
121                         break;
122                 default:
123                         break;
124                 }
125
126         return FALSE;
127 }
128
129 static gboolean tree_edit_by_path_idle_cb(gpointer data)
130 {
131         TreeEditData *ted = data;
132         GdkRectangle rect;
133         gint x, y, w, h;        /* geometry of cell within tree */
134         gint wx, wy;            /* geometry of tree from root window */
135         gint sx, sw;
136
137         gtk_tree_view_get_cell_area(ted->tree, ted->path, ted->column, &rect);
138
139         x = rect.x;
140         y = rect.y;
141         w = rect.width + 4;
142         h = rect.height + 4;
143
144         if (gtk_tree_view_column_cell_get_position(ted->column, ted->cell, &sx, &sw))
145                 {
146                 x += sx;
147                 w = MAX(w - sx, sw);
148                 }
149
150         gdk_window_get_origin(gtk_tree_view_get_bin_window(ted->tree), &wx, &wy);
151
152         x += wx - 2; /* the -val is to 'fix' alignment of entry position */
153         y += wy - 2;
154
155         /* now show it */
156         gtk_widget_set_size_request(ted->window, w, h);
157         gtk_widget_realize(ted->window);
158         gtk_window_move(GTK_WINDOW(ted->window), x, y);
159         gtk_window_resize(GTK_WINDOW(ted->window), w, h);
160         gtk_widget_show(ted->window);
161
162         /* grab it */
163         gtk_widget_grab_focus(ted->entry);
164         /* explicitely set the focus flag for the entry, for some reason on popup windows this
165          * is not set, and causes no edit cursor to appear ( popups not allowed focus? )
166          */
167         GTK_WIDGET_SET_FLAGS(ted->entry, GTK_HAS_FOCUS);
168         gtk_grab_add(ted->window);
169         gdk_pointer_grab(ted->window->window, TRUE,
170                          GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK | GDK_BUTTON_MOTION_MASK,
171                          NULL, NULL, GDK_CURRENT_TIME);
172         gdk_keyboard_grab(ted->window->window, TRUE, GDK_CURRENT_TIME);
173
174         return FALSE;
175 }
176
177 gint tree_edit_by_path(GtkTreeView *tree, GtkTreePath *tpath, gint column, const gchar *text,
178                        gint (*edit_func)(TreeEditData *, const gchar *, const gchar *, gpointer), gpointer data)
179 {
180         TreeEditData *ted;
181         GtkTreeViewColumn *tcolumn;
182         GtkCellRenderer *cell = NULL;
183         GList *list;
184         GList *work;
185
186         if (!edit_func) return FALSE;
187         if (!GTK_WIDGET_VISIBLE(tree)) return FALSE;
188
189         tcolumn = gtk_tree_view_get_column(tree, column);
190         if (!tcolumn) return FALSE;
191
192         list = gtk_tree_view_column_get_cell_renderers(tcolumn);
193         work = list;
194         while (work && !cell)
195                 {
196                 cell = work->data;
197                 if (!GTK_IS_CELL_RENDERER_TEXT(cell))
198                         {
199                         cell = NULL;
200                         }
201                 work = work->next;
202                 }
203
204         g_list_free(list);
205         if (!cell) return FALSE;
206
207         if (!text) text = "";
208
209         ted = g_new0(TreeEditData, 1);
210
211         ted->old_name = g_strdup(text);
212         ted->new_name = NULL;
213
214         ted->edit_func = edit_func;
215         ted->edit_data = data;
216
217         ted->tree = tree;
218         ted->path = gtk_tree_path_copy(tpath);
219         ted->column = tcolumn;
220         ted->cell = cell;
221
222         gtk_tree_view_scroll_to_cell(ted->tree, ted->path, ted->column, FALSE, 0.0, 0.0);
223
224         /* create the window */
225
226         ted->window = gtk_window_new(GTK_WINDOW_POPUP);
227         gtk_window_set_resizable(GTK_WINDOW(ted->window), FALSE);
228         g_signal_connect(G_OBJECT(ted->window), "button_press_event",
229                          G_CALLBACK(tree_edit_click_cb), ted);
230         g_signal_connect(G_OBJECT(ted->window), "key_press_event",
231                          G_CALLBACK(tree_edit_key_press_cb), ted);
232
233         ted->entry = gtk_entry_new();
234         gtk_entry_set_text(GTK_ENTRY(ted->entry), ted->old_name);
235         gtk_editable_select_region(GTK_EDITABLE(ted->entry), 0, strlen(ted->old_name));
236         gtk_container_add(GTK_CONTAINER(ted->window), ted->entry);
237         gtk_widget_show(ted->entry);
238
239         /* due to the fact that gtktreeview scrolls in an idle loop, we cannot
240          * reliably get the cell position until those scroll priority signals are processed
241          */
242         g_idle_add_full(G_PRIORITY_DEFAULT_IDLE - 2, tree_edit_by_path_idle_cb, ted, NULL);
243
244         return TRUE;
245 }
246
247 /*
248  *-------------------------------------------------------------------
249  * tree cell position retrieval
250  *-------------------------------------------------------------------
251  */
252
253 gint tree_view_get_cell_origin(GtkTreeView *widget, GtkTreePath *tpath, gint column, gint text_cell_only,
254                                gint *x, gint *y, gint *width, gint *height)
255 {
256         gint x_origin, y_origin;
257         gint x_offset, y_offset;
258         gint header_size;
259         GtkTreeViewColumn *tv_column;
260         GdkRectangle rect;
261
262         tv_column = gtk_tree_view_get_column(widget, column);
263         if (!tv_column || !tpath) return FALSE;
264
265         /* hmm, appears the rect will not account for X scroll, but does for Y scroll
266          * use x_offset instead for X scroll (sigh)
267          */
268         gtk_tree_view_get_cell_area(widget, tpath, tv_column, &rect);
269 #if GTK_CHECK_VERSION(2,12,0)
270         gtk_tree_view_convert_tree_to_widget_coords(widget, 0, 0, &x_offset, &y_offset);
271 #else
272         gtk_tree_view_tree_to_widget_coords(widget, 0, 0, &x_offset, &y_offset);
273 #endif
274         gdk_window_get_origin(GTK_WIDGET(widget)->window, &x_origin, &y_origin);
275
276         if (gtk_tree_view_get_headers_visible(widget))
277                 {
278                 header_size = tv_column->button->allocation.height;
279                 }
280         else
281                 {
282                 header_size = 0;
283                 }
284
285         if (text_cell_only)
286                 {
287                 GtkCellRenderer *cell = NULL;
288                 GList *renderers;
289                 GList *work;
290                 gint cell_x;
291                 gint cell_width;
292
293                 renderers = gtk_tree_view_column_get_cell_renderers(tv_column);
294                 work = renderers;
295                 while (work && !cell)
296                         {
297                         cell = work->data;
298                         work = work->next;
299                         if (!GTK_IS_CELL_RENDERER_TEXT(cell)) cell = NULL;
300                         }
301                 g_list_free(renderers);
302
303                 if (!cell) return FALSE;
304
305                 if (!gtk_tree_view_column_cell_get_position(tv_column, cell, &cell_x, &cell_width))
306                         {
307                         cell_x = 0;
308                         cell_width = rect.width;
309                         }
310                 *x = x_origin + x_offset + rect.x + cell_x;
311                 *width = cell_width;
312                 }
313         else
314                 {
315                 *x = x_origin + x_offset + rect.x;
316                 *width = rect.width;
317                 }
318         *y = y_origin + rect.y + header_size;
319         *height = rect.height;
320         return TRUE;
321 }
322
323 void tree_view_get_cell_clamped(GtkTreeView *widget, GtkTreePath *tpath, gint column, gint text_cell_only,
324                                 gint *x, gint *y, gint *width, gint *height)
325 {
326         gint wx, wy, ww, wh;
327         GdkWindow *window;
328
329         window = GTK_WIDGET(widget)->window;
330         gdk_window_get_origin(window, &wx, &wy);
331         gdk_drawable_get_size(window, &ww, &wh);
332         if (!tree_view_get_cell_origin(widget, tpath, column, text_cell_only, x,  y, width, height))
333                 {
334                 *x = wx;
335                 *y = wy;
336                 *width = ww;
337                 *height = wh;
338                 return;
339                 }
340
341         *width = MIN(*width, ww);
342         *x = CLAMP(*x, wx, wx + ww - (*width));
343         *y = CLAMP(*y, wy, wy + wh);
344         *height = MIN(*height, wy + wh - (*y));
345 }
346
347 gint tree_view_row_get_visibility(GtkTreeView *widget, GtkTreeIter *iter, gint fully_visible)
348 {
349         GtkTreeModel *store;
350         GtkTreePath *tpath;
351         gint cx, cy;
352
353         GdkRectangle vrect;
354         GdkRectangle crect;
355
356         if (!GTK_WIDGET_REALIZED(GTK_WIDGET(widget))) return -1; /* we will most probably scroll down, needed for tree_view_row_make_visible */
357
358         store = gtk_tree_view_get_model(widget);
359         tpath = gtk_tree_model_get_path(store, iter);
360
361         gtk_tree_view_get_visible_rect(widget, &vrect);
362         gtk_tree_view_get_cell_area(widget, tpath, NULL, &crect);
363         gtk_tree_path_free(tpath);
364
365
366 #if GTK_CHECK_VERSION(2,12,0)
367         gtk_tree_view_convert_widget_to_tree_coords(widget, crect.x, crect.y, &cx, &cy);
368 #else
369         gtk_tree_view_widget_to_tree_coords(widget, crect.x, crect.y, &cx, &cy);
370 #endif
371
372         if (fully_visible)
373                 {
374                 if (cy < vrect.y) return -1;
375                 if (cy + crect.height > vrect.y + vrect.height) return 1;
376                 return 0;
377                 }
378
379         if (cy + crect.height < vrect.y) return -1;
380         if (cy > vrect.y + vrect.height) return 1;
381         return 0;
382 }
383
384 gint tree_view_row_make_visible(GtkTreeView *widget, GtkTreeIter *iter, gint center)
385 {
386         GtkTreePath *tpath;
387         gint vis;
388
389         vis = tree_view_row_get_visibility(widget, iter, TRUE);
390
391         tpath = gtk_tree_model_get_path(gtk_tree_view_get_model(widget), iter);
392         if (center && vis != 0)
393                 {
394                 gtk_tree_view_scroll_to_cell(widget, tpath, NULL, TRUE, 0.5, 0.0);
395                 }
396         else if (vis < 0)
397                 {
398                 gtk_tree_view_scroll_to_cell(widget, tpath, NULL, TRUE, 0.0, 0.0);
399                 }
400         else if (vis > 0)
401                 {
402                 gtk_tree_view_scroll_to_cell(widget, tpath, NULL, TRUE, 1.0, 0.0);
403                 }
404         gtk_tree_path_free(tpath);
405
406         return vis;
407 }
408
409 gint tree_view_move_cursor_away(GtkTreeView *widget, GtkTreeIter *iter, gint only_selected)
410 {
411         GtkTreeModel *store;
412         GtkTreePath *tpath;
413         GtkTreePath *fpath;
414         gint move = FALSE;
415
416         if (!iter) return FALSE;
417
418         store = gtk_tree_view_get_model(widget);
419         tpath = gtk_tree_model_get_path(store, iter);
420         gtk_tree_view_get_cursor(widget, &fpath, NULL);
421
422         if (fpath && gtk_tree_path_compare(tpath, fpath) == 0)
423                 {
424                 GtkTreeSelection *selection;
425
426                 selection = gtk_tree_view_get_selection(widget);
427
428                 if (!only_selected ||
429                     gtk_tree_selection_path_is_selected(selection, tpath))
430                         {
431                         GtkTreeIter current;
432
433                         current = *iter;
434                         if (gtk_tree_model_iter_next(store, &current))
435                                 {
436                                 gtk_tree_path_next(tpath);
437                                 move = TRUE;
438                                 }
439                         else if (gtk_tree_path_prev(tpath) &&
440                                  gtk_tree_model_get_iter(store, &current, tpath))
441                                 {
442                                 move = TRUE;
443                                 }
444
445                         if (move)
446                                 {
447                                 gtk_tree_view_set_cursor(widget, tpath, NULL, FALSE);
448                                 }
449                         }
450                 }
451
452         gtk_tree_path_free(tpath);
453         if (fpath) gtk_tree_path_free(fpath);
454
455         return move;
456 }
457
458 gint tree_path_to_row(GtkTreePath *tpath)
459 {
460         gint *indices;
461
462         indices = gtk_tree_path_get_indices(tpath);
463         if (indices) return indices[0];
464
465         return -1;
466 }
467
468
469 /*
470  *-------------------------------------------------------------------
471  * color utilities
472  *-------------------------------------------------------------------
473  */
474
475 void shift_color(GdkColor *src, gshort val, gint direction)
476 {
477         gshort cs;
478
479         if (val == -1)
480                 {
481                 val = STYLE_SHIFT_STANDARD;
482                 }
483         else
484                 {
485                 val = CLAMP(val, 1, 100);
486                 }
487         cs = 0xffff / 100 * val;
488
489         /* up or down ? */
490         if (direction < 0 ||
491             (direction == 0 &&((gint)src->red + (gint)src->green + (gint)src->blue) / 3 > 0xffff / 2))
492                 {
493                 src->red = MAX(0 , src->red - cs);
494                 src->green = MAX(0 , src->green - cs);
495                 src->blue = MAX(0 , src->blue - cs);
496                 }
497         else
498                 {
499                 src->red = MIN(0xffff, src->red + cs);
500                 src->green = MIN(0xffff, src->green + cs);
501                 src->blue = MIN(0xffff, src->blue + cs);
502                 }
503 }
504
505 /* darkens or lightens a style's color for given state
506  * esp. useful for alternating dark/light in (c)lists
507  */
508 void style_shift_color(GtkStyle *style, GtkStateType type, gshort shift_value, gint direction)
509 {
510         if (!style) return;
511
512         shift_color(&style->base[type], shift_value, direction);
513         shift_color(&style->bg[type], shift_value, direction);
514 }
515
516 /*
517  *-------------------------------------------------------------------
518  * auto scroll by mouse position
519  *-------------------------------------------------------------------
520  */
521
522 #define AUTO_SCROLL_DEFAULT_SPEED 100
523 #define AUTO_SCROLL_DEFAULT_REGION 20
524
525 typedef struct _AutoScrollData AutoScrollData;
526 struct _AutoScrollData
527 {
528         gint timer_id;
529         gint region_size;
530         GtkWidget *widget;
531         GtkAdjustment *adj;
532         gint max_step;
533
534         gint (*notify_func)(GtkWidget *, gint, gint, gpointer);
535         gpointer notify_data;
536 };
537
538 void widget_auto_scroll_stop(GtkWidget *widget)
539 {
540         AutoScrollData *sd;
541
542         sd = g_object_get_data(G_OBJECT(widget), "autoscroll");
543         if (!sd) return;
544         g_object_set_data(G_OBJECT(widget), "autoscroll", NULL);
545
546         if (sd->timer_id != -1) g_source_remove(sd->timer_id);
547         g_free(sd);
548 }
549
550 static gint widget_auto_scroll_cb(gpointer data)
551 {
552         AutoScrollData *sd = data;
553         GdkWindow *window;
554         gint x, y;
555         gint w, h;
556         gint amt = 0;
557
558         if (sd->max_step < sd->region_size)
559                 {
560                 sd->max_step = MIN(sd->region_size, sd->max_step + 2);
561                 }
562
563         window = sd->widget->window;
564         gdk_window_get_pointer(window, &x, &y, NULL);
565         gdk_drawable_get_size(window, &w, &h);
566
567         if (x < 0 || x >= w || y < 0 || y >= h)
568                 {
569                 sd->timer_id = -1;
570                 widget_auto_scroll_stop(sd->widget);
571                 return FALSE;
572                 }
573
574         if (h < sd->region_size * 3)
575                 {
576                 /* height is cramped, nicely divide into three equal regions */
577                 if (y < h / 3 || y > h / 3 * 2)
578                         {
579                         amt = (y < h / 2) ? 0 - ((h / 2) - y) : y - (h / 2);
580                         }
581                 }
582         else if (y < sd->region_size)
583                 {
584                 amt = 0 - (sd->region_size - y);
585                 }
586         else if (y >= h - sd->region_size)
587                 {
588                 amt = y - (h - sd->region_size);
589                 }
590
591         if (amt != 0)
592                 {
593                 amt = CLAMP(amt, 0 - sd->max_step, sd->max_step);
594
595                 if (sd->adj->value != CLAMP(sd->adj->value + amt, sd->adj->lower, sd->adj->upper - sd->adj->page_size))
596                         {
597                         /* only notify when scrolling is needed */
598                         if (sd->notify_func && !sd->notify_func(sd->widget, x, y, sd->notify_data))
599                                 {
600                                 sd->timer_id = -1;
601                                 widget_auto_scroll_stop(sd->widget);
602                                 return FALSE;
603                                 }
604
605                         gtk_adjustment_set_value(sd->adj,
606                                 CLAMP(sd->adj->value + amt, sd->adj->lower, sd->adj->upper - sd->adj->page_size));
607                         }
608                 }
609
610         return TRUE;
611 }
612
613 gint widget_auto_scroll_start(GtkWidget *widget, GtkAdjustment *v_adj, gint scroll_speed, gint region_size,
614                               gint (*notify_func)(GtkWidget *widget, gint x, gint y, gpointer data), gpointer notify_data)
615 {
616         AutoScrollData *sd;
617
618         if (!widget || !v_adj) return 0;
619         if (g_object_get_data(G_OBJECT(widget), "autoscroll")) return 0;
620         if (scroll_speed < 1) scroll_speed = AUTO_SCROLL_DEFAULT_SPEED;
621         if (region_size < 1) region_size = AUTO_SCROLL_DEFAULT_REGION;
622
623         sd = g_new0(AutoScrollData, 1);
624         sd->widget = widget;
625         sd->adj = v_adj;
626         sd->region_size = region_size;
627         sd->max_step = 1;
628         sd->timer_id = g_timeout_add(scroll_speed, widget_auto_scroll_cb, sd);
629
630         sd->notify_func = notify_func;
631         sd->notify_data = notify_data;
632
633         g_object_set_data(G_OBJECT(widget), "autoscroll", sd);
634
635         return scroll_speed;
636 }
637
638
639 /*
640  *-------------------------------------------------------------------
641  * GList utils
642  *-------------------------------------------------------------------
643  */
644
645 GList *uig_list_insert_link(GList *list, GList *link, gpointer data)
646 {
647         GList *new_list;
648
649         if (!list || link == list) return g_list_prepend(list, data);
650         if (!link) return g_list_append(list, data);
651
652         new_list = g_list_alloc();
653         new_list->data = data;
654
655         if (link->prev)
656                 {
657                 link->prev->next = new_list;
658                 new_list->prev = link->prev;
659                 }
660         else
661                 {
662                 list = new_list;
663                 }
664         link->prev = new_list;
665         new_list->next = link;
666
667         return list;
668 }
669
670 GList *uig_list_insert_list(GList *parent, GList *insert_link, GList *list)
671 {
672         GList *end;
673
674         if (!insert_link) return g_list_concat(parent, list);
675         if (insert_link == parent) return g_list_concat(list, parent);
676         if (!parent) return list;
677         if (!list) return parent;
678
679         end  = g_list_last(list);
680
681         if (insert_link->prev) insert_link->prev->next = list;
682         list->prev = insert_link->prev;
683         insert_link->prev = end;
684         end->next = insert_link;
685
686         return parent;
687 }
688 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */