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_RESIZABLE,
  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   gfloat xalign;
  67   guint property_changed_signal;
  68
  69   gint spacing;
  70   gint width;
  71   gint requested_width;
  72   gint min_width;
  73   gint max_width;
  74   gint displayed_width;
  75
  76   /* dragging columns */
  77   gint drag_x;
  78   gint drag_y;
  79
  80   gchar *title;
  81   GList *cell_list;
  82   GtkTreeViewColumnSizing column_type;
  83
  84   /* Sorting */
  85   guint sort_clicked_signal;
  86   guint sort_column_changed_signal;
  87   gint sort_column_id;
  88   GtkSortType sort_order;
  89
  90   /* Flags */
  91   guint visible             : 1;
  92   guint clickable           : 1;
  93   guint dirty               : 1;
  94   guint show_sort_indicator : 1;
  95   guint maybe_reordered     : 1;
  96   guint reorderable         : 1;
  97 };
  98
  99 struct _GtkTreeViewColumnClass
 100 {
 101   GtkObjectClass parent_class;
 102
 103   void (*clicked) (GtkTreeViewColumn *tree_column);
 104 };
 105
 106 GtkType                 gtk_tree_view_column_get_type            (void);
 107 GtkTreeViewColumn      *gtk_tree_view_column_new                 (void);
 108 GtkTreeViewColumn      *gtk_tree_view_column_new_with_attributes (const gchar             *title,
 109                                                                   GtkCellRenderer         *cell,
 110                                                                   ...);
 111 void                    gtk_tree_view_column_set_cell_renderer   (GtkTreeViewColumn       *tree_column,
 112                                                                   GtkCellRenderer         *cell);
 113 void                    gtk_tree_view_column_pack_start_cell_renderer (GtkTreeViewColumn  *tree_column,
 114                                                                        GtkCellRenderer    *cell,
 115                                                                        gboolean            expand,
 116                                                                        gboolean            fill,
 117                                                                        guint               padding);
 118 void                    gtk_tree_view_column_pack_end_cell_renderer   (GtkTreeViewColumn  *tree_column,
 119                                                                        GtkCellRenderer    *cell,
 120                                                                        gboolean            expand,
 121                                                                        gboolean            fill,
 122                                                                        guint               padding);
 123 void                    gtk_tree_view_column_clear_cell_renderers     (GtkTreeViewColumn  *tree_column);
 124 GList                  *gtk_tree_view_column_get_cell_renderers       (GtkTreeViewColumn  *tree_column);
 125 void                    gtk_tree_view_column_add_attribute       (GtkTreeViewColumn       *tree_column,
 126                                                                   GtkCellRenderer         *cell_renderer,
 127                                                                   const gchar             *attribute,
 128                                                                   gint                     column);
 129 void                    gtk_tree_view_column_set_attributes      (GtkTreeViewColumn       *tree_column,
 130                                                                   GtkCellRenderer         *cell_renderer,
 131                                                                   ...);
 132 void                    gtk_tree_view_column_set_cell_data_func  (GtkTreeViewColumn       *tree_column,
 133                                                                   GtkCellRenderer         *cell_renderer,
 134                                                                   GtkTreeCellDataFunc      func,
 135                                                                   gpointer                 func_data,
 136                                                                   GtkDestroyNotify         destroy);
 137 void                    gtk_tree_view_column_clear_attributes    (GtkTreeViewColumn       *tree_column,
 138                                                                   GtkCellRenderer         *cell_renderer);
 139 void                    gtk_tree_view_column_set_spacing         (GtkTreeViewColumn       *tree_column,
 140                                                                   gint                     spacing);
 141 gint                    gtk_tree_view_column_get_spacing         (GtkTreeViewColumn       *tree_column);
 142 void                    gtk_tree_view_column_set_visible         (GtkTreeViewColumn       *tree_column,
 143                                                                   gboolean                 visible);
 144 gboolean                gtk_tree_view_column_get_visible         (GtkTreeViewColumn       *tree_column);
 145 void                    gtk_tree_view_column_set_sizing          (GtkTreeViewColumn       *tree_column,
 146                                                                   GtkTreeViewColumnSizing  type);
 147 GtkTreeViewColumnSizing gtk_tree_view_column_get_sizing          (GtkTreeViewColumn       *tree_column);
 148 gint                    gtk_tree_view_column_get_width           (GtkTreeViewColumn       *tree_column);
 149 void                    gtk_tree_view_column_set_width           (GtkTreeViewColumn       *tree_column,
 150                                                                   gint                     width);
 151 void                    gtk_tree_view_column_set_min_width       (GtkTreeViewColumn       *tree_column,
 152                                                                   gint                     min_width);
 153 gint                    gtk_tree_view_column_get_min_width       (GtkTreeViewColumn       *tree_column);
 154 void                    gtk_tree_view_column_set_max_width       (GtkTreeViewColumn       *tree_column,
 155                                                                   gint                     max_width);
 156 gint                    gtk_tree_view_column_get_max_width       (GtkTreeViewColumn       *tree_column);
 157 void                    gtk_tree_view_column_clicked             (GtkTreeViewColumn       *tree_column);
 158
 159
 160
 161 /* Options for manipulating the column headers
 162  */
 163 void                    gtk_tree_view_column_set_title           (GtkTreeViewColumn       *tree_column,
 164                                                                   const gchar             *title);
 165 G_CONST_RETURN gchar   *gtk_tree_view_column_get_title           (GtkTreeViewColumn       *tree_column);
 166 void                    gtk_tree_view_column_set_clickable       (GtkTreeViewColumn       *tree_column,
 167                                                                   gboolean                 clickable);
 168 gboolean                gtk_tree_view_column_get_clickable       (GtkTreeViewColumn       *tree_column);
 169 void                    gtk_tree_view_column_set_widget          (GtkTreeViewColumn       *tree_column,
 170                                                                   GtkWidget               *widget);
 171 GtkWidget              *gtk_tree_view_column_get_widget          (GtkTreeViewColumn       *tree_column);
 172 void                    gtk_tree_view_column_set_alignment       (GtkTreeViewColumn       *tree_column,
 173                                                                   gfloat                   xalign);
 174 gfloat                  gtk_tree_view_column_get_alignment       (GtkTreeViewColumn       *tree_column);
 175 void                    gtk_tree_view_column_set_reorderable     (GtkTreeViewColumn       *tree_column,
 176                                                                   gboolean                 reorderable);
 177 gboolean                gtk_tree_view_column_get_reorderable     (GtkTreeViewColumn       *tree_column);
 178
 179
 180
 181 /* You probably only want to use gtk_tree_view_column_set_sort_column_id.  The
 182  * other sorting functions exist primarily to let others do their own custom sorting.
 183  */
 184 void                    gtk_tree_view_column_set_sort_column_id  (GtkTreeViewColumn       *tree_column,
 185                                                                   gint                     sort_column_id);
 186 gint                    gtk_tree_view_column_get_sort_column_id  (GtkTreeViewColumn       *tree_column);
 187 void                    gtk_tree_view_column_set_sort_indicator  (GtkTreeViewColumn       *tree_column,
 188                                                                   gboolean                 setting);
 189 gboolean                gtk_tree_view_column_get_sort_indicator  (GtkTreeViewColumn       *tree_column);
 190 void                    gtk_tree_view_column_set_sort_order      (GtkTreeViewColumn       *tree_column,
 191                                                                   GtkSortType              order);
 192 GtkSortType             gtk_tree_view_column_get_sort_order      (GtkTreeViewColumn       *tree_column);
 193
 194
 195 /* These functions are meant primarily for interaction between the GtkTreeView and the column.
 196  */
 197 void                    gtk_tree_view_column_cell_set_cell_data  (GtkTreeViewColumn       *tree_column,
 198                                                                   GtkTreeModel            *tree_model,
 199                                                                   GtkTreeIter             *iter,
 200                                                                   gboolean                 is_expander,
 201                                                                   gboolean                 is_expanded);
 202 void                    gtk_tree_view_column_cell_get_size       (GtkTreeViewColumn       *tree_column,
 203                                                                   GdkRectangle            *cell_area,
 204                                                                   gint                    *x_offset,
 205                                                                   gint                    *y_offset,
 206                                                                   gint                    *width,
 207                                                                   gint                    *height);
 208 void                    gtk_tree_view_column_cell_render         (GtkTreeViewColumn       *tree_column,
 209                                                                   GdkWindow               *window,
 210                                                                   GdkRectangle            *background_area,
 211                                                                   GdkRectangle            *cell_area,
 212                                                                   GdkRectangle            *expose_area,
 213                                                                   guint                    flags);
 214 gboolean                gtk_tree_view_column_cell_event          (GtkTreeViewColumn       *tree_column,
 215                                                                   GdkEvent                *event,
 216                                                                   gchar                   *path_string,
 217                                                                   GdkRectangle            *background_area,
 218                                                                   GdkRectangle            *cell_area,
 219                                                                   guint                    flags);
 220 gboolean                gtk_tree_view_column_cell_can_focus      (GtkTreeViewColumn       *tree_column);
 221 gboolean                gtk_tree_view_column_cell_is_visible     (GtkTreeViewColumn       *tree_column);
 222
 223
 224 #ifdef __cplusplus
 225 }
 226 #endif /* __cplusplus */
 227
 228 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */
 229