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;
67 GtkSheetCellBorder border;
71 struct _GtkSheetHoverTitle
89 gboolean dispose_has_run;
97 GtkSelectionMode selection_mode;
99 /* Component colors */
100 GdkColor color[n_COLORS];
104 GtkSheetCell active_cell;
106 /* The GtkEntry used for editing the cells */
107 GtkWidget *entry_widget;
109 /* The type of entry_widget */
112 /* Handler of the "changed" callback for the entry widget */
113 glong entry_handler_id;
115 /* expanding selection */
116 GtkSheetCell selection_cell;
118 /* global selection button */
127 /* the scrolling window and its height and width to
128 * make things a little speedier */
129 GdkWindow *sheet_window;
131 /* border shadow style */
132 GtkShadowType shadow_type;
135 GdkRectangle column_title_area;
136 GdkWindow *column_title_window;
137 gboolean column_titles_visible;
138 /* TRUE if the cursor is over the column title window */
139 gboolean column_title_under;
142 GdkRectangle row_title_area;
143 GdkWindow *row_title_window;
144 gboolean row_titles_visible;
145 /* TRUE if the cursor is over the row title window */
146 gboolean row_title_under;
149 GtkAdjustment *hadjustment;
150 GtkAdjustment *vadjustment;
152 /* xor GC for the verticle drag line */
155 /* gc for drawing unselected cells */
159 /* cursor used to indicate dragging */
160 GdkCursor *cursor_drag;
162 /* the current x-pixel location of the xor-drag vline */
165 /* the current y-pixel location of the xor-drag hline */
168 /* current cell being dragged */
169 GtkSheetCell drag_cell;
170 /* current range being dragged */
171 GtkSheetRange drag_range;
173 /* Used for the subtitle (popups) */
175 GtkSheetHoverTitle *hover_window;
178 struct _GtkSheetClass
180 GtkBinClass parent_class;
182 void (*set_scroll_adjustments) (GtkSheet *sheet,
183 GtkAdjustment *hadjustment,
184 GtkAdjustment *vadjustment);
186 void (*select_row) (GtkSheet *sheet, gint row);
188 void (*select_column) (GtkSheet *sheet, gint column);
190 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
192 void (*resize_range) (GtkSheet *sheet,
193 GtkSheetRange *old_range,
194 GtkSheetRange *new_range);
196 void (*move_range) (GtkSheet *sheet,
197 GtkSheetRange *old_range,
198 GtkSheetRange *new_range);
200 gboolean (*traverse) (GtkSheet *sheet,
201 gint row, gint column,
202 gint *new_row, gint *new_column);
204 gboolean (*activate) (GtkSheet *sheet,
205 gint row, gint column);
207 void (*changed) (GtkSheet *sheet,
208 gint row, gint column);
211 GType gtk_sheet_get_type (void);
212 GtkType gtk_sheet_range_get_type (void);
215 /* create a new sheet */
216 GtkWidget * gtk_sheet_new (GSheetModel *model);
218 /* create a new sheet with custom entry */
220 gtk_sheet_new_with_custom_entry (GtkType entry_type);
223 void gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
225 GtkEntry *gtk_sheet_get_entry (GtkSheet *sheet);
228 void gtk_sheet_get_selected_range (GtkSheet *sheet,
229 GtkSheetRange *range);
231 void gtk_sheet_show_grid (GtkSheet *sheet,
234 gboolean gtk_sheet_grid_visible (GtkSheet *sheet);
237 /* scroll the viewing area of the sheet to the given column
238 * and row; row_align and col_align are between 0-1 representing the
239 * location the row should appear on the screen, 0.0 being top or left,
240 * 1.0 being bottom or right; if row or column is negative then there
242 void gtk_sheet_moveto (GtkSheet *sheet,
249 void gtk_sheet_show_row_titles (GtkSheet *sheet);
250 void gtk_sheet_hide_row_titles (GtkSheet *sheet);
251 void gtk_sheet_show_column_titles (GtkSheet *sheet);
252 void gtk_sheet_hide_column_titles (GtkSheet *sheet);
254 /* select the row. The range is then highlighted, and the bounds are stored
256 void gtk_sheet_select_row (GtkSheet * sheet, gint row);
258 /* select the column. The range is then highlighted, and the bounds are stored
260 void gtk_sheet_select_column (GtkSheet * sheet, gint column);
262 /* highlight the selected range and store bounds in sheet->range */
263 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
265 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
269 void gtk_sheet_unselect_range (GtkSheet *sheet);
271 /* set active cell where the entry will be displayed */
272 void gtk_sheet_set_active_cell (GtkSheet *sheet,
273 gint row, gint column);
275 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
276 ROW and/or COLUMN may be null if the caller is not interested in their
278 void gtk_sheet_get_active_cell (GtkSheet *sheet,
279 gint *row, gint *column);
281 /* get cell contents */
282 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
285 /* get cell attributes of the given cell */
286 /* TRUE means that the cell is currently allocated */
287 gboolean gtk_sheet_get_attributes (const GtkSheet *sheet,
289 GtkSheetCellAttr *attributes);
291 void gtk_sheet_set_model (GtkSheet *sheet,
294 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
300 #endif /* __GTK_SHEET_H__ */