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_RESIZEABLE,
  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 (* GtkCellDataFunc) (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 width;
  70   gint requested_width;
  71   gint min_width;
  72   gint max_width;
  73   gint displayed_width;
  74
  75   /* dragging columns */
  76   gint drag_x;
  77   gint drag_y;
  78
  79   GtkCellDataFunc func;
  80   gpointer func_data;
  81   GtkDestroyNotify destroy;
  82   gchar *title;
  83   GtkCellRenderer *cell;
  84   GSList *attributes;
  85   GtkTreeViewColumnSizing column_type;
  86
  87   /* Sorting */
  88   guint sort_clicked_signal;
  89   guint sort_column_changed_signal;
  90   gint sort_column_id;
  91   GtkTreeSortOrder sort_order;
  92
  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
 109 GtkType            gtk_tree_view_column_get_type            (void);
 110 GtkTreeViewColumn *gtk_tree_view_column_new                 (void);
 111 GtkTreeViewColumn *gtk_tree_view_column_new_with_attributes (const gchar           *title,
 112                                                              GtkCellRenderer       *cell,
 113                                                              ...);
 114 void               gtk_tree_view_column_set_cell_renderer   (GtkTreeViewColumn     *tree_column,
 115                                                              GtkCellRenderer       *cell);
 116 GtkCellRenderer   *gtk_tree_view_column_get_cell_renderer   (GtkTreeViewColumn     *tree_column);
 117 void               gtk_tree_view_column_add_attribute       (GtkTreeViewColumn     *tree_column,
 118                                                              const gchar           *attribute,
 119                                                              gint                   column);
 120 void               gtk_tree_view_column_set_attributes      (GtkTreeViewColumn     *tree_column,
 121                                                              ...);
 122 void               gtk_tree_view_column_set_cell_data_func  (GtkTreeViewColumn     *tree_column,
 123                                                              GtkCellDataFunc        func,
 124                                                              gpointer               func_data,
 125                                                              GtkDestroyNotify       destroy);
 126 void               gtk_tree_view_column_clear_attributes    (GtkTreeViewColumn     *tree_column);
 127 void               gtk_tree_view_column_set_cell_data       (GtkTreeViewColumn     *tree_column,
 128                                                              GtkTreeModel          *tree_model,
 129                                                              GtkTreeIter           *iter);
 130 void               gtk_tree_view_column_set_visible         (GtkTreeViewColumn     *tree_column,
 131                                                              gboolean               visible);
 132 gboolean           gtk_tree_view_column_get_visible         (GtkTreeViewColumn     *tree_column);
 133 void               gtk_tree_view_column_set_sizing          (GtkTreeViewColumn     *tree_column,
 134                                                              GtkTreeViewColumnSizing type);
 135 gint               gtk_tree_view_column_get_sizing          (GtkTreeViewColumn     *tree_column);
 136 gint               gtk_tree_view_column_get_width           (GtkTreeViewColumn     *tree_column);
 137 void               gtk_tree_view_column_set_width           (GtkTreeViewColumn     *tree_column,
 138                                                              gint                   size);
 139 void               gtk_tree_view_column_set_min_width       (GtkTreeViewColumn     *tree_column,
 140                                                              gint                   min_width);
 141 gint               gtk_tree_view_column_get_min_width       (GtkTreeViewColumn     *tree_column);
 142 void               gtk_tree_view_column_set_max_width       (GtkTreeViewColumn     *tree_column,
 143                                                              gint                   max_width);
 144 gint               gtk_tree_view_column_get_max_width       (GtkTreeViewColumn     *tree_column);
 145
 146
 147 void               gtk_tree_view_column_clicked             (GtkTreeViewColumn     *tree_column);
 148
 149 /* Options for manipulating the column headers
 150  */
 151 void                  gtk_tree_view_column_set_title          (GtkTreeViewColumn *tree_column,
 152                                                                const gchar       *title);
 153 G_CONST_RETURN gchar *gtk_tree_view_column_get_title          (GtkTreeViewColumn *tree_column);
 154 void                  gtk_tree_view_column_set_clickable      (GtkTreeViewColumn *tree_column,
 155                                                                gboolean           clickable);
 156 gboolean              gtk_tree_view_column_get_clickable      (GtkTreeViewColumn *tree_column);
 157 void                  gtk_tree_view_column_set_widget         (GtkTreeViewColumn *tree_column,
 158                                                                GtkWidget         *widget);
 159 GtkWidget            *gtk_tree_view_column_get_widget         (GtkTreeViewColumn *tree_column);
 160 void                  gtk_tree_view_column_set_alignment      (GtkTreeViewColumn *tree_column,
 161                                                                gfloat             xalign);
 162 gfloat                gtk_tree_view_column_get_alignment      (GtkTreeViewColumn *tree_column);
 163 void                  gtk_tree_view_column_set_reorderable    (GtkTreeViewColumn *tree_column,
 164                                                                gboolean           reorderable);
 165 gboolean              gtk_tree_view_column_get_reorderable    (GtkTreeViewColumn *tree_column);
 166
 167 /* You probably only want to use gtk_tree_view_column_set_sort_column_id.  The
 168  * other sorting functions exist primarily to let others do their own custom sorting.
 169  */
 170
 171 void                  gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
 172                                                                gint               sort_column_id);
 173 void                  gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
 174                                                                gboolean           setting);
 175 gboolean              gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column);
 176 void                  gtk_tree_view_column_set_sort_order     (GtkTreeViewColumn *tree_column,
 177                                                                GtkTreeSortOrder   order);
 178 GtkTreeSortOrder      gtk_tree_view_column_get_sort_order     (GtkTreeViewColumn *tree_column);
 179
 180
 181
 182
 183
 184 #ifdef __cplusplus
 185 }
 186 #endif /* __cplusplus */
 187
 188 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */
 189