Pileus Git - ~andy/gtk/blob - gtk/gtktreeviewcolumn.h

   1 /* gtktreeviewcolumn.h
   2  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __GTK_TREE_VIEW_COLUMN_H__
  21 #define __GTK_TREE_VIEW_COLUMN_H__
  22
  23 #include <gtk/gtkobject.h>
  24 #include <gtk/gtkcellrenderer.h>
  25 #include <gtk/gtktreemodel.h>
  26 #include <gtk/gtktreesortable.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif /* __cplusplus */
  31
  32 #define GTK_TYPE_TREE_VIEW_COLUMN            (gtk_tree_view_column_get_type ())
  33 #define GTK_TREE_VIEW_COLUMN(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumn))
  34 #define GTK_TREE_VIEW_COLUMN_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
  35 #define GTK_IS_TREE_VIEW_COLUMN(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE_VIEW_COLUMN))
  36 #define GTK_IS_TREE_VIEW_COLUMN_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TREE_VIEW_COLUMN))
  37 #define GTK_TREE_VIEW_COLUMN_GET_CLASS(obj)  (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
  38
  39 typedef enum
  40 {
  41   GTK_TREE_VIEW_COLUMN_GROW_ONLY,
  42   GTK_TREE_VIEW_COLUMN_RESIZABLE,
  43   GTK_TREE_VIEW_COLUMN_AUTOSIZE,
  44   GTK_TREE_VIEW_COLUMN_FIXED
  45 } GtkTreeViewColumnSizing;
  46
  47 typedef struct _GtkTreeViewColumn      GtkTreeViewColumn;
  48 typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
  49
  50 typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,
  51                                       GtkCellRenderer   *cell,
  52                                       GtkTreeModel      *tree_model,
  53                                       GtkTreeIter       *iter,
  54                                       gpointer           data);
  55
  56
  57 struct _GtkTreeViewColumn
  58 {
  59   GtkObject parent;
  60
  61   GtkWidget *tree_view;
  62   GtkWidget *button;
  63   GtkWidget *child;
  64   GtkWidget *arrow;
  65   GtkWidget *alignment;
  66   GdkWindow *window;
  67   GtkCellEditable *editable_widget;
  68   gfloat xalign;
  69   guint property_changed_signal;
  70
  71   gint spacing;
  72   gint fixed_width;
  73   gint width;
  74   gint requested_width;
  75   gint min_width;
  76   gint max_width;
  77
  78   /* dragging columns */
  79   gint drag_x;
  80   gint drag_y;
  81
  82   gchar *title;
  83   GList *cell_list;
  84   GtkTreeViewColumnSizing column_type;
  85
  86   /* Sorting */
  87   guint sort_clicked_signal;
  88   guint sort_column_changed_signal;
  89   gint sort_column_id;
  90   GtkSortType sort_order;
  91
  92   /* Flags */
  93   guint visible             : 1;
  94   guint clickable           : 1;
  95   guint dirty               : 1;
  96   guint show_sort_indicator : 1;
  97   guint maybe_reordered     : 1;
  98   guint reorderable         : 1;
  99 };
 100
 101 struct _GtkTreeViewColumnClass
 102 {
 103   GtkObjectClass parent_class;
 104
 105   void (*clicked) (GtkTreeViewColumn *tree_column);
 106 };
 107
 108 GtkType                 gtk_tree_view_column_get_type            (void);
 109 GtkTreeViewColumn      *gtk_tree_view_column_new                 (void);
 110 GtkTreeViewColumn      *gtk_tree_view_column_new_with_attributes (const gchar             *title,
 111                                                                   GtkCellRenderer         *cell,
 112                                                                   ...);
 113 void                    gtk_tree_view_column_pack_start          (GtkTreeViewColumn       *tree_column,
 114                                                                   GtkCellRenderer         *cell,
 115                                                                   gboolean                 expand);
 116 void                    gtk_tree_view_column_pack_end            (GtkTreeViewColumn       *tree_column,
 117                                                                   GtkCellRenderer         *cell,
 118                                                                   gboolean                 expand);
 119 void                    gtk_tree_view_column_clear               (GtkTreeViewColumn       *tree_column);
 120 GList                  *gtk_tree_view_column_get_cell_renderers  (GtkTreeViewColumn       *tree_column);
 121 void                    gtk_tree_view_column_add_attribute       (GtkTreeViewColumn       *tree_column,
 122                                                                   GtkCellRenderer         *cell_renderer,
 123                                                                   const gchar             *attribute,
 124                                                                   gint                     column);
 125 void                    gtk_tree_view_column_set_attributes      (GtkTreeViewColumn       *tree_column,
 126                                                                   GtkCellRenderer         *cell_renderer,
 127                                                                   ...);
 128 void                    gtk_tree_view_column_set_cell_data_func  (GtkTreeViewColumn       *tree_column,
 129                                                                   GtkCellRenderer         *cell_renderer,
 130                                                                   GtkTreeCellDataFunc      func,
 131                                                                   gpointer                 func_data,
 132                                                                   GtkDestroyNotify         destroy);
 133 void                    gtk_tree_view_column_clear_attributes    (GtkTreeViewColumn       *tree_column,
 134                                                                   GtkCellRenderer         *cell_renderer);
 135 void                    gtk_tree_view_column_set_spacing         (GtkTreeViewColumn       *tree_column,
 136                                                                   gint                     spacing);
 137 gint                    gtk_tree_view_column_get_spacing         (GtkTreeViewColumn       *tree_column);
 138 void                    gtk_tree_view_column_set_visible         (GtkTreeViewColumn       *tree_column,
 139                                                                   gboolean                 visible);
 140 gboolean                gtk_tree_view_column_get_visible         (GtkTreeViewColumn       *tree_column);
 141 void                    gtk_tree_view_column_set_sizing          (GtkTreeViewColumn       *tree_column,
 142                                                                   GtkTreeViewColumnSizing  type);
 143 GtkTreeViewColumnSizing gtk_tree_view_column_get_sizing          (GtkTreeViewColumn       *tree_column);
 144 gint                    gtk_tree_view_column_get_width           (GtkTreeViewColumn       *tree_column);
 145 gint                    gtk_tree_view_column_get_fixed_width     (GtkTreeViewColumn       *tree_column);
 146 void                    gtk_tree_view_column_set_fixed_width     (GtkTreeViewColumn       *tree_column,
 147                                                                   gint                     fixed_width);
 148 void                    gtk_tree_view_column_set_min_width       (GtkTreeViewColumn       *tree_column,
 149                                                                   gint                     min_width);
 150 gint                    gtk_tree_view_column_get_min_width       (GtkTreeViewColumn       *tree_column);
 151 void                    gtk_tree_view_column_set_max_width       (GtkTreeViewColumn       *tree_column,
 152                                                                   gint                     max_width);
 153 gint                    gtk_tree_view_column_get_max_width       (GtkTreeViewColumn       *tree_column);
 154 void                    gtk_tree_view_column_clicked             (GtkTreeViewColumn       *tree_column);
 155
 156
 157
 158 /* Options for manipulating the column headers
 159  */
 160 void                    gtk_tree_view_column_set_title           (GtkTreeViewColumn       *tree_column,
 161                                                                   const gchar             *title);
 162 G_CONST_RETURN gchar   *gtk_tree_view_column_get_title           (GtkTreeViewColumn       *tree_column);
 163 void                    gtk_tree_view_column_set_clickable       (GtkTreeViewColumn       *tree_column,
 164                                                                   gboolean                 clickable);
 165 gboolean                gtk_tree_view_column_get_clickable       (GtkTreeViewColumn       *tree_column);
 166 void                    gtk_tree_view_column_set_widget          (GtkTreeViewColumn       *tree_column,
 167                                                                   GtkWidget               *widget);
 168 GtkWidget              *gtk_tree_view_column_get_widget          (GtkTreeViewColumn       *tree_column);
 169 void                    gtk_tree_view_column_set_alignment       (GtkTreeViewColumn       *tree_column,
 170                                                                   gfloat                   xalign);
 171 gfloat                  gtk_tree_view_column_get_alignment       (GtkTreeViewColumn       *tree_column);
 172 void                    gtk_tree_view_column_set_reorderable     (GtkTreeViewColumn       *tree_column,
 173                                                                   gboolean                 reorderable);
 174 gboolean                gtk_tree_view_column_get_reorderable     (GtkTreeViewColumn       *tree_column);
 175
 176
 177
 178 /* You probably only want to use gtk_tree_view_column_set_sort_column_id.  The
 179  * other sorting functions exist primarily to let others do their own custom sorting.
 180  */
 181 void                    gtk_tree_view_column_set_sort_column_id  (GtkTreeViewColumn       *tree_column,
 182                                                                   gint                     sort_column_id);
 183 gint                    gtk_tree_view_column_get_sort_column_id  (GtkTreeViewColumn       *tree_column);
 184 void                    gtk_tree_view_column_set_sort_indicator  (GtkTreeViewColumn       *tree_column,
 185                                                                   gboolean                 setting);
 186 gboolean                gtk_tree_view_column_get_sort_indicator  (GtkTreeViewColumn       *tree_column);
 187 void                    gtk_tree_view_column_set_sort_order      (GtkTreeViewColumn       *tree_column,
 188                                                                   GtkSortType              order);
 189 GtkSortType             gtk_tree_view_column_get_sort_order      (GtkTreeViewColumn       *tree_column);
 190
 191
 192 /* These functions are meant primarily for interaction between the GtkTreeView and the column.
 193  */
 194 void                    gtk_tree_view_column_cell_set_cell_data  (GtkTreeViewColumn       *tree_column,
 195                                                                   GtkTreeModel            *tree_model,
 196                                                                   GtkTreeIter             *iter,
 197                                                                   gboolean                 is_expander,
 198                                                                   gboolean                 is_expanded);
 199 void                    gtk_tree_view_column_cell_get_size       (GtkTreeViewColumn       *tree_column,
 200                                                                   GdkRectangle            *cell_area,
 201                                                                   gint                    *x_offset,
 202                                                                   gint                    *y_offset,
 203                                                                   gint                    *width,
 204                                                                   gint                    *height);
 205 void                    gtk_tree_view_column_cell_render         (GtkTreeViewColumn       *tree_column,
 206                                                                   GdkWindow               *window,
 207                                                                   GdkRectangle            *background_area,
 208                                                                   GdkRectangle            *cell_area,
 209                                                                   GdkRectangle            *expose_area,
 210                                                                   guint                    flags);
 211 gboolean                gtk_tree_view_column_cell_event          (GtkTreeViewColumn       *tree_column,
 212                                                                   GdkEvent                *event,
 213                                                                   gchar                   *path_string,
 214                                                                   GdkRectangle            *background_area,
 215                                                                   GdkRectangle            *cell_area,
 216                                                                   guint                    flags);
 217 gboolean                gtk_tree_view_column_cell_focus          (GtkTreeViewColumn       *tree_column,
 218                                                                   gint                     direction);
 219 void                    gtk_tree_view_column_cell_draw_focus     (GtkTreeViewColumn       *tree_column,
 220                                                                   GdkWindow               *window,
 221                                                                   GdkRectangle            *background_area,
 222                                                                   GdkRectangle            *cell_area,
 223                                                                   GdkRectangle            *expose_area,
 224                                                                   guint                    flags);
 225 gboolean                gtk_tree_view_column_cell_is_visible     (GtkTreeViewColumn       *tree_column);
 226 void                    gtk_tree_view_column_cell_set_dirty      (GtkTreeViewColumn       *tree_column);
 227
 228
 229 #ifdef __cplusplus
 230 }
 231 #endif /* __cplusplus */
 232
 233 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */
 234