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
  38 typedef enum
  39 {
  40   GTK_TREE_VIEW_COLUMN_RESIZEABLE,
  41   GTK_TREE_VIEW_COLUMN_AUTOSIZE,
  42   GTK_TREE_VIEW_COLUMN_FIXED
  43 } GtkTreeViewColumnSizing;
  44
  45 typedef struct _GtkTreeViewColumn      GtkTreeViewColumn;
  46 typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
  47
  48 typedef void (* GtkCellDataFunc) (GtkTreeViewColumn *tree_column,
  49                                   GtkCellRenderer   *cell,
  50                                   GtkTreeModel      *tree_model,
  51                                   GtkTreeIter       *iter,
  52                                   gpointer           data);
  53
  54
  55 struct _GtkTreeViewColumn
  56 {
  57   GtkObject parent;
  58
  59   GtkWidget *tree_view;
  60   GtkWidget *button;
  61   GtkWidget *child;
  62   GtkWidget *arrow;
  63   GtkWidget *alignment;
  64   GdkWindow *window;
  65   gfloat xalign;
  66
  67   gint width;
  68   gint min_width;
  69   gint max_width;
  70   gint displayed_width;
  71
  72   GtkCellDataFunc func;
  73   gpointer func_data;
  74   GtkDestroyNotify destroy;
  75   gchar *title;
  76   GtkCellRenderer *cell;
  77   GSList *attributes;
  78   GtkTreeViewColumnSizing column_type;
  79
  80   /* Sorting */
  81   guint sort_signal;
  82   gint sort_column_id;
  83   GtkTreeSortOrder sort_order;
  84
  85
  86   guint visible       : 1;
  87   guint button_active : 1;
  88   guint dirty         : 1;
  89   guint show_sort_indicator : 1;
  90 };
  91
  92 struct _GtkTreeViewColumnClass
  93 {
  94   GtkObjectClass parent_class;
  95
  96   void (*clicked) (GtkTreeViewColumn *tree_column);
  97 };
  98
  99
 100 GtkType            gtk_tree_view_column_get_type            (void);
 101 GtkTreeViewColumn *gtk_tree_view_column_new                 (void);
 102 GtkTreeViewColumn *gtk_tree_view_column_new_with_attributes (const gchar           *title,
 103                                                              GtkCellRenderer       *cell,
 104                                                              ...);
 105 void               gtk_tree_view_column_set_cell_renderer   (GtkTreeViewColumn     *tree_column,
 106                                                              GtkCellRenderer       *cell);
 107 GtkCellRenderer   *gtk_tree_view_column_get_cell_renderer   (GtkTreeViewColumn     *tree_column);
 108 void               gtk_tree_view_column_add_attribute       (GtkTreeViewColumn     *tree_column,
 109                                                              const gchar           *attribute,
 110                                                              gint                   column);
 111 void               gtk_tree_view_column_set_attributes      (GtkTreeViewColumn     *tree_column,
 112                                                              ...);
 113 void               gtk_tree_view_column_set_cell_data_func  (GtkTreeViewColumn     *tree_column,
 114                                                              GtkCellDataFunc        func,
 115                                                              gpointer               func_data,
 116                                                              GtkDestroyNotify       destroy);
 117 void               gtk_tree_view_column_clear_attributes    (GtkTreeViewColumn     *tree_column);
 118 void               gtk_tree_view_column_set_cell_data       (GtkTreeViewColumn     *tree_column,
 119                                                              GtkTreeModel          *tree_model,
 120                                                              GtkTreeIter           *iter);
 121 void               gtk_tree_view_column_set_visible         (GtkTreeViewColumn     *tree_column,
 122                                                              gboolean               visible);
 123 gboolean           gtk_tree_view_column_get_visible         (GtkTreeViewColumn     *tree_column);
 124 void               gtk_tree_view_column_set_sizing          (GtkTreeViewColumn     *tree_column,
 125                                                              GtkTreeViewColumnSizing type);
 126 gint               gtk_tree_view_column_get_sizing          (GtkTreeViewColumn     *tree_column);
 127 gint               gtk_tree_view_column_get_width           (GtkTreeViewColumn     *tree_column);
 128 void               gtk_tree_view_column_set_width           (GtkTreeViewColumn     *tree_column,
 129                                                              gint                   size);
 130 void               gtk_tree_view_column_set_min_width       (GtkTreeViewColumn     *tree_column,
 131                                                              gint                   min_width);
 132 gint               gtk_tree_view_column_get_min_width       (GtkTreeViewColumn     *tree_column);
 133 void               gtk_tree_view_column_set_max_width       (GtkTreeViewColumn     *tree_column,
 134                                                              gint                   max_width);
 135 gint               gtk_tree_view_column_get_max_width       (GtkTreeViewColumn     *tree_column);
 136
 137
 138 void               gtk_tree_view_column_clicked             (GtkTreeViewColumn     *tree_column);
 139
 140 /* Options for manipulating the column headers
 141  */
 142 void                  gtk_tree_view_column_set_title          (GtkTreeViewColumn *tree_column,
 143                                                                const gchar       *title);
 144 G_CONST_RETURN gchar *gtk_tree_view_column_get_title          (GtkTreeViewColumn *tree_column);
 145 void                  gtk_tree_view_column_set_clickable      (GtkTreeViewColumn *tree_column,
 146                                                                gboolean           active);
 147 gboolean              gtk_tree_view_column_get_clickable      (GtkTreeViewColumn *tree_column);
 148 void                  gtk_tree_view_column_set_widget         (GtkTreeViewColumn *tree_column,
 149                                                                GtkWidget         *widget);
 150 GtkWidget            *gtk_tree_view_column_get_widget         (GtkTreeViewColumn *tree_column);
 151 void                  gtk_tree_view_column_set_alignment      (GtkTreeViewColumn *tree_column,
 152                                                                gfloat             xalign);
 153 gfloat                gtk_tree_view_column_get_alignment      (GtkTreeViewColumn *tree_column);
 154
 155
 156 /* You probably only want to use gtk_tree_view_column_set_sort_column_id.  The
 157  * other sorting functions exist primarily to let others do their own custom sorting.
 158  */
 159
 160 void                  gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
 161                                                                gint               sort_column_id);
 162 void                  gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
 163                                                                gboolean           setting);
 164 gboolean              gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column);
 165 void                  gtk_tree_view_column_set_sort_order     (GtkTreeViewColumn *tree_column,
 166                                                                GtkTreeSortOrder   order);
 167 GtkTreeSortOrder      gtk_tree_view_column_get_sort_order     (GtkTreeViewColumn *tree_column);
 168
 169
 170
 171
 172
 173 #ifdef __cplusplus
 174 }
 175 #endif /* __cplusplus */
 176
 177 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */
 178