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_AUTOSIZE,
  43   GTK_TREE_VIEW_COLUMN_FIXED
  44 } GtkTreeViewColumnSizing;
  45
  46 typedef struct _GtkTreeViewColumn      GtkTreeViewColumn;
  47 typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
  48
  49 typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,
  50                                       GtkCellRenderer   *cell,
  51                                       GtkTreeModel      *tree_model,
  52                                       GtkTreeIter       *iter,
  53                                       gpointer           data);
  54
  55
  56 struct _GtkTreeViewColumn
  57 {
  58   GtkObject parent;
  59
  60   GtkWidget *tree_view;
  61   GtkWidget *button;
  62   GtkWidget *child;
  63   GtkWidget *arrow;
  64   GtkWidget *alignment;
  65   GdkWindow *window;
  66   GtkCellEditable *editable_widget;
  67   gfloat xalign;
  68   guint property_changed_signal;
  69   gint spacing;
  70
  71   /* Sizing fields */
  72   /* see gtk+/doc/tree-column-sizing.txt for more information on them */
  73   GtkTreeViewColumnSizing column_type;
  74   gint requested_width;
  75   gint button_request;
  76   gint resized_width;
  77   gint width;
  78   gint fixed_width;
  79   gint min_width;
  80   gint max_width;
  81
  82   /* dragging columns */
  83   gint drag_x;
  84   gint drag_y;
  85
  86   gchar *title;
  87   GList *cell_list;
  88
  89   /* Sorting */
  90   guint sort_clicked_signal;
  91   guint sort_column_changed_signal;
  92   gint sort_column_id;
  93   GtkSortType sort_order;
  94
  95   /* Flags */
  96   guint visible             : 1;
  97   guint resizable           : 1;
  98   guint clickable           : 1;
  99   guint dirty               : 1;
 100   guint show_sort_indicator : 1;
 101   guint maybe_reordered     : 1;
 102   guint reorderable         : 1;
 103   guint use_resized_width   : 1;
 104 };
 105
 106 struct _GtkTreeViewColumnClass
 107 {
 108   GtkObjectClass parent_class;
 109
 110   void (*clicked) (GtkTreeViewColumn *tree_column);
 111 };
 112
 113 GtkType                 gtk_tree_view_column_get_type            (void);
 114 GtkTreeViewColumn      *gtk_tree_view_column_new                 (void);
 115 GtkTreeViewColumn      *gtk_tree_view_column_new_with_attributes (const gchar             *title,
 116                                                                   GtkCellRenderer         *cell,
 117                                                                   ...);
 118 void                    gtk_tree_view_column_pack_start          (GtkTreeViewColumn       *tree_column,
 119                                                                   GtkCellRenderer         *cell,
 120                                                                   gboolean                 expand);
 121 void                    gtk_tree_view_column_pack_end            (GtkTreeViewColumn       *tree_column,
 122                                                                   GtkCellRenderer         *cell,
 123                                                                   gboolean                 expand);
 124 void                    gtk_tree_view_column_clear               (GtkTreeViewColumn       *tree_column);
 125 GList                  *gtk_tree_view_column_get_cell_renderers  (GtkTreeViewColumn       *tree_column);
 126 void                    gtk_tree_view_column_add_attribute       (GtkTreeViewColumn       *tree_column,
 127                                                                   GtkCellRenderer         *cell_renderer,
 128                                                                   const gchar             *attribute,
 129                                                                   gint                     column);
 130 void                    gtk_tree_view_column_set_attributes      (GtkTreeViewColumn       *tree_column,
 131                                                                   GtkCellRenderer         *cell_renderer,
 132                                                                   ...);
 133 void                    gtk_tree_view_column_set_cell_data_func  (GtkTreeViewColumn       *tree_column,
 134                                                                   GtkCellRenderer         *cell_renderer,
 135                                                                   GtkTreeCellDataFunc      func,
 136                                                                   gpointer                 func_data,
 137                                                                   GtkDestroyNotify         destroy);
 138 void                    gtk_tree_view_column_clear_attributes    (GtkTreeViewColumn       *tree_column,
 139                                                                   GtkCellRenderer         *cell_renderer);
 140 void                    gtk_tree_view_column_set_spacing         (GtkTreeViewColumn       *tree_column,
 141                                                                   gint                     spacing);
 142 gint                    gtk_tree_view_column_get_spacing         (GtkTreeViewColumn       *tree_column);
 143 void                    gtk_tree_view_column_set_visible         (GtkTreeViewColumn       *tree_column,
 144                                                                   gboolean                 visible);
 145 gboolean                gtk_tree_view_column_get_visible         (GtkTreeViewColumn       *tree_column);
 146 void                    gtk_tree_view_column_set_resizable       (GtkTreeViewColumn       *tree_column,
 147                                                                   gboolean                 resizable);
 148 gboolean                gtk_tree_view_column_get_resizable       (GtkTreeViewColumn       *tree_column);
 149 void                    gtk_tree_view_column_set_sizing          (GtkTreeViewColumn       *tree_column,
 150                                                                   GtkTreeViewColumnSizing  type);
 151 GtkTreeViewColumnSizing gtk_tree_view_column_get_sizing          (GtkTreeViewColumn       *tree_column);
 152 gint                    gtk_tree_view_column_get_width           (GtkTreeViewColumn       *tree_column);
 153 gint                    gtk_tree_view_column_get_fixed_width     (GtkTreeViewColumn       *tree_column);
 154 void                    gtk_tree_view_column_set_fixed_width     (GtkTreeViewColumn       *tree_column,
 155                                                                   gint                     fixed_width);
 156 void                    gtk_tree_view_column_set_min_width       (GtkTreeViewColumn       *tree_column,
 157                                                                   gint                     min_width);
 158 gint                    gtk_tree_view_column_get_min_width       (GtkTreeViewColumn       *tree_column);
 159 void                    gtk_tree_view_column_set_max_width       (GtkTreeViewColumn       *tree_column,
 160                                                                   gint                     max_width);
 161 gint                    gtk_tree_view_column_get_max_width       (GtkTreeViewColumn       *tree_column);
 162 void                    gtk_tree_view_column_clicked             (GtkTreeViewColumn       *tree_column);
 163
 164
 165
 166 /* Options for manipulating the column headers
 167  */
 168 void                    gtk_tree_view_column_set_title           (GtkTreeViewColumn       *tree_column,
 169                                                                   const gchar             *title);
 170 G_CONST_RETURN gchar   *gtk_tree_view_column_get_title           (GtkTreeViewColumn       *tree_column);
 171 void                    gtk_tree_view_column_set_clickable       (GtkTreeViewColumn       *tree_column,
 172                                                                   gboolean                 clickable);
 173 gboolean                gtk_tree_view_column_get_clickable       (GtkTreeViewColumn       *tree_column);
 174 void                    gtk_tree_view_column_set_widget          (GtkTreeViewColumn       *tree_column,
 175                                                                   GtkWidget               *widget);
 176 GtkWidget              *gtk_tree_view_column_get_widget          (GtkTreeViewColumn       *tree_column);
 177 void                    gtk_tree_view_column_set_alignment       (GtkTreeViewColumn       *tree_column,
 178                                                                   gfloat                   xalign);
 179 gfloat                  gtk_tree_view_column_get_alignment       (GtkTreeViewColumn       *tree_column);
 180 void                    gtk_tree_view_column_set_reorderable     (GtkTreeViewColumn       *tree_column,
 181                                                                   gboolean                 reorderable);
 182 gboolean                gtk_tree_view_column_get_reorderable     (GtkTreeViewColumn       *tree_column);
 183
 184
 185
 186 /* You probably only want to use gtk_tree_view_column_set_sort_column_id.  The
 187  * other sorting functions exist primarily to let others do their own custom sorting.
 188  */
 189 void                    gtk_tree_view_column_set_sort_column_id  (GtkTreeViewColumn       *tree_column,
 190                                                                   gint                     sort_column_id);
 191 gint                    gtk_tree_view_column_get_sort_column_id  (GtkTreeViewColumn       *tree_column);
 192 void                    gtk_tree_view_column_set_sort_indicator  (GtkTreeViewColumn       *tree_column,
 193                                                                   gboolean                 setting);
 194 gboolean                gtk_tree_view_column_get_sort_indicator  (GtkTreeViewColumn       *tree_column);
 195 void                    gtk_tree_view_column_set_sort_order      (GtkTreeViewColumn       *tree_column,
 196                                                                   GtkSortType              order);
 197 GtkSortType             gtk_tree_view_column_get_sort_order      (GtkTreeViewColumn       *tree_column);
 198
 199
 200 /* These functions are meant primarily for interaction between the GtkTreeView and the column.
 201  */
 202 void                    gtk_tree_view_column_cell_set_cell_data  (GtkTreeViewColumn       *tree_column,
 203                                                                   GtkTreeModel            *tree_model,
 204                                                                   GtkTreeIter             *iter,
 205                                                                   gboolean                 is_expander,
 206                                                                   gboolean                 is_expanded);
 207 void                    gtk_tree_view_column_cell_get_size       (GtkTreeViewColumn       *tree_column,
 208                                                                   GdkRectangle            *cell_area,
 209                                                                   gint                    *x_offset,
 210                                                                   gint                    *y_offset,
 211                                                                   gint                    *width,
 212                                                                   gint                    *height);
 213 void                    gtk_tree_view_column_cell_render         (GtkTreeViewColumn       *tree_column,
 214                                                                   GdkWindow               *window,
 215                                                                   GdkRectangle            *background_area,
 216                                                                   GdkRectangle            *cell_area,
 217                                                                   GdkRectangle            *expose_area,
 218                                                                   guint                    flags);
 219 gboolean                gtk_tree_view_column_cell_event          (GtkTreeViewColumn       *tree_column,
 220                                                                   GdkEvent                *event,
 221                                                                   gchar                   *path_string,
 222                                                                   GdkRectangle            *background_area,
 223                                                                   GdkRectangle            *cell_area,
 224                                                                   guint                    flags);
 225 gboolean                gtk_tree_view_column_cell_focus          (GtkTreeViewColumn       *tree_column,
 226                                                                   gint                     direction);
 227 void                    gtk_tree_view_column_cell_draw_focus     (GtkTreeViewColumn       *tree_column,
 228                                                                   GdkWindow               *window,
 229                                                                   GdkRectangle            *background_area,
 230                                                                   GdkRectangle            *cell_area,
 231                                                                   GdkRectangle            *expose_area,
 232                                                                   guint                    flags);
 233 gboolean                gtk_tree_view_column_cell_is_visible     (GtkTreeViewColumn       *tree_column);
 234 void                    gtk_tree_view_column_cell_set_dirty      (GtkTreeViewColumn       *tree_column);
 235
 236
 237 #ifdef __cplusplus
 238 }
 239 #endif /* __cplusplus */
 240
 241 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */
 242