src/ui-tree-edit.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 UI_TREE_EDIT_H
  23 #define UI_TREE_EDIT_H
  24
  25
  26 struct TreeEditData
  27 {
  28         GtkWidget *window;
  29         GtkWidget *entry;
  30
  31         gchar *old_name;
  32         gchar *new_name;
  33
  34         gint (*edit_func)(TreeEditData *ted, const gchar *oldname, const gchar *newname, gpointer data);
  35         gpointer edit_data;
  36
  37         GtkTreeView *tree;
  38         GtkTreePath *path;
  39         GtkTreeViewColumn *column;
  40         GtkCellRenderer *cell;
  41 };
  42
  43
  44 /**
  45  * @headerfile  tree_edit_by_path
  46  * edit_func: return TRUE if rename successful, FALSE on failure.
  47  */
  48 gboolean tree_edit_by_path(GtkTreeView *tree, GtkTreePath *tpath, gint column, const gchar *text,
  49                            gboolean (*edit_func)(TreeEditData *, const gchar *, const gchar *, gpointer), gpointer data);
  50
  51
  52 /**
  53  * @headerfile tree_view_get_cell_origin
  54  * returns location of cell in screen coordinates
  55  */
  56 gboolean tree_view_get_cell_origin(GtkTreeView *widget, GtkTreePath *tpath, gint column, gboolean text_cell_only,
  57                                    gint *x, gint *y, gint *width, gint *height);
  58
  59 /**
  60  * @headerfile tree_view_get_cell_clamped
  61  * similar to above, but limits the returned area to that of the tree window
  62  */
  63 void tree_view_get_cell_clamped(GtkTreeView *widget, GtkTreePath *tpath, gint column, gboolean text_cell_only,
  64                                gint *x, gint *y, gint *width, gint *height);
  65
  66 /**
  67  * @headerfile tree_view_row_get_visibility
  68  * return 0 = row visible, -1 = row is above, 1 = row is below visible region \n
  69  * if fully_visible is TRUE, the behavior changes to return -1/1 if _any_ part of the cell is out of view
  70  */
  71 gint tree_view_row_get_visibility(GtkTreeView *widget, GtkTreeIter *iter, gboolean fully_visible);
  72
  73 /**
  74  * @headerfile tree_view_row_make_visible
  75  * scrolls to make row visible, if necessary
  76  * return is same as above (before the scroll)
  77  */
  78 gint tree_view_row_make_visible(GtkTreeView *widget, GtkTreeIter *iter, gboolean center);
  79
  80 /**
  81  * @headerfile tree_view_move_cursor_away
  82  * if iter is location of cursor, moves cursor to nearest row
  83  */
  84 gboolean tree_view_move_cursor_away(GtkTreeView *widget, GtkTreeIter *iter, gboolean only_selected);
  85
  86 /**
  87  * @headerfile shift_color
  88  * shifts a GdkRGBA values lighter or darker \n
  89  * val is percent from 1 to 100, or -1 for default (usually 10%) \n
  90  * direction is -1 darker, 0 auto, 1 lighter
  91  */
  92 void shift_color(GdkRGBA *src, gshort val, gint direction);
  93
  94 /**
  95  * @def STYLE_SHIFT_STANDARD
  96  * The standard shift percent for alternating list row colors
  97  */
  98 #define STYLE_SHIFT_STANDARD 10
  99
 100 /**
 101  * @headerfile widget_auto_scroll_start
 102  * auto scroll, set scroll_speed or region_size to -1 to their respective the defaults
 103  * notify_func will be called before a scroll, return FALSE to turn off autoscroll
 104  */
 105 gint widget_auto_scroll_start(GtkWidget *widget, GtkAdjustment *v_adj, gint scroll_speed, gint region_size,
 106                               gint (*notify_func)(GtkWidget *widget, gint x, gint y, gpointer data), gpointer notify_data);
 107 void widget_auto_scroll_stop(GtkWidget *widget);
 108
 109
 110 /*
 111  * Various g_list utils, do not really fit anywhere, so they are here.
 112  */
 113 GList *uig_list_insert_link(GList *list, GList *link, gpointer data);
 114 GList *uig_list_insert_list(GList *parent, GList *insert_link, GList *list);
 115
 116
 117 #endif
 118 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */