2 Copyright (C) 2006, 2008 Free Software Foundation
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.
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.
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/>.
18 This file is derived from the gtksheet.c and extensively modified for the
19 requirements of PSPPIRE. The changes are copyright by the
20 Free Software Foundation. The copyright notice for the original work is
24 GtkSheet widget for Gtk+.
25 * Copyright (C) 1999-2001 Adrian E. Feiguin <adrian@ifir.ifir.edu.ar>
27 * Based on GtkClist widget by Jay Painter, but major changes.
28 * Memory allocation routines inspired on SC (Spreadsheet Calculator)
30 * This library is free software; you can redistribute it and/or
31 * modify it under the terms of the GNU Lesser General Public
32 * License as published by the Free Software Foundation; either
33 * version 2.1 of the License, or (at your option) any later version.
35 * This library is distributed in the hope that it will be useful,
36 * but WITHOUT ANY WARRANTY; without even the implied warranty of
37 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
38 * Lesser General Public License for more details.
40 * You should have received a copy of the GNU Lesser General Public
41 * License along with this library; if not, write to the Free Software
42 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
45 #ifndef __PSPPIRE_SHEET_H__
46 #define __PSPPIRE_SHEET_H__
50 #include "gtkextra-sheet.h"
51 #include <ui/gui/sheet/psppire-sheetmodel.h>
52 #include <ui/gui/sheet/psppire-axis.h>
56 /* sheet->select_status */
60 PSPPIRE_SHEET_ROW_SELECTED,
61 PSPPIRE_SHEET_COLUMN_SELECTED,
62 PSPPIRE_SHEET_RANGE_SELECTED
66 #define PSPPIRE_TYPE_SHEET_RANGE (psppire_sheet_range_get_type ())
67 #define PSPPIRE_TYPE_SHEET_CELL (psppire_sheet_cell_get_type ())
68 #define PSPPIRE_TYPE_SHEET (psppire_sheet_get_type ())
70 #define PSPPIRE_SHEET(obj) GTK_CHECK_CAST (obj, psppire_sheet_get_type (), PsppireSheet)
71 #define PSPPIRE_SHEET_CLASS(klass) GTK_CHECK_CLASS_CAST (klass, psppire_sheet_get_type (), PsppireSheetClass)
72 #define PSPPIRE_IS_SHEET(obj) GTK_CHECK_TYPE (obj, psppire_sheet_get_type ())
75 typedef struct _PsppireSheetClass PsppireSheetClass;
76 typedef struct _PsppireSheetCellAttr PsppireSheetCellAttr;
78 typedef struct _PsppireSheetHoverTitle PsppireSheetHoverTitle;
81 struct _PsppireSheetCellAttr
83 GtkJustification justification;
86 PsppireSheetCellBorder border;
89 struct _PsppireSheetHoverTitle
107 gboolean dispose_has_run;
113 PsppireSheetModel *model;
115 /* Component colors */
116 GdkColor color[n_COLORS];
120 PsppireSheetCell active_cell;
122 /* The GtkEntry used for editing the cells */
123 GtkWidget *entry_widget;
125 /* The type of entry_widget */
128 /* global selection button */
135 PsppireSheetRange range;
137 /* The space between a cell's contents and its border */
138 GtkBorder *cell_padding;
140 /* the scrolling window and its height and width to
141 * make things a little speedier */
142 GdkWindow *sheet_window;
144 /* border shadow style */
145 GtkShadowType shadow_type;
148 GdkRectangle column_title_area;
149 GdkWindow *column_title_window;
150 gboolean column_titles_visible;
151 /* TRUE if the cursor is over the column title window */
152 gboolean column_title_under;
155 GdkRectangle row_title_area;
156 GdkWindow *row_title_window;
157 gboolean row_titles_visible;
158 /* TRUE if the cursor is over the row title window */
159 gboolean row_title_under;
162 GtkAdjustment *hadjustment;
163 GtkAdjustment *vadjustment;
165 /* xor GC for the verticle drag line */
168 /* gc for drawing unselected cells */
172 /* cursor used to indicate dragging */
173 GdkCursor *cursor_drag;
175 /* the current x-pixel location of the xor-drag vline */
178 /* the current y-pixel location of the xor-drag hline */
181 /* current cell being dragged */
182 PsppireSheetCell drag_cell;
183 /* current range being dragged */
184 PsppireSheetRange drag_range;
186 /* Used for the subtitle (popups) */
188 PsppireSheetHoverTitle *hover_window;
190 gulong update_handler_id;
193 struct _PsppireSheetClass
195 GtkBinClass parent_class;
197 gboolean (*set_scroll_adjustments) (PsppireSheet *sheet,
198 GtkAdjustment *hadjustment,
199 GtkAdjustment *vadjustment);
201 void (*select_row) (PsppireSheet *sheet, gint row);
203 void (*select_column) (PsppireSheet *sheet, gint column);
205 void (*select_range) (PsppireSheet *sheet, PsppireSheetRange *range);
207 void (*resize_range) (PsppireSheet *sheet,
208 PsppireSheetRange *old_range,
209 PsppireSheetRange *new_range);
211 void (*move_range) (PsppireSheet *sheet,
212 PsppireSheetRange *old_range,
213 PsppireSheetRange *new_range);
215 gboolean (*traverse) (PsppireSheet *sheet,
216 gint row, gint column,
217 gint *new_row, gint *new_column);
219 gboolean (*activate) (PsppireSheet *sheet,
220 gint row, gint column);
222 void (*changed) (PsppireSheet *sheet,
223 gint row, gint column);
226 GType psppire_sheet_get_type (void);
227 GtkType psppire_sheet_range_get_type (void);
230 /* create a new sheet */
231 GtkWidget * psppire_sheet_new (PsppireSheetModel *model);
233 /* create a new sheet with custom entry */
235 psppire_sheet_new_with_custom_entry (GtkType entry_type);
238 void psppire_sheet_change_entry (PsppireSheet *sheet, GtkType entry_type);
240 GtkEntry *psppire_sheet_get_entry (PsppireSheet *sheet);
243 void psppire_sheet_get_selected_range (PsppireSheet *sheet,
244 PsppireSheetRange *range);
246 void psppire_sheet_show_grid (PsppireSheet *sheet,
249 gboolean psppire_sheet_grid_visible (PsppireSheet *sheet);
252 /* scroll the viewing area of the sheet to the given column
253 * and row; row_align and col_align are between 0-1 representing the
254 * location the row should appear on the screen, 0.0 being top or left,
255 * 1.0 being bottom or right; if row or column is negative then there
257 void psppire_sheet_moveto (PsppireSheet *sheet,
264 void psppire_sheet_show_row_titles (PsppireSheet *sheet);
265 void psppire_sheet_hide_row_titles (PsppireSheet *sheet);
266 void psppire_sheet_show_column_titles (PsppireSheet *sheet);
267 void psppire_sheet_hide_column_titles (PsppireSheet *sheet);
269 /* select the row. The range is then highlighted, and the bounds are stored
271 void psppire_sheet_select_row (PsppireSheet * sheet, gint row);
273 /* select the column. The range is then highlighted, and the bounds are stored
275 void psppire_sheet_select_column (PsppireSheet * sheet, gint column);
277 /* highlight the selected range and store bounds in sheet->range */
278 void psppire_sheet_select_range (PsppireSheet *sheet, const PsppireSheetRange *range);
280 void psppire_sheet_get_visible_range (PsppireSheet *sheet, PsppireSheetRange *range);
284 void psppire_sheet_unselect_range (PsppireSheet *sheet);
286 /* set active cell where the entry will be displayed */
287 void psppire_sheet_set_active_cell (PsppireSheet *sheet,
288 gint row, gint column);
290 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
291 ROW and/or COLUMN may be null if the caller is not interested in their
293 void psppire_sheet_get_active_cell (PsppireSheet *sheet,
294 gint *row, gint *column);
296 /* get cell contents */
297 gchar *psppire_sheet_cell_get_text (const PsppireSheet *sheet, gint row, gint col);
300 void psppire_sheet_set_model (PsppireSheet *sheet,
301 PsppireSheetModel *model);
303 PsppireSheetModel * psppire_sheet_get_model (const PsppireSheet *sheet);
309 #endif /* __PSPPIRE_SHEET_H__ */