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 "gsheet-column-iface.h"
34 #include "gsheet-row-iface.h"
43 GTK_SHEET_ROW_SELECTED,
44 GTK_SHEET_COLUMN_SELECTED,
45 GTK_SHEET_RANGE_SELECTED
49 #define GTK_TYPE_SHEET_RANGE (gtk_sheet_range_get_type ())
50 #define GTK_TYPE_SHEET (gtk_sheet_get_type ())
52 #define GTK_SHEET(obj) GTK_CHECK_CAST (obj, gtk_sheet_get_type (), GtkSheet)
53 #define GTK_SHEET_CLASS(klass) GTK_CHECK_CLASS_CAST (klass, gtk_sheet_get_type (), GtkSheetClass)
54 #define GTK_IS_SHEET(obj) GTK_CHECK_TYPE (obj, gtk_sheet_get_type ())
57 typedef struct _GtkSheetClass GtkSheetClass;
58 typedef struct _GtkSheetCellAttr GtkSheetCellAttr;
59 typedef struct _GtkSheetCell GtkSheetCell;
60 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
63 struct _GtkSheetCellAttr
65 GtkJustification justification;
66 const PangoFontDescription *font_desc;
69 GtkSheetCellBorder border;
81 struct _GtkSheetHoverTitle
99 gboolean dispose_has_run;
100 GSheetColumn *column_geometry;
101 GSheetRow *row_geometry;
107 GtkSelectionMode selection_mode;
109 /* Component colors */
110 GdkColor color[n_COLORS];
113 /* allocation rectangle after the container_border_width
114 and the width of the shadow border */
115 GdkRectangle internal_allocation;
117 gint16 column_requisition;
118 gint16 row_requisition;
120 gboolean rows_resizable;
121 gboolean columns_resizable;
124 GtkSheetCell active_cell;
126 /* The GtkEntry used for editing the cells */
127 GtkWidget *entry_widget;
129 /* The widget containing entry_widget, or
130 entry_widget itself if no container */
131 GtkWidget *entry_container;
133 /* The type of entry_widget */
136 /* expanding selection */
137 GtkSheetCell selection_cell;
139 /* global selection button */
148 /*the scrolling window and it's height and width to
149 * make things a little speedier */
150 GdkWindow *sheet_window;
151 guint sheet_window_width;
152 guint sheet_window_height;
154 /* sheet backing pixmap */
157 /* border shadow style */
158 GtkShadowType shadow_type;
161 GdkRectangle column_title_area;
162 GdkWindow *column_title_window;
163 gboolean column_titles_visible;
164 /* TRUE if the cursor is over the column title window */
165 gboolean column_title_under;
168 GdkRectangle row_title_area;
169 GdkWindow *row_title_window;
170 gboolean row_titles_visible;
171 /* TRUE if the cursor is over the row title window */
172 gboolean row_title_under;
175 GtkAdjustment *hadjustment;
176 GtkAdjustment *vadjustment;
178 /* xor GC for the verticle drag line */
181 /* gc for drawing unselected cells */
185 /* cursor used to indicate dragging */
186 GdkCursor *cursor_drag;
188 /* the current x-pixel location of the xor-drag vline */
191 /* the current y-pixel location of the xor-drag hline */
194 /* current cell being dragged */
195 GtkSheetCell drag_cell;
196 /* current range being dragged */
197 GtkSheetRange drag_range;
199 /* Used for the subtitle (popups) */
201 GtkSheetHoverTitle *hover_window;
204 struct _GtkSheetClass
206 GtkBinClass parent_class;
208 void (*set_scroll_adjustments) (GtkSheet *sheet,
209 GtkAdjustment *hadjustment,
210 GtkAdjustment *vadjustment);
212 void (*select_row) (GtkSheet *sheet, gint row);
214 void (*select_column) (GtkSheet *sheet, gint column);
216 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
218 void (*resize_range) (GtkSheet *sheet,
219 GtkSheetRange *old_range,
220 GtkSheetRange *new_range);
222 void (*move_range) (GtkSheet *sheet,
223 GtkSheetRange *old_range,
224 GtkSheetRange *new_range);
226 gboolean (*traverse) (GtkSheet *sheet,
227 gint row, gint column,
228 gint *new_row, gint *new_column);
230 gboolean (*deactivate) (GtkSheet *sheet,
231 gint row, gint column);
233 gboolean (*activate) (GtkSheet *sheet,
234 gint row, gint column);
236 void (*changed) (GtkSheet *sheet,
237 gint row, gint column);
240 GType gtk_sheet_get_type (void);
241 GtkType gtk_sheet_range_get_type (void);
244 /* create a new sheet */
245 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
248 /* create a new sheet with custom entry */
250 gtk_sheet_new_with_custom_entry (GSheetRow *vgeo,
254 gtk_sheet_construct_with_custom_entry (GtkSheet *sheet,
259 void gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
261 GtkWidget *gtk_sheet_get_entry (GtkSheet *sheet);
264 void gtk_sheet_get_selected_range (GtkSheet *sheet,
265 GtkSheetRange *range);
267 void gtk_sheet_show_grid (GtkSheet *sheet,
270 gboolean gtk_sheet_grid_visible (GtkSheet *sheet);
273 /* scroll the viewing area of the sheet to the given column
274 * and row; row_align and col_align are between 0-1 representing the
275 * location the row should appear on the screen, 0.0 being top or left,
276 * 1.0 being bottom or right; if row or column is negative then there
278 void gtk_sheet_moveto (GtkSheet *sheet,
285 void gtk_sheet_show_row_titles (GtkSheet *sheet);
286 void gtk_sheet_hide_row_titles (GtkSheet *sheet);
287 void gtk_sheet_show_column_titles (GtkSheet *sheet);
288 void gtk_sheet_hide_column_titles (GtkSheet *sheet);
290 /* select the row. The range is then highlighted, and the bounds are stored
292 void gtk_sheet_select_row (GtkSheet * sheet, gint row);
294 /* select the column. The range is then highlighted, and the bounds are stored
296 void gtk_sheet_select_column (GtkSheet * sheet, gint column);
298 /* highlight the selected range and store bounds in sheet->range */
299 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
301 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
305 void gtk_sheet_unselect_range (GtkSheet *sheet);
307 /* set active cell where the entry will be displayed
308 * returns FALSE if current cell can't be deactivated or
309 * requested cell can't be activated */
310 gboolean gtk_sheet_set_active_cell (GtkSheet *sheet,
311 gint row, gint column);
313 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
314 ROW and/or COLUMN may be null if the caller is not interested in their
316 void gtk_sheet_get_active_cell (GtkSheet *sheet,
317 gint *row, gint *column);
319 /* get cell contents */
320 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
323 /* get cell attributes of the given cell */
324 /* TRUE means that the cell is currently allocated */
325 gboolean gtk_sheet_get_attributes (const GtkSheet *sheet,
327 GtkSheetCellAttr *attributes);
329 void gtk_sheet_set_model (GtkSheet *sheet,
332 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
338 #endif /* __GTK_SHEET_H__ */