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 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  21 #error "Only <gtk/gtk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __GTK_TREE_VIEW_COLUMN_H__
  25 #define __GTK_TREE_VIEW_COLUMN_H__
  26
  27 #include <gtk/gtkcellrenderer.h>
  28 #include <gtk/gtktreemodel.h>
  29 #include <gtk/gtktreesortable.h>
  30 #include <gtk/gtkcellarea.h>
  31
  32
  33 G_BEGIN_DECLS
  34
  35
  36 #define GTK_TYPE_TREE_VIEW_COLUMN            (gtk_tree_view_column_get_type ())
  37 #define GTK_TREE_VIEW_COLUMN(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumn))
  38 #define GTK_TREE_VIEW_COLUMN_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
  39 #define GTK_IS_TREE_VIEW_COLUMN(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW_COLUMN))
  40 #define GTK_IS_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW_COLUMN))
  41 #define GTK_TREE_VIEW_COLUMN_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
  42
  43 typedef struct _GtkTreeViewColumn        GtkTreeViewColumn;
  44 typedef struct _GtkTreeViewColumnClass   GtkTreeViewColumnClass;
  45 typedef struct _GtkTreeViewColumnPrivate GtkTreeViewColumnPrivate;
  46
  47 /**
  48  * GtkTreeViewColumnSizing:
  49  * @GTK_TREE_VIEW_COLUMN_GROW_ONLY: Columns only get bigger in reaction to changes in the model
  50  * @GTK_TREE_VIEW_COLUMN_AUTOSIZE: Columns resize to be the optimal size everytime the model changes.
  51  * @GTK_TREE_VIEW_COLUMN_FIXED: Columns are a fixed numbers of pixels wide.
  52  *
  53  * The sizing method the column uses to determine its width.  Please note
  54  * that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and
  55  * can make columns appear choppy.
  56  */
  57 typedef enum
  58 {
  59   GTK_TREE_VIEW_COLUMN_GROW_ONLY,
  60   GTK_TREE_VIEW_COLUMN_AUTOSIZE,
  61   GTK_TREE_VIEW_COLUMN_FIXED
  62 } GtkTreeViewColumnSizing;
  63
  64 /**
  65  * GtkTreeCellDataFunc:
  66  * @tree_column: A #GtkTreeColumn
  67  * @cell: The #GtkCellRenderer that is being rendered by @tree_column
  68  * @tree_model: The #GtkTreeModel being rendered
  69  * @iter: A #GtkTreeIter of the current row rendered
  70  * @data: user data
  71  *
  72  * A function to set the properties of a cell instead of just using the
  73  * straight mapping between the cell and the model.  This is useful for
  74  * customizing the cell renderer.  For example, a function might get an
  75  * integer from the @tree_model, and render it to the "text" attribute of
  76  * "cell" by converting it to its written equivilent.  This is set by
  77  * calling gtk_tree_view_column_set_cell_data_func()
  78  */
  79 typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,
  80                                       GtkCellRenderer   *cell,
  81                                       GtkTreeModel      *tree_model,
  82                                       GtkTreeIter       *iter,
  83                                       gpointer           data);
  84
  85
  86 struct _GtkTreeViewColumn
  87 {
  88   GInitiallyUnowned parent_instance;
  89
  90   GtkTreeViewColumnPrivate *priv;
  91 };
  92
  93 struct _GtkTreeViewColumnClass
  94 {
  95   GInitiallyUnownedClass parent_class;
  96
  97   void (*clicked) (GtkTreeViewColumn *tree_column);
  98
  99   /* Padding for future expansion */
 100   void (*_gtk_reserved1) (void);
 101   void (*_gtk_reserved2) (void);
 102   void (*_gtk_reserved3) (void);
 103   void (*_gtk_reserved4) (void);
 104 };
 105
 106 GType                   gtk_tree_view_column_get_type            (void) G_GNUC_CONST;
 107 GtkTreeViewColumn      *gtk_tree_view_column_new                 (void);
 108 GtkTreeViewColumn      *gtk_tree_view_column_new_with_attributes (const gchar             *title,
 109                                                                   GtkCellRenderer         *cell,
 110                                                                   ...) G_GNUC_NULL_TERMINATED;
 111 void                    gtk_tree_view_column_pack_start          (GtkTreeViewColumn       *tree_column,
 112                                                                   GtkCellRenderer         *cell,
 113                                                                   gboolean                 expand);
 114 void                    gtk_tree_view_column_pack_end            (GtkTreeViewColumn       *tree_column,
 115                                                                   GtkCellRenderer         *cell,
 116                                                                   gboolean                 expand);
 117 void                    gtk_tree_view_column_clear               (GtkTreeViewColumn       *tree_column);
 118 void                    gtk_tree_view_column_add_attribute       (GtkTreeViewColumn       *tree_column,
 119                                                                   GtkCellRenderer         *cell_renderer,
 120                                                                   const gchar             *attribute,
 121                                                                   gint                     column);
 122 void                    gtk_tree_view_column_set_attributes      (GtkTreeViewColumn       *tree_column,
 123                                                                   GtkCellRenderer         *cell_renderer,
 124                                                                   ...) G_GNUC_NULL_TERMINATED;
 125 void                    gtk_tree_view_column_set_cell_data_func  (GtkTreeViewColumn       *tree_column,
 126                                                                   GtkCellRenderer         *cell_renderer,
 127                                                                   GtkTreeCellDataFunc      func,
 128                                                                   gpointer                 func_data,
 129                                                                   GDestroyNotify           destroy);
 130 void                    gtk_tree_view_column_clear_attributes    (GtkTreeViewColumn       *tree_column,
 131                                                                   GtkCellRenderer         *cell_renderer);
 132 void                    gtk_tree_view_column_set_spacing         (GtkTreeViewColumn       *tree_column,
 133                                                                   gint                     spacing);
 134 gint                    gtk_tree_view_column_get_spacing         (GtkTreeViewColumn       *tree_column);
 135 void                    gtk_tree_view_column_set_visible         (GtkTreeViewColumn       *tree_column,
 136                                                                   gboolean                 visible);
 137 gboolean                gtk_tree_view_column_get_visible         (GtkTreeViewColumn       *tree_column);
 138 void                    gtk_tree_view_column_set_resizable       (GtkTreeViewColumn       *tree_column,
 139                                                                   gboolean                 resizable);
 140 gboolean                gtk_tree_view_column_get_resizable       (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_expand          (GtkTreeViewColumn       *tree_column,
 164                                                                   gboolean                 expand);
 165 gboolean                gtk_tree_view_column_get_expand          (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                                                                   const GdkRectangle      *cell_area,
 204                                                                   gint                    *x_offset,
 205                                                                   gint                    *y_offset,
 206                                                                   gint                    *width,
 207                                                                   gint                    *height);
 208 gboolean                gtk_tree_view_column_cell_is_visible     (GtkTreeViewColumn       *tree_column);
 209 void                    gtk_tree_view_column_focus_cell          (GtkTreeViewColumn       *tree_column,
 210                                                                   GtkCellRenderer         *cell);
 211 gboolean                gtk_tree_view_column_cell_get_position   (GtkTreeViewColumn       *tree_column,
 212                                                                   GtkCellRenderer         *cell_renderer,
 213                                                                   gint                    *start_pos,
 214                                                                   gint                    *width);
 215 void                    gtk_tree_view_column_queue_resize        (GtkTreeViewColumn       *tree_column);
 216 GtkWidget              *gtk_tree_view_column_get_tree_view       (GtkTreeViewColumn       *tree_column);
 217 GtkWidget              *gtk_tree_view_column_get_button          (GtkTreeViewColumn       *tree_column);
 218
 219
 220 G_END_DECLS
 221
 222
 223 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */