1 /* This version of GtkSheet has been heavily modified, for the specific
2 requirements of PSPPIRE. */
5 /* GtkSheet widget for Gtk+.
6 * Copyright (C) 1999-2001 Adrian E. Feiguin <adrian@ifir.ifir.edu.ar>
8 * Based on GtkClist widget by Jay Painter, but major changes.
9 * Memory allocation routines inspired on SC (Spreadsheet Calculator)
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.
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.
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
26 #ifndef __GTK_SHEET_H__
27 #define __GTK_SHEET_H__
31 #include "gtkextra-sheet.h"
32 #include "gsheetmodel.h"
33 #include "psppire-axis.h"
41 GTK_SHEET_ROW_SELECTED,
42 GTK_SHEET_COLUMN_SELECTED,
43 GTK_SHEET_RANGE_SELECTED
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 ())
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 ())
56 typedef struct _GtkSheetClass GtkSheetClass;
57 typedef struct _GtkSheetCellAttr GtkSheetCellAttr;
59 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
62 struct _GtkSheetCellAttr
64 GtkJustification justification;
65 const PangoFontDescription *font_desc;
68 GtkSheetCellBorder border;
73 struct _GtkSheetHoverTitle
91 gboolean dispose_has_run;
99 GtkSelectionMode selection_mode;
101 /* Component colors */
102 GdkColor color[n_COLORS];
105 gint16 column_requisition;
106 gint16 row_requisition;
108 gboolean rows_resizable;
109 gboolean columns_resizable;
112 GtkSheetCell active_cell;
114 /* The GtkEntry used for editing the cells */
115 GtkWidget *entry_widget;
117 /* The type of entry_widget */
120 /* Handler of the "changed" callback for the entry widget */
121 glong entry_handler_id;
123 /* expanding selection */
124 GtkSheetCell selection_cell;
126 /* global selection button */
135 /* the scrolling window and its height and width to
136 * make things a little speedier */
137 GdkWindow *sheet_window;
139 /* border shadow style */
140 GtkShadowType shadow_type;
143 GdkRectangle column_title_area;
144 GdkWindow *column_title_window;
145 gboolean column_titles_visible;
146 /* TRUE if the cursor is over the column title window */
147 gboolean column_title_under;
150 GdkRectangle row_title_area;
151 GdkWindow *row_title_window;
152 gboolean row_titles_visible;
153 /* TRUE if the cursor is over the row title window */
154 gboolean row_title_under;
157 GtkAdjustment *hadjustment;
158 GtkAdjustment *vadjustment;
160 /* xor GC for the verticle drag line */
163 /* gc for drawing unselected cells */
167 /* cursor used to indicate dragging */
168 GdkCursor *cursor_drag;
170 /* the current x-pixel location of the xor-drag vline */
173 /* the current y-pixel location of the xor-drag hline */
176 /* current cell being dragged */
177 GtkSheetCell drag_cell;
178 /* current range being dragged */
179 GtkSheetRange drag_range;
181 /* Used for the subtitle (popups) */
183 GtkSheetHoverTitle *hover_window;
186 struct _GtkSheetClass
188 GtkBinClass parent_class;
190 void (*set_scroll_adjustments) (GtkSheet *sheet,
191 GtkAdjustment *hadjustment,
192 GtkAdjustment *vadjustment);
194 void (*select_row) (GtkSheet *sheet, gint row);
196 void (*select_column) (GtkSheet *sheet, gint column);
198 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
200 void (*resize_range) (GtkSheet *sheet,
201 GtkSheetRange *old_range,
202 GtkSheetRange *new_range);
204 void (*move_range) (GtkSheet *sheet,
205 GtkSheetRange *old_range,
206 GtkSheetRange *new_range);
208 gboolean (*traverse) (GtkSheet *sheet,
209 gint row, gint column,
210 gint *new_row, gint *new_column);
212 gboolean (*activate) (GtkSheet *sheet,
213 gint row, gint column);
215 void (*changed) (GtkSheet *sheet,
216 gint row, gint column);
219 GType gtk_sheet_get_type (void);
220 GtkType gtk_sheet_range_get_type (void);
223 /* create a new sheet */
224 GtkWidget * gtk_sheet_new (GSheetModel *model);
226 /* create a new sheet with custom entry */
228 gtk_sheet_new_with_custom_entry (GtkType entry_type);
231 void gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
233 GtkEntry *gtk_sheet_get_entry (GtkSheet *sheet);
236 void gtk_sheet_get_selected_range (GtkSheet *sheet,
237 GtkSheetRange *range);
239 void gtk_sheet_show_grid (GtkSheet *sheet,
242 gboolean gtk_sheet_grid_visible (GtkSheet *sheet);
245 /* scroll the viewing area of the sheet to the given column
246 * and row; row_align and col_align are between 0-1 representing the
247 * location the row should appear on the screen, 0.0 being top or left,
248 * 1.0 being bottom or right; if row or column is negative then there
250 void gtk_sheet_moveto (GtkSheet *sheet,
257 void gtk_sheet_show_row_titles (GtkSheet *sheet);
258 void gtk_sheet_hide_row_titles (GtkSheet *sheet);
259 void gtk_sheet_show_column_titles (GtkSheet *sheet);
260 void gtk_sheet_hide_column_titles (GtkSheet *sheet);
262 /* select the row. The range is then highlighted, and the bounds are stored
264 void gtk_sheet_select_row (GtkSheet * sheet, gint row);
266 /* select the column. The range is then highlighted, and the bounds are stored
268 void gtk_sheet_select_column (GtkSheet * sheet, gint column);
270 /* highlight the selected range and store bounds in sheet->range */
271 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
273 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
277 void gtk_sheet_unselect_range (GtkSheet *sheet);
279 /* set active cell where the entry will be displayed */
280 void gtk_sheet_set_active_cell (GtkSheet *sheet,
281 gint row, gint column);
283 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
284 ROW and/or COLUMN may be null if the caller is not interested in their
286 void gtk_sheet_get_active_cell (GtkSheet *sheet,
287 gint *row, gint *column);
289 /* get cell contents */
290 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
293 /* get cell attributes of the given cell */
294 /* TRUE means that the cell is currently allocated */
295 gboolean gtk_sheet_get_attributes (const GtkSheet *sheet,
297 GtkSheetCellAttr *attributes);
299 void gtk_sheet_set_model (GtkSheet *sheet,
302 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
308 #endif /* __GTK_SHEET_H__ */