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];
103 gint16 column_requisition;
104 gint16 row_requisition;
107 GtkSheetCell active_cell;
109 /* The GtkEntry used for editing the cells */
110 GtkWidget *entry_widget;
112 /* The type of entry_widget */
115 /* Handler of the "changed" callback for the entry widget */
116 glong entry_handler_id;
118 /* expanding selection */
119 GtkSheetCell selection_cell;
121 /* global selection button */
130 /* the scrolling window and its height and width to
131 * make things a little speedier */
132 GdkWindow *sheet_window;
134 /* border shadow style */
135 GtkShadowType shadow_type;
138 GdkRectangle column_title_area;
139 GdkWindow *column_title_window;
140 gboolean column_titles_visible;
141 /* TRUE if the cursor is over the column title window */
142 gboolean column_title_under;
145 GdkRectangle row_title_area;
146 GdkWindow *row_title_window;
147 gboolean row_titles_visible;
148 /* TRUE if the cursor is over the row title window */
149 gboolean row_title_under;
152 GtkAdjustment *hadjustment;
153 GtkAdjustment *vadjustment;
155 /* xor GC for the verticle drag line */
158 /* gc for drawing unselected cells */
162 /* cursor used to indicate dragging */
163 GdkCursor *cursor_drag;
165 /* the current x-pixel location of the xor-drag vline */
168 /* the current y-pixel location of the xor-drag hline */
171 /* current cell being dragged */
172 GtkSheetCell drag_cell;
173 /* current range being dragged */
174 GtkSheetRange drag_range;
176 /* Used for the subtitle (popups) */
178 GtkSheetHoverTitle *hover_window;
181 struct _GtkSheetClass
183 GtkBinClass parent_class;
185 void (*set_scroll_adjustments) (GtkSheet *sheet,
186 GtkAdjustment *hadjustment,
187 GtkAdjustment *vadjustment);
189 void (*select_row) (GtkSheet *sheet, gint row);
191 void (*select_column) (GtkSheet *sheet, gint column);
193 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
195 void (*resize_range) (GtkSheet *sheet,
196 GtkSheetRange *old_range,
197 GtkSheetRange *new_range);
199 void (*move_range) (GtkSheet *sheet,
200 GtkSheetRange *old_range,
201 GtkSheetRange *new_range);
203 gboolean (*traverse) (GtkSheet *sheet,
204 gint row, gint column,
205 gint *new_row, gint *new_column);
207 gboolean (*activate) (GtkSheet *sheet,
208 gint row, gint column);
210 void (*changed) (GtkSheet *sheet,
211 gint row, gint column);
214 GType gtk_sheet_get_type (void);
215 GtkType gtk_sheet_range_get_type (void);
218 /* create a new sheet */
219 GtkWidget * gtk_sheet_new (GSheetModel *model);
221 /* create a new sheet with custom entry */
223 gtk_sheet_new_with_custom_entry (GtkType entry_type);
226 void gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
228 GtkEntry *gtk_sheet_get_entry (GtkSheet *sheet);
231 void gtk_sheet_get_selected_range (GtkSheet *sheet,
232 GtkSheetRange *range);
234 void gtk_sheet_show_grid (GtkSheet *sheet,
237 gboolean gtk_sheet_grid_visible (GtkSheet *sheet);
240 /* scroll the viewing area of the sheet to the given column
241 * and row; row_align and col_align are between 0-1 representing the
242 * location the row should appear on the screen, 0.0 being top or left,
243 * 1.0 being bottom or right; if row or column is negative then there
245 void gtk_sheet_moveto (GtkSheet *sheet,
252 void gtk_sheet_show_row_titles (GtkSheet *sheet);
253 void gtk_sheet_hide_row_titles (GtkSheet *sheet);
254 void gtk_sheet_show_column_titles (GtkSheet *sheet);
255 void gtk_sheet_hide_column_titles (GtkSheet *sheet);
257 /* select the row. The range is then highlighted, and the bounds are stored
259 void gtk_sheet_select_row (GtkSheet * sheet, gint row);
261 /* select the column. The range is then highlighted, and the bounds are stored
263 void gtk_sheet_select_column (GtkSheet * sheet, gint column);
265 /* highlight the selected range and store bounds in sheet->range */
266 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
268 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
272 void gtk_sheet_unselect_range (GtkSheet *sheet);
274 /* set active cell where the entry will be displayed */
275 void gtk_sheet_set_active_cell (GtkSheet *sheet,
276 gint row, gint column);
278 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
279 ROW and/or COLUMN may be null if the caller is not interested in their
281 void gtk_sheet_get_active_cell (GtkSheet *sheet,
282 gint *row, gint *column);
284 /* get cell contents */
285 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
288 /* get cell attributes of the given cell */
289 /* TRUE means that the cell is currently allocated */
290 gboolean gtk_sheet_get_attributes (const GtkSheet *sheet,
292 GtkSheetCellAttr *attributes);
294 void gtk_sheet_set_model (GtkSheet *sheet,
297 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
303 #endif /* __GTK_SHEET_H__ */