Fixed a problem redrawing the active cell.
[pspp-builds.git] / lib / gtksheet / gtksheet.h
1 /* This version of GtkSheet has been heavily modified, for the specific
2    requirements of PSPPIRE. */
3
4
5 /* GtkSheet widget for Gtk+.
6  * Copyright (C) 1999-2001 Adrian E. Feiguin <adrian@ifir.ifir.edu.ar>
7  *
8  * Based on GtkClist widget by Jay Painter, but major changes.
9  * Memory allocation routines inspired on SC (Spreadsheet Calculator)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with this library; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
24  */
25
26 #ifndef __GTK_SHEET_H__
27 #define __GTK_SHEET_H__
28
29 #include <gtk/gtk.h>
30
31 #include "gtkextra-sheet.h"
32 #include "gsheetmodel.h"
33 #include "psppire-axis.h"
34
35 G_BEGIN_DECLS
36
37 /* sheet->state */
38 enum
39 {
40   GTK_SHEET_NORMAL,
41   GTK_SHEET_ROW_SELECTED,
42   GTK_SHEET_COLUMN_SELECTED,
43   GTK_SHEET_RANGE_SELECTED
44 };
45
46
47 #define GTK_TYPE_SHEET_RANGE (gtk_sheet_range_get_type ())
48 #define GTK_TYPE_SHEET_CELL (gtk_sheet_cell_get_type ())
49 #define GTK_TYPE_SHEET (gtk_sheet_get_type ())
50
51 #define GTK_SHEET(obj)          GTK_CHECK_CAST (obj, gtk_sheet_get_type (), GtkSheet)
52 #define GTK_SHEET_CLASS(klass)  GTK_CHECK_CLASS_CAST (klass, gtk_sheet_get_type (), GtkSheetClass)
53 #define GTK_IS_SHEET(obj)       GTK_CHECK_TYPE (obj, gtk_sheet_get_type ())
54
55
56 typedef struct _GtkSheetClass GtkSheetClass;
57 typedef struct _GtkSheetCellAttr     GtkSheetCellAttr;
58
59 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
60
61
62 struct _GtkSheetCellAttr
63 {
64   GtkJustification justification;
65   GdkColor foreground;
66   GdkColor background;
67   GtkSheetCellBorder border;
68   gboolean is_editable;
69 };
70
71 struct _GtkSheetHoverTitle
72 {
73   GtkWidget *window;
74   GtkWidget *label;
75   gint row, column;
76 };
77
78 enum
79   {
80     BG_COLOR,
81     GRID_COLOR,
82     n_COLORS
83   };
84
85 struct _GtkSheet
86 {
87   GtkBin parent;
88
89   gboolean dispose_has_run;
90   PsppireAxis *haxis;
91   PsppireAxis *vaxis;
92
93   guint16 flags;
94
95   GSheetModel *model;
96
97   GtkSelectionMode selection_mode;
98
99   /* Component colors */
100   GdkColor color[n_COLORS];
101   gboolean show_grid;
102
103   /* active cell */
104   GtkSheetCell active_cell;
105
106   /* The GtkEntry used for editing the cells */
107   GtkWidget *entry_widget;
108
109   /* The type of entry_widget */
110   GtkType entry_type;
111
112   /* expanding selection */
113   GtkSheetCell selection_cell;
114
115   /* global selection button */
116   GtkWidget *button;
117
118   /* sheet state */
119   gint state;
120
121   /* selected range */
122   GtkSheetRange range;
123
124   /* the scrolling window and its height and width to
125    * make things a little speedier */
126   GdkWindow *sheet_window;
127
128   /* border shadow style */
129   GtkShadowType shadow_type;
130
131   /* Column Titles */
132   GdkRectangle column_title_area;
133   GdkWindow *column_title_window;
134   gboolean column_titles_visible;
135   /* TRUE if the cursor is over the column title window */
136   gboolean column_title_under;
137
138   /* Row Titles */
139   GdkRectangle row_title_area;
140   GdkWindow *row_title_window;
141   gboolean row_titles_visible;
142   /* TRUE if the cursor is over the row title window */
143   gboolean row_title_under;
144
145   /*scrollbars*/
146   GtkAdjustment *hadjustment;
147   GtkAdjustment *vadjustment;
148
149   /* xor GC for the verticle drag line */
150   GdkGC *xor_gc;
151
152   /* gc for drawing unselected cells */
153   GdkGC *fg_gc;
154   GdkGC *bg_gc;
155
156   /* cursor used to indicate dragging */
157   GdkCursor *cursor_drag;
158
159   /* the current x-pixel location of the xor-drag vline */
160   gint x_drag;
161
162   /* the current y-pixel location of the xor-drag hline */
163   gint y_drag;
164
165   /* current cell being dragged */
166   GtkSheetCell drag_cell;
167   /* current range being dragged */
168   GtkSheetRange drag_range;
169
170   /* Used for the subtitle (popups) */
171   gint motion_timer;
172   GtkSheetHoverTitle *hover_window;
173 };
174
175 struct _GtkSheetClass
176 {
177   GtkBinClass parent_class;
178
179  void (*set_scroll_adjustments) (GtkSheet *sheet,
180                                  GtkAdjustment *hadjustment,
181                                  GtkAdjustment *vadjustment);
182
183  void (*select_row)             (GtkSheet *sheet, gint row);
184
185  void (*select_column)          (GtkSheet *sheet, gint column);
186
187  void (*select_range)           (GtkSheet *sheet, GtkSheetRange *range);
188
189  void (*resize_range)           (GtkSheet *sheet,
190                                 GtkSheetRange *old_range,
191                                 GtkSheetRange *new_range);
192
193  void (*move_range)             (GtkSheet *sheet,
194                                 GtkSheetRange *old_range,
195                                 GtkSheetRange *new_range);
196
197  gboolean (*traverse)           (GtkSheet *sheet,
198                                 gint row, gint column,
199                                 gint *new_row, gint *new_column);
200
201  gboolean (*activate)           (GtkSheet *sheet,
202                                 gint row, gint column);
203
204  void (*changed)                (GtkSheet *sheet,
205                                 gint row, gint column);
206 };
207
208 GType gtk_sheet_get_type (void);
209 GtkType gtk_sheet_range_get_type (void);
210
211
212 /* create a new sheet */
213 GtkWidget * gtk_sheet_new (GSheetModel *model);
214
215 /* create a new sheet with custom entry */
216 GtkWidget *
217 gtk_sheet_new_with_custom_entry (GtkType entry_type);
218
219 /* Change entry */
220 void gtk_sheet_change_entry             (GtkSheet *sheet, GtkType entry_type);
221
222 GtkEntry *gtk_sheet_get_entry    (GtkSheet *sheet);
223
224
225 void gtk_sheet_get_selected_range (GtkSheet *sheet,
226                                          GtkSheetRange *range);
227
228 void gtk_sheet_show_grid          (GtkSheet *sheet,
229                                          gboolean show);
230
231 gboolean gtk_sheet_grid_visible   (GtkSheet *sheet);
232
233
234 /* scroll the viewing area of the sheet to the given column
235  * and row; row_align and col_align are between 0-1 representing the
236  * location the row should appear on the screen, 0.0 being top or left,
237  * 1.0 being bottom or right; if row or column is negative then there
238  * is no change */
239 void gtk_sheet_moveto (GtkSheet *sheet,
240                   gint row,
241                   gint column,
242                   gfloat row_align,
243                   gfloat col_align);
244
245
246 void gtk_sheet_show_row_titles          (GtkSheet *sheet);
247 void gtk_sheet_hide_row_titles          (GtkSheet *sheet);
248 void gtk_sheet_show_column_titles       (GtkSheet *sheet);
249 void gtk_sheet_hide_column_titles       (GtkSheet *sheet);
250
251 /* select the row. The range is then highlighted, and the bounds are stored
252  * in sheet->range  */
253 void gtk_sheet_select_row    (GtkSheet * sheet,  gint row);
254
255 /* select the column. The range is then highlighted, and the bounds are stored
256  * in sheet->range  */
257 void gtk_sheet_select_column (GtkSheet * sheet,  gint column);
258
259 /* highlight the selected range and store bounds in sheet->range */
260 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
261
262 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
263
264
265 /* obvious */
266 void gtk_sheet_unselect_range           (GtkSheet *sheet);
267
268 /* set active cell where the entry will be displayed */
269 void gtk_sheet_set_active_cell (GtkSheet *sheet,
270                                 gint row, gint column);
271
272 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
273    ROW and/or COLUMN may be null if the caller is not interested in their
274    values */
275 void gtk_sheet_get_active_cell (GtkSheet *sheet,
276                                         gint *row, gint *column);
277
278 /* get cell contents */
279 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
280
281
282 /* get cell attributes of the given cell */
283 /* TRUE means that the cell is currently allocated */
284 gboolean gtk_sheet_get_attributes       (const GtkSheet *sheet,
285                                         gint row, gint col,
286                                         GtkSheetCellAttr *attributes);
287
288 void gtk_sheet_set_model (GtkSheet *sheet,
289                                    GSheetModel *model);
290
291 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
292
293
294 G_END_DECLS
295
296
297 #endif /* __GTK_SHEET_H__ */
298
299