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         gtk_tree_view_tree_to_widget_coords(widget, 0, 0, &x_offset, &y_offset);
 270         gdk_window_get_origin(GTK_WIDGET(widget)->window, &x_origin, &y_origin);
 271
 272         if (gtk_tree_view_get_headers_visible(widget))
 273                 {
 274                 header_size = tv_column->button->allocation.height;
 275                 }
 276         else
 277                 {
 278                 header_size = 0;
 279                 }
 280
 281         if (text_cell_only)
 282                 {
 283                 GtkCellRenderer *cell = NULL;
 284                 GList *renderers;
 285                 GList *work;
 286                 gint cell_x;
 287                 gint cell_width;
 288
 289                 renderers = gtk_tree_view_column_get_cell_renderers(tv_column);
 290                 work = renderers;
 291                 while (work && !cell)
 292                         {
 293                         cell = work->data;
 294                         work = work->next;
 295                         if (!GTK_IS_CELL_RENDERER_TEXT(cell)) cell = NULL;
 296                         }
 297                 g_list_free(renderers);
 298
 299                 if (!cell) return FALSE;
 300
 301                 if (!gtk_tree_view_column_cell_get_position(tv_column, cell, &cell_x, &cell_width))
 302                         {
 303                         cell_x = 0;
 304                         cell_width = rect.width;
 305                         }
 306                 *x = x_origin + x_offset + rect.x + cell_x;
 307                 *width = cell_width;
 308                 }
 309         else
 310                 {
 311                 *x = x_origin + x_offset + rect.x;
 312                 *width = rect.width;
 313                 }
 314         *y = y_origin + rect.y + header_size;
 315         *height = rect.height;
 316         return TRUE;
 317 }
 318
 319 void tree_view_get_cell_clamped(GtkTreeView *widget, GtkTreePath *tpath, gint column, gint text_cell_only,
 320                                 gint *x, gint *y, gint *width, gint *height)
 321 {
 322         gint wx, wy, ww, wh;
 323         GdkWindow *window;
 324
 325         window = GTK_WIDGET(widget)->window;
 326         gdk_window_get_origin(window, &wx, &wy);
 327         gdk_drawable_get_size(window, &ww, &wh);
 328         if (!tree_view_get_cell_origin(widget, tpath, column, text_cell_only, x,  y, width, height))
 329                 {
 330                 *x = wx;
 331                 *y = wy;
 332                 *width = ww;
 333                 *height = wh;
 334                 return;
 335                 }
 336
 337         *width = MIN(*width, ww);
 338         *x = CLAMP(*x, wx, wx + ww - (*width));
 339         *y = CLAMP(*y, wy, wy + wh);
 340         *height = MIN(*height, wy + wh - (*y));
 341 }
 342
 343 gint tree_view_row_get_visibility(GtkTreeView *widget, GtkTreeIter *iter, gint fully_visible)
 344 {
 345         GtkTreeModel *store;
 346         GtkTreePath *tpath;
 347         gint cx, cy;
 348
 349         GdkRectangle vrect;
 350         GdkRectangle crect;
 351
 352         if (!GTK_WIDGET_REALIZED(GTK_WIDGET(widget))) return 0;
 353
 354         store = gtk_tree_view_get_model(widget);
 355         tpath = gtk_tree_model_get_path(store, iter);
 356
 357         gtk_tree_view_get_visible_rect(widget, &vrect);
 358         gtk_tree_view_get_cell_area(widget, tpath, NULL, &crect);
 359         gtk_tree_path_free(tpath);
 360
 361         gtk_tree_view_widget_to_tree_coords(widget, crect.x, crect.y, &cx, &cy);
 362
 363         if (fully_visible)
 364                 {
 365                 if (cy < vrect.y) return -1;
 366                 if (cy + crect.height > vrect.y + vrect.height) return 1;
 367                 return 0;
 368                 }
 369
 370         if (cy + crect.height < vrect.y) return -1;
 371         if (cy > vrect.y + vrect.height) return 1;
 372         return 0;
 373 }
 374
 375 gint tree_view_row_make_visible(GtkTreeView *widget, GtkTreeIter *iter, gint center)
 376 {
 377         GtkTreePath *tpath;
 378         gint vis;
 379
 380         vis = tree_view_row_get_visibility(widget, iter, TRUE);
 381
 382         tpath = gtk_tree_model_get_path(gtk_tree_view_get_model(widget), iter);
 383         if (center && vis != 0)
 384                 {
 385                 gtk_tree_view_scroll_to_cell(widget, tpath, NULL, TRUE, 0.5, 0.0);
 386                 }
 387         else if (vis < 0)
 388                 {
 389                 gtk_tree_view_scroll_to_cell(widget, tpath, NULL, TRUE, 0.0, 0.0);
 390                 }
 391         else if (vis > 0)
 392                 {
 393                 gtk_tree_view_scroll_to_cell(widget, tpath, NULL, TRUE, 1.0, 0.0);
 394                 }
 395         gtk_tree_path_free(tpath);
 396
 397         return vis;
 398 }
 399
 400 gint tree_view_move_cursor_away(GtkTreeView *widget, GtkTreeIter *iter, gint only_selected)
 401 {
 402         GtkTreeModel *store;
 403         GtkTreePath *tpath;
 404         GtkTreePath *fpath;
 405         gint move = FALSE;
 406
 407         if (!iter) return FALSE;
 408
 409         store = gtk_tree_view_get_model(widget);
 410         tpath = gtk_tree_model_get_path(store, iter);
 411         gtk_tree_view_get_cursor(widget, &fpath, NULL);
 412
 413         if (fpath && gtk_tree_path_compare(tpath, fpath) == 0)
 414                 {
 415                 GtkTreeSelection *selection;
 416
 417                 selection = gtk_tree_view_get_selection(widget);
 418
 419                 if (!only_selected ||
 420                     gtk_tree_selection_path_is_selected(selection, tpath))
 421                         {
 422                         GtkTreeIter current;
 423
 424                         current = *iter;
 425                         if (gtk_tree_model_iter_next(store, &current))
 426                                 {
 427                                 gtk_tree_path_next(tpath);
 428                                 move = TRUE;
 429                                 }
 430                         else if (gtk_tree_path_prev(tpath) &&
 431                                  gtk_tree_model_get_iter(store, &current, tpath))
 432                                 {
 433                                 move = TRUE;
 434                                 }
 435
 436                         if (move)
 437                                 {
 438                                 gtk_tree_view_set_cursor(widget, tpath, NULL, FALSE);
 439                                 }
 440                         }
 441                 }
 442
 443         gtk_tree_path_free(tpath);
 444         if (fpath) gtk_tree_path_free(fpath);
 445
 446         return move;
 447 }
 448
 449 gint tree_path_to_row(GtkTreePath *tpath)
 450 {
 451         gint *indices;
 452
 453         indices = gtk_tree_path_get_indices(tpath);
 454         if (indices) return indices[0];
 455
 456         return -1;
 457 }
 458
 459
 460 /*
 461  *-------------------------------------------------------------------
 462  * color utilities
 463  *-------------------------------------------------------------------
 464  */
 465
 466 void shift_color(GdkColor *src, gshort val, gint direction)
 467 {
 468         gshort cs;
 469
 470         if (val == -1)
 471                 {
 472                 val = STYLE_SHIFT_STANDARD;
 473                 }
 474         else
 475                 {
 476                 val = CLAMP(val, 1, 100);
 477                 }
 478         cs = 0xffff / 100 * val;
 479
 480         /* up or down ? */
 481         if (direction < 0 ||
 482             (direction == 0 &&((gint)src->red + (gint)src->green + (gint)src->blue) / 3 > 0xffff / 2))
 483                 {
 484                 src->red = MAX(0 , src->red - cs);
 485                 src->green = MAX(0 , src->green - cs);
 486                 src->blue = MAX(0 , src->blue - cs);
 487                 }
 488         else
 489                 {
 490                 src->red = MIN(0xffff, src->red + cs);
 491                 src->green = MIN(0xffff, src->green + cs);
 492                 src->blue = MIN(0xffff, src->blue + cs);
 493                 }
 494 }
 495
 496 /* darkens or lightens a style's color for given state
 497  * esp. useful for alternating dark/light in (c)lists
 498  */
 499 void style_shift_color(GtkStyle *style, GtkStateType type, gshort shift_value, gint direction)
 500 {
 501         if (!style) return;
 502
 503         shift_color(&style->base[type], shift_value, direction);
 504         shift_color(&style->bg[type], shift_value, direction);
 505 }
 506
 507 /*
 508  *-------------------------------------------------------------------
 509  * auto scroll by mouse position
 510  *-------------------------------------------------------------------
 511  */
 512
 513 #define AUTO_SCROLL_DEFAULT_SPEED 100
 514 #define AUTO_SCROLL_DEFAULT_REGION 20
 515
 516 typedef struct _AutoScrollData AutoScrollData;
 517 struct _AutoScrollData
 518 {
 519         gint timer_id;
 520         gint region_size;
 521         GtkWidget *widget;
 522         GtkAdjustment *adj;
 523         gint max_step;
 524
 525         gint (*notify_func)(GtkWidget *, gint, gint, gpointer);
 526         gpointer notify_data;
 527 };
 528
 529 void widget_auto_scroll_stop(GtkWidget *widget)
 530 {
 531         AutoScrollData *sd;
 532
 533         sd = g_object_get_data(G_OBJECT(widget), "autoscroll");
 534         if (!sd) return;
 535         g_object_set_data(G_OBJECT(widget), "autoscroll", NULL);
 536
 537         if (sd->timer_id != -1) g_source_remove(sd->timer_id);
 538         g_free(sd);
 539 }
 540
 541 static gint widget_auto_scroll_cb(gpointer data)
 542 {
 543         AutoScrollData *sd = data;
 544         GdkWindow *window;
 545         gint x, y;
 546         gint w, h;
 547         gint amt = 0;
 548
 549         if (sd->max_step < sd->region_size)
 550                 {
 551                 sd->max_step = MIN(sd->region_size, sd->max_step + 2);
 552                 }
 553
 554         window = sd->widget->window;
 555         gdk_window_get_pointer(window, &x, &y, NULL);
 556         gdk_drawable_get_size(window, &w, &h);
 557
 558         if (x < 0 || x >= w || y < 0 || y >= h)
 559                 {
 560                 sd->timer_id = -1;
 561                 widget_auto_scroll_stop(sd->widget);
 562                 return FALSE;
 563                 }
 564
 565         if (h < sd->region_size * 3)
 566                 {
 567                 /* height is cramped, nicely divide into three equal regions */
 568                 if (y < h / 3 || y > h / 3 * 2)
 569                         {
 570                         amt = (y < h / 2) ? 0 - ((h / 2) - y) : y - (h / 2);
 571                         }
 572                 }
 573         else if (y < sd->region_size)
 574                 {
 575                 amt = 0 - (sd->region_size - y);
 576                 }
 577         else if (y >= h - sd->region_size)
 578                 {
 579                 amt = y - (h - sd->region_size);
 580                 }
 581
 582         if (amt != 0)
 583                 {
 584                 amt = CLAMP(amt, 0 - sd->max_step, sd->max_step);
 585
 586                 if (sd->adj->value != CLAMP(sd->adj->value + amt, sd->adj->lower, sd->adj->upper - sd->adj->page_size))
 587                         {
 588                         /* only notify when scrolling is needed */
 589                         if (sd->notify_func && !sd->notify_func(sd->widget, x, y, sd->notify_data))
 590                                 {
 591                                 sd->timer_id = -1;
 592                                 widget_auto_scroll_stop(sd->widget);
 593                                 return FALSE;
 594                                 }
 595
 596                         gtk_adjustment_set_value(sd->adj,
 597                                 CLAMP(sd->adj->value + amt, sd->adj->lower, sd->adj->upper - sd->adj->page_size));
 598                         }
 599                 }
 600
 601         return TRUE;
 602 }
 603
 604 gint widget_auto_scroll_start(GtkWidget *widget, GtkAdjustment *v_adj, gint scroll_speed, gint region_size,
 605                               gint (*notify_func)(GtkWidget *widget, gint x, gint y, gpointer data), gpointer notify_data)
 606 {
 607         AutoScrollData *sd;
 608
 609         if (!widget || !v_adj) return 0;
 610         if (g_object_get_data(G_OBJECT(widget), "autoscroll")) return 0;
 611         if (scroll_speed < 1) scroll_speed = AUTO_SCROLL_DEFAULT_SPEED;
 612         if (region_size < 1) region_size = AUTO_SCROLL_DEFAULT_REGION;
 613
 614         sd = g_new0(AutoScrollData, 1);
 615         sd->widget = widget;
 616         sd->adj = v_adj;
 617         sd->region_size = region_size;
 618         sd->max_step = 1;
 619         sd->timer_id = g_timeout_add(scroll_speed, widget_auto_scroll_cb, sd);
 620
 621         sd->notify_func = notify_func;
 622         sd->notify_data = notify_data;
 623
 624         g_object_set_data(G_OBJECT(widget), "autoscroll", sd);
 625
 626         return scroll_speed;
 627 }
 628
 629
 630 /*
 631  *-------------------------------------------------------------------
 632  * GList utils
 633  *-------------------------------------------------------------------
 634  */
 635
 636 GList *uig_list_insert_link(GList *list, GList *link, gpointer data)
 637 {
 638         GList *new_list;
 639
 640         if (!list || link == list) return g_list_prepend(list, data);
 641         if (!link) return g_list_append(list, data);
 642
 643         new_list = g_list_alloc();
 644         new_list->data = data;
 645
 646         if (link->prev)
 647                 {
 648                 link->prev->next = new_list;
 649                 new_list->prev = link->prev;
 650                 }
 651         else
 652                 {
 653                 list = new_list;
 654                 }
 655         link->prev = new_list;
 656         new_list->next = link;
 657
 658         return list;
 659 }
 660
 661 GList *uig_list_insert_list(GList *parent, GList *insert_link, GList *list)
 662 {
 663         GList *end;
 664
 665         if (!insert_link) return g_list_concat(parent, list);
 666         if (insert_link == parent) return g_list_concat(list, parent);
 667         if (!parent) return list;
 668         if (!list) return parent;
 669
 670         end  = g_list_last(list);
 671
 672         if (insert_link->prev) insert_link->prev->next = list;
 673         list->prev = insert_link->prev;
 674         insert_link->prev = end;
 675         end->next = insert_link;
 676
 677         return parent;
 678 }