pspp-sheet-view: Reduce time and memory cost to O(1) in number of rows.
[pspp] / 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 struct _PsppSheetViewColumn      PsppSheetViewColumn;
52 typedef struct _PsppSheetViewColumnClass PsppSheetViewColumnClass;
53
54 typedef void (* PsppSheetCellDataFunc) (PsppSheetViewColumn *tree_column,
55                                         GtkCellRenderer   *cell,
56                                         GtkTreeModel      *tree_model,
57                                         GtkTreeIter       *iter,
58                                         gpointer           data);
59
60
61 struct _PsppSheetViewColumn
62 {
63   GtkObject parent;
64
65   GtkWidget *GSEAL (tree_view);
66   GtkWidget *GSEAL (button);
67   GtkWidget *GSEAL (child);
68   GtkWidget *GSEAL (arrow);
69   GtkWidget *GSEAL (alignment);
70   GdkWindow *GSEAL (window);
71   GtkCellEditable *GSEAL (editable_widget);
72   gfloat GSEAL (xalign);
73   guint GSEAL (property_changed_signal);
74   gint GSEAL (spacing);
75
76   /* Sizing fields */
77   /* see gtk+/doc/tree-column-sizing.txt for more information on them */
78   gint GSEAL (requested_width);
79   gint GSEAL (button_request);
80   gint GSEAL (resized_width);
81   gint GSEAL (width);
82   gint GSEAL (fixed_width);
83   gint GSEAL (min_width);
84   gint GSEAL (max_width);
85
86   /* dragging columns */
87   gint GSEAL (drag_x);
88   gint GSEAL (drag_y);
89
90   gchar *GSEAL (title);
91   GList *GSEAL (cell_list);
92
93   /* Sorting */
94   guint GSEAL (sort_clicked_signal);
95   guint GSEAL (sort_column_changed_signal);
96   gint GSEAL (sort_column_id);
97   GtkSortType GSEAL (sort_order);
98
99   /* Flags */
100   guint GSEAL (visible)             : 1;
101   guint GSEAL (resizable)           : 1;
102   guint GSEAL (clickable)           : 1;
103   guint GSEAL (dirty)               : 1;
104   guint GSEAL (show_sort_indicator) : 1;
105   guint GSEAL (maybe_reordered)     : 1;
106   guint GSEAL (reorderable)         : 1;
107   guint GSEAL (use_resized_width)   : 1;
108   guint GSEAL (expand)              : 1;
109 };
110
111 struct _PsppSheetViewColumnClass
112 {
113   GtkObjectClass parent_class;
114
115   void (*clicked) (PsppSheetViewColumn *tree_column);
116
117   /* Padding for future expansion */
118   void (*_gtk_reserved1) (void);
119   void (*_gtk_reserved2) (void);
120   void (*_gtk_reserved3) (void);
121   void (*_gtk_reserved4) (void);
122 };
123
124 GType                   pspp_sheet_view_column_get_type            (void) G_GNUC_CONST;
125 PsppSheetViewColumn      *pspp_sheet_view_column_new                 (void);
126 PsppSheetViewColumn      *pspp_sheet_view_column_new_with_attributes (const gchar             *title,
127                                                                   GtkCellRenderer         *cell,
128                                                                   ...) G_GNUC_NULL_TERMINATED;
129 void                    pspp_sheet_view_column_pack_start          (PsppSheetViewColumn       *tree_column,
130                                                                   GtkCellRenderer         *cell,
131                                                                   gboolean                 expand);
132 void                    pspp_sheet_view_column_pack_end            (PsppSheetViewColumn       *tree_column,
133                                                                   GtkCellRenderer         *cell,
134                                                                   gboolean                 expand);
135 void                    pspp_sheet_view_column_clear               (PsppSheetViewColumn       *tree_column);
136 #ifndef GTK_DISABLE_DEPRECATED
137 GList                  *pspp_sheet_view_column_get_cell_renderers  (PsppSheetViewColumn       *tree_column);
138 #endif
139 void                    pspp_sheet_view_column_add_attribute       (PsppSheetViewColumn       *tree_column,
140                                                                   GtkCellRenderer         *cell_renderer,
141                                                                   const gchar             *attribute,
142                                                                   gint                     column);
143 void                    pspp_sheet_view_column_set_attributes      (PsppSheetViewColumn       *tree_column,
144                                                                   GtkCellRenderer         *cell_renderer,
145                                                                   ...) G_GNUC_NULL_TERMINATED;
146 void                    pspp_sheet_view_column_set_cell_data_func  (PsppSheetViewColumn       *tree_column,
147                                                                   GtkCellRenderer         *cell_renderer,
148                                                                   PsppSheetCellDataFunc      func,
149                                                                   gpointer                 func_data,
150                                                                   GDestroyNotify           destroy);
151 void                    pspp_sheet_view_column_clear_attributes    (PsppSheetViewColumn       *tree_column,
152                                                                   GtkCellRenderer         *cell_renderer);
153 void                    pspp_sheet_view_column_set_spacing         (PsppSheetViewColumn       *tree_column,
154                                                                   gint                     spacing);
155 gint                    pspp_sheet_view_column_get_spacing         (PsppSheetViewColumn       *tree_column);
156 void                    pspp_sheet_view_column_set_visible         (PsppSheetViewColumn       *tree_column,
157                                                                   gboolean                 visible);
158 gboolean                pspp_sheet_view_column_get_visible         (PsppSheetViewColumn       *tree_column);
159 void                    pspp_sheet_view_column_set_resizable       (PsppSheetViewColumn       *tree_column,
160                                                                   gboolean                 resizable);
161 gboolean                pspp_sheet_view_column_get_resizable       (PsppSheetViewColumn       *tree_column);
162 gint                    pspp_sheet_view_column_get_width           (PsppSheetViewColumn       *tree_column);
163 gint                    pspp_sheet_view_column_get_fixed_width     (PsppSheetViewColumn       *tree_column);
164 void                    pspp_sheet_view_column_set_fixed_width     (PsppSheetViewColumn       *tree_column,
165                                                                   gint                     fixed_width);
166 void                    pspp_sheet_view_column_set_min_width       (PsppSheetViewColumn       *tree_column,
167                                                                   gint                     min_width);
168 gint                    pspp_sheet_view_column_get_min_width       (PsppSheetViewColumn       *tree_column);
169 void                    pspp_sheet_view_column_set_max_width       (PsppSheetViewColumn       *tree_column,
170                                                                   gint                     max_width);
171 gint                    pspp_sheet_view_column_get_max_width       (PsppSheetViewColumn       *tree_column);
172 void                    pspp_sheet_view_column_clicked             (PsppSheetViewColumn       *tree_column);
173
174
175
176 /* Options for manipulating the column headers
177  */
178 void                    pspp_sheet_view_column_set_title           (PsppSheetViewColumn       *tree_column,
179                                                                   const gchar             *title);
180 G_CONST_RETURN gchar   *pspp_sheet_view_column_get_title           (PsppSheetViewColumn       *tree_column);
181 void                    pspp_sheet_view_column_set_expand          (PsppSheetViewColumn       *tree_column,
182                                                                   gboolean                 expand);
183 gboolean                pspp_sheet_view_column_get_expand          (PsppSheetViewColumn       *tree_column);
184 void                    pspp_sheet_view_column_set_clickable       (PsppSheetViewColumn       *tree_column,
185                                                                   gboolean                 clickable);
186 gboolean                pspp_sheet_view_column_get_clickable       (PsppSheetViewColumn       *tree_column);
187 void                    pspp_sheet_view_column_set_widget          (PsppSheetViewColumn       *tree_column,
188                                                                   GtkWidget               *widget);
189 GtkWidget              *pspp_sheet_view_column_get_widget          (PsppSheetViewColumn       *tree_column);
190 void                    pspp_sheet_view_column_set_alignment       (PsppSheetViewColumn       *tree_column,
191                                                                   gfloat                   xalign);
192 gfloat                  pspp_sheet_view_column_get_alignment       (PsppSheetViewColumn       *tree_column);
193 void                    pspp_sheet_view_column_set_reorderable     (PsppSheetViewColumn       *tree_column,
194                                                                   gboolean                 reorderable);
195 gboolean                pspp_sheet_view_column_get_reorderable     (PsppSheetViewColumn       *tree_column);
196
197
198
199 /* You probably only want to use pspp_sheet_view_column_set_sort_column_id.  The
200  * other sorting functions exist primarily to let others do their own custom sorting.
201  */
202 void                    pspp_sheet_view_column_set_sort_column_id  (PsppSheetViewColumn       *tree_column,
203                                                                   gint                     sort_column_id);
204 gint                    pspp_sheet_view_column_get_sort_column_id  (PsppSheetViewColumn       *tree_column);
205 void                    pspp_sheet_view_column_set_sort_indicator  (PsppSheetViewColumn       *tree_column,
206                                                                   gboolean                 setting);
207 gboolean                pspp_sheet_view_column_get_sort_indicator  (PsppSheetViewColumn       *tree_column);
208 void                    pspp_sheet_view_column_set_sort_order      (PsppSheetViewColumn       *tree_column,
209                                                                   GtkSortType              order);
210 GtkSortType             pspp_sheet_view_column_get_sort_order      (PsppSheetViewColumn       *tree_column);
211
212
213 /* These functions are meant primarily for interaction between the PsppSheetView and the column.
214  */
215 void                    pspp_sheet_view_column_cell_set_cell_data  (PsppSheetViewColumn       *tree_column,
216                                                                   GtkTreeModel            *tree_model,
217                                                                   GtkTreeIter             *iter);
218 void                    pspp_sheet_view_column_cell_get_size       (PsppSheetViewColumn       *tree_column,
219                                                                   const GdkRectangle      *cell_area,
220                                                                   gint                    *x_offset,
221                                                                   gint                    *y_offset,
222                                                                   gint                    *width,
223                                                                   gint                    *height);
224 gboolean                pspp_sheet_view_column_cell_is_visible     (PsppSheetViewColumn       *tree_column);
225 void                    pspp_sheet_view_column_focus_cell          (PsppSheetViewColumn       *tree_column,
226                                                                   GtkCellRenderer         *cell);
227 gboolean                pspp_sheet_view_column_cell_get_position   (PsppSheetViewColumn       *tree_column,
228                                                                   GtkCellRenderer         *cell_renderer,
229                                                                   gint                    *start_pos,
230                                                                   gint                    *width);
231 void                    pspp_sheet_view_column_queue_resize        (PsppSheetViewColumn       *tree_column);
232 GtkWidget              *pspp_sheet_view_column_get_tree_view       (PsppSheetViewColumn       *tree_column);
233
234
235 G_END_DECLS
236
237
238 #endif /* __PSPP_SHEET_VIEW_COLUMN_H__ */