pintos-os.org Git - pspp/blob - src/ui/gui/pspp-sheet-view-column.h

   1 /* PSPPIRE - a graphical user interface for PSPP.
   2    Copyright (C) 2011 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program 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
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 /* gtktreeviewcolumn.h
  18  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
  19  *
  20  * This library is free software; you can redistribute it and/or
  21  * modify it under the terms of the GNU Library General Public
  22  * License as published by the Free Software Foundation; either
  23  * version 2 of the License, or (at your option) any later version.
  24  *
  25  * This library is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  28  * Library General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU Library General Public
  31  * License along with this library; if not, write to the
  32  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  33  * Boston, MA 02111-1307, USA.
  34  */
  35
  36 #ifndef __PSPP_SHEET_VIEW_COLUMN_H__
  37 #define __PSPP_SHEET_VIEW_COLUMN_H__
  38
  39 #include <gtk/gtk.h>
  40
  41 G_BEGIN_DECLS
  42
  43
  44 #define PSPP_TYPE_SHEET_VIEW_COLUMN          (pspp_sheet_view_column_get_type ())
  45 #define PSPP_SHEET_VIEW_COLUMN(obj)          (G_TYPE_CHECK_INSTANCE_CAST ((obj), PSPP_TYPE_SHEET_VIEW_COLUMN, PsppSheetViewColumn))
  46 #define PSPP_SHEET_VIEW_COLUMN_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), PSPP_TYPE_SHEET_VIEW_COLUMN, PsppSheetViewColumnClass))
  47 #define PSPP_IS_SHEET_VIEW_COLUMN(obj)       (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PSPP_TYPE_SHEET_VIEW_COLUMN))
  48 #define PSPP_IS_SHEET_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PSPP_TYPE_SHEET_VIEW_COLUMN))
  49 #define PSPP_SHEET_VIEW_COLUMN_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PSPP_TYPE_SHEET_VIEW_COLUMN, PsppSheetViewColumnClass))
  50
  51 typedef enum
  52 {
  53   PSPP_SHEET_VIEW_COLUMN_GROW_ONLY,
  54   PSPP_SHEET_VIEW_COLUMN_AUTOSIZE,
  55   PSPP_SHEET_VIEW_COLUMN_FIXED
  56 } PsppSheetViewColumnSizing;
  57
  58 GType pspp_sheet_view_column_sizing_get_type (void) G_GNUC_CONST;
  59 #define PSPP_TYPE_SHEET_VIEW_COLUMN_SIZING (pspp_sheet_view_column_sizing_get_type ())
  60
  61 typedef struct _PsppSheetViewColumn      PsppSheetViewColumn;
  62 typedef struct _PsppSheetViewColumnClass PsppSheetViewColumnClass;
  63
  64 typedef void (* PsppSheetCellDataFunc) (PsppSheetViewColumn *tree_column,
  65                                         GtkCellRenderer   *cell,
  66                                         GtkTreeModel      *tree_model,
  67                                         GtkTreeIter       *iter,
  68                                         gpointer           data);
  69
  70
  71 struct _PsppSheetViewColumn
  72 {
  73   GtkObject parent;
  74
  75   GtkWidget *GSEAL (tree_view);
  76   GtkWidget *GSEAL (button);
  77   GtkWidget *GSEAL (child);
  78   GtkWidget *GSEAL (arrow);
  79   GtkWidget *GSEAL (alignment);
  80   GdkWindow *GSEAL (window);
  81   GtkCellEditable *GSEAL (editable_widget);
  82   gfloat GSEAL (xalign);
  83   guint GSEAL (property_changed_signal);
  84   gint GSEAL (spacing);
  85
  86   /* Sizing fields */
  87   /* see gtk+/doc/tree-column-sizing.txt for more information on them */
  88   PsppSheetViewColumnSizing GSEAL (column_type);
  89   gint GSEAL (requested_width);
  90   gint GSEAL (button_request);
  91   gint GSEAL (resized_width);
  92   gint GSEAL (width);
  93   gint GSEAL (fixed_width);
  94   gint GSEAL (min_width);
  95   gint GSEAL (max_width);
  96
  97   /* dragging columns */
  98   gint GSEAL (drag_x);
  99   gint GSEAL (drag_y);
 100
 101   gchar *GSEAL (title);
 102   GList *GSEAL (cell_list);
 103
 104   /* Sorting */
 105   guint GSEAL (sort_clicked_signal);
 106   guint GSEAL (sort_column_changed_signal);
 107   gint GSEAL (sort_column_id);
 108   GtkSortType GSEAL (sort_order);
 109
 110   /* Flags */
 111   guint GSEAL (visible)             : 1;
 112   guint GSEAL (resizable)           : 1;
 113   guint GSEAL (clickable)           : 1;
 114   guint GSEAL (dirty)               : 1;
 115   guint GSEAL (show_sort_indicator) : 1;
 116   guint GSEAL (maybe_reordered)     : 1;
 117   guint GSEAL (reorderable)         : 1;
 118   guint GSEAL (use_resized_width)   : 1;
 119   guint GSEAL (expand)              : 1;
 120 };
 121
 122 struct _PsppSheetViewColumnClass
 123 {
 124   GtkObjectClass parent_class;
 125
 126   void (*clicked) (PsppSheetViewColumn *tree_column);
 127
 128   /* Padding for future expansion */
 129   void (*_gtk_reserved1) (void);
 130   void (*_gtk_reserved2) (void);
 131   void (*_gtk_reserved3) (void);
 132   void (*_gtk_reserved4) (void);
 133 };
 134
 135 GType                   pspp_sheet_view_column_get_type            (void) G_GNUC_CONST;
 136 PsppSheetViewColumn      *pspp_sheet_view_column_new                 (void);
 137 PsppSheetViewColumn      *pspp_sheet_view_column_new_with_attributes (const gchar             *title,
 138                                                                   GtkCellRenderer         *cell,
 139                                                                   ...) G_GNUC_NULL_TERMINATED;
 140 void                    pspp_sheet_view_column_pack_start          (PsppSheetViewColumn       *tree_column,
 141                                                                   GtkCellRenderer         *cell,
 142                                                                   gboolean                 expand);
 143 void                    pspp_sheet_view_column_pack_end            (PsppSheetViewColumn       *tree_column,
 144                                                                   GtkCellRenderer         *cell,
 145                                                                   gboolean                 expand);
 146 void                    pspp_sheet_view_column_clear               (PsppSheetViewColumn       *tree_column);
 147 #ifndef GTK_DISABLE_DEPRECATED
 148 GList                  *pspp_sheet_view_column_get_cell_renderers  (PsppSheetViewColumn       *tree_column);
 149 #endif
 150 void                    pspp_sheet_view_column_add_attribute       (PsppSheetViewColumn       *tree_column,
 151                                                                   GtkCellRenderer         *cell_renderer,
 152                                                                   const gchar             *attribute,
 153                                                                   gint                     column);
 154 void                    pspp_sheet_view_column_set_attributes      (PsppSheetViewColumn       *tree_column,
 155                                                                   GtkCellRenderer         *cell_renderer,
 156                                                                   ...) G_GNUC_NULL_TERMINATED;
 157 void                    pspp_sheet_view_column_set_cell_data_func  (PsppSheetViewColumn       *tree_column,
 158                                                                   GtkCellRenderer         *cell_renderer,
 159                                                                   PsppSheetCellDataFunc      func,
 160                                                                   gpointer                 func_data,
 161                                                                   GDestroyNotify           destroy);
 162 void                    pspp_sheet_view_column_clear_attributes    (PsppSheetViewColumn       *tree_column,
 163                                                                   GtkCellRenderer         *cell_renderer);
 164 void                    pspp_sheet_view_column_set_spacing         (PsppSheetViewColumn       *tree_column,
 165                                                                   gint                     spacing);
 166 gint                    pspp_sheet_view_column_get_spacing         (PsppSheetViewColumn       *tree_column);
 167 void                    pspp_sheet_view_column_set_visible         (PsppSheetViewColumn       *tree_column,
 168                                                                   gboolean                 visible);
 169 gboolean                pspp_sheet_view_column_get_visible         (PsppSheetViewColumn       *tree_column);
 170 void                    pspp_sheet_view_column_set_resizable       (PsppSheetViewColumn       *tree_column,
 171                                                                   gboolean                 resizable);
 172 gboolean                pspp_sheet_view_column_get_resizable       (PsppSheetViewColumn       *tree_column);
 173 void                    pspp_sheet_view_column_set_sizing          (PsppSheetViewColumn       *tree_column,
 174                                                                   PsppSheetViewColumnSizing  type);
 175 PsppSheetViewColumnSizing pspp_sheet_view_column_get_sizing          (PsppSheetViewColumn       *tree_column);
 176 gint                    pspp_sheet_view_column_get_width           (PsppSheetViewColumn       *tree_column);
 177 gint                    pspp_sheet_view_column_get_fixed_width     (PsppSheetViewColumn       *tree_column);
 178 void                    pspp_sheet_view_column_set_fixed_width     (PsppSheetViewColumn       *tree_column,
 179                                                                   gint                     fixed_width);
 180 void                    pspp_sheet_view_column_set_min_width       (PsppSheetViewColumn       *tree_column,
 181                                                                   gint                     min_width);
 182 gint                    pspp_sheet_view_column_get_min_width       (PsppSheetViewColumn       *tree_column);
 183 void                    pspp_sheet_view_column_set_max_width       (PsppSheetViewColumn       *tree_column,
 184                                                                   gint                     max_width);
 185 gint                    pspp_sheet_view_column_get_max_width       (PsppSheetViewColumn       *tree_column);
 186 void                    pspp_sheet_view_column_clicked             (PsppSheetViewColumn       *tree_column);
 187
 188
 189
 190 /* Options for manipulating the column headers
 191  */
 192 void                    pspp_sheet_view_column_set_title           (PsppSheetViewColumn       *tree_column,
 193                                                                   const gchar             *title);
 194 G_CONST_RETURN gchar   *pspp_sheet_view_column_get_title           (PsppSheetViewColumn       *tree_column);
 195 void                    pspp_sheet_view_column_set_expand          (PsppSheetViewColumn       *tree_column,
 196                                                                   gboolean                 expand);
 197 gboolean                pspp_sheet_view_column_get_expand          (PsppSheetViewColumn       *tree_column);
 198 void                    pspp_sheet_view_column_set_clickable       (PsppSheetViewColumn       *tree_column,
 199                                                                   gboolean                 clickable);
 200 gboolean                pspp_sheet_view_column_get_clickable       (PsppSheetViewColumn       *tree_column);
 201 void                    pspp_sheet_view_column_set_widget          (PsppSheetViewColumn       *tree_column,
 202                                                                   GtkWidget               *widget);
 203 GtkWidget              *pspp_sheet_view_column_get_widget          (PsppSheetViewColumn       *tree_column);
 204 void                    pspp_sheet_view_column_set_alignment       (PsppSheetViewColumn       *tree_column,
 205                                                                   gfloat                   xalign);
 206 gfloat                  pspp_sheet_view_column_get_alignment       (PsppSheetViewColumn       *tree_column);
 207 void                    pspp_sheet_view_column_set_reorderable     (PsppSheetViewColumn       *tree_column,
 208                                                                   gboolean                 reorderable);
 209 gboolean                pspp_sheet_view_column_get_reorderable     (PsppSheetViewColumn       *tree_column);
 210
 211
 212
 213 /* You probably only want to use pspp_sheet_view_column_set_sort_column_id.  The
 214  * other sorting functions exist primarily to let others do their own custom sorting.
 215  */
 216 void                    pspp_sheet_view_column_set_sort_column_id  (PsppSheetViewColumn       *tree_column,
 217                                                                   gint                     sort_column_id);
 218 gint                    pspp_sheet_view_column_get_sort_column_id  (PsppSheetViewColumn       *tree_column);
 219 void                    pspp_sheet_view_column_set_sort_indicator  (PsppSheetViewColumn       *tree_column,
 220                                                                   gboolean                 setting);
 221 gboolean                pspp_sheet_view_column_get_sort_indicator  (PsppSheetViewColumn       *tree_column);
 222 void                    pspp_sheet_view_column_set_sort_order      (PsppSheetViewColumn       *tree_column,
 223                                                                   GtkSortType              order);
 224 GtkSortType             pspp_sheet_view_column_get_sort_order      (PsppSheetViewColumn       *tree_column);
 225
 226
 227 /* These functions are meant primarily for interaction between the PsppSheetView and the column.
 228  */
 229 void                    pspp_sheet_view_column_cell_set_cell_data  (PsppSheetViewColumn       *tree_column,
 230                                                                   GtkTreeModel            *tree_model,
 231                                                                   GtkTreeIter             *iter,
 232                                                                   gboolean                 is_expander,
 233                                                                   gboolean                 is_expanded);
 234 void                    pspp_sheet_view_column_cell_get_size       (PsppSheetViewColumn       *tree_column,
 235                                                                   const GdkRectangle      *cell_area,
 236                                                                   gint                    *x_offset,
 237                                                                   gint                    *y_offset,
 238                                                                   gint                    *width,
 239                                                                   gint                    *height);
 240 gboolean                pspp_sheet_view_column_cell_is_visible     (PsppSheetViewColumn       *tree_column);
 241 void                    pspp_sheet_view_column_focus_cell          (PsppSheetViewColumn       *tree_column,
 242                                                                   GtkCellRenderer         *cell);
 243 gboolean                pspp_sheet_view_column_cell_get_position   (PsppSheetViewColumn       *tree_column,
 244                                                                   GtkCellRenderer         *cell_renderer,
 245                                                                   gint                    *start_pos,
 246                                                                   gint                    *width);
 247 void                    pspp_sheet_view_column_queue_resize        (PsppSheetViewColumn       *tree_column);
 248 GtkWidget              *pspp_sheet_view_column_get_tree_view       (PsppSheetViewColumn       *tree_column);
 249
 250
 251 G_END_DECLS
 252
 253
 254 #endif /* __PSPP_SHEET_VIEW_COLUMN_H__ */