Fix problem redrawing old active cell
[pspp-builds.git] / lib / gtksheet / gsheetmodel.h
1 /* GSheetModel --- an abstract model for the GtkSheet widget.
2  * Copyright (C) 2006 Free Software Foundation
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 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  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17  */
18
19 #ifndef __G_SHEET_MODEL_H__
20 #define __G_SHEET_MODEL_H__
21
22
23 /* This file provides an abstract interface or the data displayed by the
24    GtkSheet widget */
25
26 #include <glib-object.h>
27 #include <gdk/gdk.h>
28 #include <gtk/gtk.h>
29 #include "gtkextra-sheet.h"
30
31 G_BEGIN_DECLS
32
33 #define G_TYPE_SHEET_MODEL            (g_sheet_model_get_type ())
34 #define G_SHEET_MODEL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SHEET_MODEL, GSheetModel))
35 #define G_IS_SHEET_MODEL(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SHEET_MODEL))
36 #define G_SHEET_MODEL_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SHEET_MODEL, GSheetModelIface))
37
38 typedef enum
39 {
40   GTK_SHEET_LEFT_BORDER     = 1 << 0,
41   GTK_SHEET_RIGHT_BORDER    = 1 << 1,
42   GTK_SHEET_TOP_BORDER      = 1 << 2,
43   GTK_SHEET_BOTTOM_BORDER   = 1 << 3
44 } GtkSheetBorderType ;
45
46
47 typedef struct _GSheetModel        GSheetModel; /* Dummy typedef */
48 typedef struct _GSheetModelIface   GSheetModelIface;
49 typedef struct _GtkSheetRange GtkSheetRange;
50 typedef struct _GtkSheetCellBorder     GtkSheetCellBorder;
51
52 struct _GtkSheetRange
53 {
54   gint row0, col0; /* upper-left cell */
55   gint rowi, coli; /* lower-right cell */
56 };
57
58 struct _GtkSheetCellBorder
59 {
60   GtkSheetBorderType mask;
61   guint width;
62   GdkLineStyle line_style;
63   GdkCapStyle cap_style;
64   GdkJoinStyle join_style;
65   GdkColor color;
66 };
67
68
69
70 struct _GSheetModelIface
71 {
72   GTypeInterface g_iface;
73
74   gboolean free_strings;
75
76   /* Signals */
77   void         (* range_changed)    (GSheetModel *sheet_model,
78                                      glong row0, glong col0,
79                                      glong rowi, glong coli);
80
81   void         (* rows_inserted)    (GSheetModel *sheet_model,
82                                      glong row, glong n_rows);
83
84   void         (* rows_deleted)     (GSheetModel *sheet_model,
85                                      glong row, glong n_rows);
86
87   void         (* columns_inserted)    (GSheetModel *sheet_model,
88                                         glong column, glong n_columns);
89
90   void         (* columns_deleted)     (GSheetModel *sheet_model,
91                                         glong column, glong n_columns);
92
93
94
95
96
97
98   /* Virtual Table */
99
100   gchar *      (* get_string)      (const GSheetModel *sheet_model,
101                                     glong row, glong column);
102
103   gboolean  (* set_string) (GSheetModel *sheet_model,
104                             const gchar *s, glong row, glong column);
105
106   gboolean  (* clear_datum) (GSheetModel *sheet_model,
107                              glong row, glong column);
108
109   gboolean (* is_editable) (const GSheetModel *sheet_model, glong row, glong column);
110
111   GdkColor *  (* get_foreground) (const GSheetModel *sheet_model,
112                                   glong row, glong column);
113
114   GdkColor *  (* get_background) (const GSheetModel *sheet_model,
115                                   glong row, glong column);
116
117   const GtkJustification *  (* get_justification) (const GSheetModel *sheet_model,
118                                                    glong row, glong column);
119
120   const PangoFontDescription *  (* get_font_desc) (const GSheetModel *sheet_model,
121                                                    glong row, glong column);
122
123   const GtkSheetCellBorder *  (* get_cell_border) (const GSheetModel *sheet_model,
124                                                    glong row, glong column);
125
126
127
128   /* column related metadata */
129
130   gchar * (*get_column_title) (const GSheetModel *, gint col);
131   gchar * (*get_column_subtitle) (const GSheetModel *, gint col);
132   gboolean (*get_column_sensitivity) (const GSheetModel *, gint col);
133   GtkJustification (*get_column_justification) (const GSheetModel *mode, gint col);
134   const GtkSheetButton * (* get_button) (const GSheetModel *model, gint col);
135
136   glong (*get_column_count) (const GSheetModel *model);
137
138
139   /* row related metadata */
140   gchar * (*get_row_title) (const GSheetModel *, gint row);
141   gchar * (*get_row_subtitle) (const GSheetModel *, gint row);
142   glong (*get_row_count) (const GSheetModel *model);
143   gboolean (*get_row_sensitivity) (const GSheetModel *, gint row);
144 };
145
146
147
148 GType              g_sheet_model_get_type   (void) G_GNUC_CONST;
149
150
151 gchar * g_sheet_model_get_string (const GSheetModel *sheet_model,
152                                   glong row, glong column);
153
154 gboolean  g_sheet_model_set_string (GSheetModel *sheet_model,
155                                     const gchar *s,
156                                     glong row, glong column);
157
158 gboolean g_sheet_model_datum_clear    (GSheetModel *sheet_model,
159                                        glong row, glong column);
160
161
162 void g_sheet_model_range_changed (GSheetModel *sheet_model,
163                                   glong row0, glong col0,
164                                   glong rowi, glong coli);
165
166 void g_sheet_model_rows_deleted (GSheetModel *sheet_model,
167                                  glong row, glong n_rows);
168
169 void g_sheet_model_rows_inserted (GSheetModel *sheet_model,
170                                   glong row, glong n_rows);
171
172 void g_sheet_model_columns_inserted (GSheetModel *sheet_model,
173                                      glong column, glong n_columns);
174
175 void g_sheet_model_columns_deleted (GSheetModel *sheet_model,
176                                     glong column, glong n_columns);
177
178
179 gboolean g_sheet_model_is_editable (const GSheetModel *model,
180                                     glong row, glong column);
181
182 gboolean g_sheet_model_is_visible
183  (const GSheetModel *model, glong row, glong column);
184
185
186 GdkColor *g_sheet_model_get_foreground
187  (const GSheetModel *model, glong row, glong column);
188
189 GdkColor *g_sheet_model_get_background
190  (const GSheetModel *model, glong row, glong column);
191
192
193 const GtkJustification *g_sheet_model_get_justification
194  (const GSheetModel *model, glong row, glong column);
195
196
197 const PangoFontDescription *g_sheet_model_get_font_desc
198  (const GSheetModel *model, glong row, glong column);
199
200 const GtkSheetCellBorder * g_sheet_model_get_cell_border
201  (const GSheetModel *model, glong row, glong column);
202
203 gboolean g_sheet_model_free_strings (const GSheetModel *sheet_model);
204
205 glong g_sheet_model_get_column_count (const GSheetModel *sheet_model);
206
207 gint g_sheet_model_get_row_count (const GSheetModel *sheet_model);
208
209 \f
210
211 gboolean g_sheet_model_get_column_sensitivity (const GSheetModel *model,
212                                                gint col);
213
214 gchar * g_sheet_model_get_column_subtitle (const GSheetModel *model,
215                                             gint col);
216
217 GtkSheetButton * g_sheet_model_get_column_button (const GSheetModel *, gint);
218
219 GtkJustification g_sheet_model_get_column_justification (const GSheetModel *,
220                                                          gint);
221
222 \f
223
224 gboolean g_sheet_model_get_row_sensitivity (const GSheetModel *model,
225                                             gint row);
226
227
228 gchar * g_sheet_model_get_row_subtitle (const GSheetModel *model,
229                                             gint row);
230
231
232 GtkSheetButton * g_sheet_model_get_row_button (const GSheetModel *, gint);
233
234
235
236
237 G_END_DECLS
238
239 #endif /* __G_SHEET_MODEL_H__ */