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;
72 struct _GtkSheetHoverTitle
90 gboolean dispose_has_run;
98 GtkSelectionMode selection_mode;
100 /* Component colors */
101 GdkColor color[n_COLORS];
104 gint16 column_requisition;
105 gint16 row_requisition;
107 gboolean rows_resizable;
108 gboolean columns_resizable;
111 GtkSheetCell active_cell;
113 /* The GtkEntry used for editing the cells */
114 GtkWidget *entry_widget;
116 /* The type of entry_widget */
119 /* Handler of the "changed" callback for the entry widget */
120 glong entry_handler_id;
122 /* expanding selection */
123 GtkSheetCell selection_cell;
125 /* global selection button */
134 /* the scrolling window and its height and width to
135 * make things a little speedier */
136 GdkWindow *sheet_window;
138 /* border shadow style */
139 GtkShadowType shadow_type;
142 GdkRectangle column_title_area;
143 GdkWindow *column_title_window;
144 gboolean column_titles_visible;
145 /* TRUE if the cursor is over the column title window */
146 gboolean column_title_under;
149 GdkRectangle row_title_area;
150 GdkWindow *row_title_window;
151 gboolean row_titles_visible;
152 /* TRUE if the cursor is over the row title window */
153 gboolean row_title_under;
156 GtkAdjustment *hadjustment;
157 GtkAdjustment *vadjustment;
159 /* xor GC for the verticle drag line */
162 /* gc for drawing unselected cells */
166 /* cursor used to indicate dragging */
167 GdkCursor *cursor_drag;
169 /* the current x-pixel location of the xor-drag vline */
172 /* the current y-pixel location of the xor-drag hline */
175 /* current cell being dragged */
176 GtkSheetCell drag_cell;
177 /* current range being dragged */
178 GtkSheetRange drag_range;
180 /* Used for the subtitle (popups) */
182 GtkSheetHoverTitle *hover_window;
185 struct _GtkSheetClass
187 GtkBinClass parent_class;
189 void (*set_scroll_adjustments) (GtkSheet *sheet,
190 GtkAdjustment *hadjustment,
191 GtkAdjustment *vadjustment);
193 void (*select_row) (GtkSheet *sheet, gint row);
195 void (*select_column) (GtkSheet *sheet, gint column);
197 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
199 void (*resize_range) (GtkSheet *sheet,
200 GtkSheetRange *old_range,
201 GtkSheetRange *new_range);
203 void (*move_range) (GtkSheet *sheet,
204 GtkSheetRange *old_range,
205 GtkSheetRange *new_range);
207 gboolean (*traverse) (GtkSheet *sheet,
208 gint row, gint column,
209 gint *new_row, gint *new_column);
211 gboolean (*activate) (GtkSheet *sheet,
212 gint row, gint column);
214 void (*changed) (GtkSheet *sheet,
215 gint row, gint column);
218 GType gtk_sheet_get_type (void);
219 GtkType gtk_sheet_range_get_type (void);
222 /* create a new sheet */
223 GtkWidget * gtk_sheet_new (GSheetModel *model);
225 /* create a new sheet with custom entry */
227 gtk_sheet_new_with_custom_entry (GtkType entry_type);
230 void gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
232 GtkEntry *gtk_sheet_get_entry (GtkSheet *sheet);
235 void gtk_sheet_get_selected_range (GtkSheet *sheet,
236 GtkSheetRange *range);
238 void gtk_sheet_show_grid (GtkSheet *sheet,
241 gboolean gtk_sheet_grid_visible (GtkSheet *sheet);
244 /* scroll the viewing area of the sheet to the given column
245 * and row; row_align and col_align are between 0-1 representing the
246 * location the row should appear on the screen, 0.0 being top or left,
247 * 1.0 being bottom or right; if row or column is negative then there
249 void gtk_sheet_moveto (GtkSheet *sheet,
256 void gtk_sheet_show_row_titles (GtkSheet *sheet);
257 void gtk_sheet_hide_row_titles (GtkSheet *sheet);
258 void gtk_sheet_show_column_titles (GtkSheet *sheet);
259 void gtk_sheet_hide_column_titles (GtkSheet *sheet);
261 /* select the row. The range is then highlighted, and the bounds are stored
263 void gtk_sheet_select_row (GtkSheet * sheet, gint row);
265 /* select the column. The range is then highlighted, and the bounds are stored
267 void gtk_sheet_select_column (GtkSheet * sheet, gint column);
269 /* highlight the selected range and store bounds in sheet->range */
270 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
272 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
276 void gtk_sheet_unselect_range (GtkSheet *sheet);
278 /* set active cell where the entry will be displayed */
279 void gtk_sheet_set_active_cell (GtkSheet *sheet,
280 gint row, gint column);
282 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
283 ROW and/or COLUMN may be null if the caller is not interested in their
285 void gtk_sheet_get_active_cell (GtkSheet *sheet,
286 gint *row, gint *column);
288 /* get cell contents */
289 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
292 /* get cell attributes of the given cell */
293 /* TRUE means that the cell is currently allocated */
294 gboolean gtk_sheet_get_attributes (const GtkSheet *sheet,
296 GtkSheetCellAttr *attributes);
298 void gtk_sheet_set_model (GtkSheet *sheet,
301 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
307 #endif /* __GTK_SHEET_H__ */