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"
45 GTK_SHEET_JUSTIFICATION,
47 GTK_SHEET_BORDER_COLOR,
48 GTK_SHEET_IS_EDITABLE,
57 GTK_SHEET_ROW_SELECTED,
58 GTK_SHEET_COLUMN_SELECTED,
59 GTK_SHEET_RANGE_SELECTED
63 #define GTK_TYPE_SHEET_RANGE (gtk_sheet_range_get_type ())
64 #define GTK_TYPE_SHEET (gtk_sheet_get_type ())
66 #define GTK_SHEET(obj) GTK_CHECK_CAST (obj, gtk_sheet_get_type (), GtkSheet)
67 #define GTK_SHEET_CLASS(klass) GTK_CHECK_CLASS_CAST (klass, gtk_sheet_get_type (), GtkSheetClass)
68 #define GTK_IS_SHEET(obj) GTK_CHECK_TYPE (obj, gtk_sheet_get_type ())
72 #define GTK_SHEET_AUTORESIZE(sheet) gtk_sheet_autoresize (sheet)
73 #define GTK_SHEET_AUTO_SCROLL(sheet) gtk_sheet_autoscroll (sheet)
74 #define GTK_SHEET_JUSTIFY_ENTRY(sheet) gtk_sheet_justify_entry (sheet)
77 typedef struct _GtkSheetClass GtkSheetClass;
78 typedef struct _GtkSheetCellAttr GtkSheetCellAttr;
79 typedef struct _GtkSheetCell GtkSheetCell;
80 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
83 struct _GtkSheetCellAttr
85 GtkJustification justification;
86 const PangoFontDescription *font_desc;
89 GtkSheetCellBorder border;
101 struct _GtkSheetHoverTitle
119 gboolean dispose_has_run;
120 GSheetColumn *column_geometry;
121 GSheetRow *row_geometry;
127 GtkSelectionMode selection_mode;
130 gboolean justify_entry;
132 /* Component colors */
133 GdkColor color[n_COLORS];
136 /* allocation rectangle after the container_border_width
137 and the width of the shadow border */
138 GdkRectangle internal_allocation;
140 gint16 column_requisition;
141 gint16 row_requisition;
143 gboolean rows_resizable;
144 gboolean columns_resizable;
147 GtkSheetCell active_cell;
149 /* The GtkEntry used for editing the cells */
150 GtkWidget *entry_widget;
152 /* The widget containing entry_widget, or
153 entry_widget itself if no container */
154 GtkWidget *entry_container;
156 /* The type of entry_widget */
159 /* expanding selection */
160 GtkSheetCell selection_cell;
162 /* global selection button */
171 /*the scrolling window and it's height and width to
172 * make things a little speedier */
173 GdkWindow *sheet_window;
174 guint sheet_window_width;
175 guint sheet_window_height;
177 /* sheet backing pixmap */
180 /* border shadow style */
181 GtkShadowType shadow_type;
184 GdkRectangle column_title_area;
185 GdkWindow *column_title_window;
186 gboolean column_titles_visible;
187 /* TRUE if the cursor is over the column title window */
188 gboolean column_title_under;
191 GdkRectangle row_title_area;
192 GdkWindow *row_title_window;
193 gboolean row_titles_visible;
194 /* TRUE if the cursor is over the row title window */
195 gboolean row_title_under;
198 GtkAdjustment *hadjustment;
199 GtkAdjustment *vadjustment;
201 /* xor GC for the verticle drag line */
204 /* gc for drawing unselected cells */
208 /* cursor used to indicate dragging */
209 GdkCursor *cursor_drag;
211 /* the current x-pixel location of the xor-drag vline */
214 /* the current y-pixel location of the xor-drag hline */
217 /* current cell being dragged */
218 GtkSheetCell drag_cell;
219 /* current range being dragged */
220 GtkSheetRange drag_range;
222 /* Used for the subtitle (popups) */
224 GtkSheetHoverTitle *hover_window;
227 struct _GtkSheetClass
229 GtkBinClass parent_class;
231 void (*set_scroll_adjustments) (GtkSheet *sheet,
232 GtkAdjustment *hadjustment,
233 GtkAdjustment *vadjustment);
235 void (*select_row) (GtkSheet *sheet, gint row);
237 void (*select_column) (GtkSheet *sheet, gint column);
239 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
241 void (*resize_range) (GtkSheet *sheet,
242 GtkSheetRange *old_range,
243 GtkSheetRange *new_range);
245 void (*move_range) (GtkSheet *sheet,
246 GtkSheetRange *old_range,
247 GtkSheetRange *new_range);
249 gboolean (*traverse) (GtkSheet *sheet,
250 gint row, gint column,
251 gint *new_row, gint *new_column);
253 gboolean (*deactivate) (GtkSheet *sheet,
254 gint row, gint column);
256 gboolean (*activate) (GtkSheet *sheet,
257 gint row, gint column);
259 void (*changed) (GtkSheet *sheet,
260 gint row, gint column);
263 GType gtk_sheet_get_type (void);
264 GtkType gtk_sheet_range_get_type (void);
267 /* create a new sheet */
268 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
271 /* create a new sheet with custom entry */
273 gtk_sheet_new_with_custom_entry (GSheetRow *vgeo,
277 gtk_sheet_construct_with_custom_entry (GtkSheet *sheet,
282 void gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
284 GtkWidget *gtk_sheet_get_entry (GtkSheet *sheet);
287 guint gtk_sheet_get_columns_count (GtkSheet *sheet);
289 guint gtk_sheet_get_rows_count (GtkSheet *sheet);
291 void gtk_sheet_get_selected_range (GtkSheet *sheet,
292 GtkSheetRange *range);
294 void gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
296 void gtk_sheet_set_autoresize (GtkSheet *sheet, gboolean autoresize);
298 gboolean gtk_sheet_autoresize (GtkSheet *sheet);
300 void gtk_sheet_set_autoscroll (GtkSheet *sheet, gboolean autoscroll);
302 gboolean gtk_sheet_autoscroll (GtkSheet *sheet);
304 void gtk_sheet_set_justify_entry (GtkSheet *sheet, gboolean justify);
306 gboolean gtk_sheet_justify_entry (GtkSheet *sheet);
308 void gtk_sheet_show_grid (GtkSheet *sheet,
311 gboolean gtk_sheet_grid_visible (GtkSheet *sheet);
313 /* set/get column title */
314 void gtk_sheet_set_column_title (GtkSheet * sheet,
316 const gchar * title);
318 const gchar *gtk_sheet_get_column_title (GtkSheet * sheet,
321 /* set/get row title */
322 void gtk_sheet_set_row_title (GtkSheet * sheet,
324 const gchar * title);
326 const gchar *gtk_sheet_get_row_title (GtkSheet * sheet,
329 /* set/get button label */
330 void gtk_sheet_row_button_add_label (GtkSheet *sheet,
331 gint row, const gchar *label);
333 const gchar *gtk_sheet_row_button_get_label (GtkSheet *sheet,
336 void gtk_sheet_row_button_justify (GtkSheet *sheet,
337 gint row, GtkJustification justification);
339 /* scroll the viewing area of the sheet to the given column
340 * and row; row_align and col_align are between 0-1 representing the
341 * location the row should appear on the screen, 0.0 being top or left,
342 * 1.0 being bottom or right; if row or column is negative then there
344 void gtk_sheet_moveto (GtkSheet *sheet,
351 void gtk_sheet_show_row_titles (GtkSheet *sheet);
352 void gtk_sheet_hide_row_titles (GtkSheet *sheet);
353 void gtk_sheet_show_column_titles (GtkSheet *sheet);
354 void gtk_sheet_hide_column_titles (GtkSheet *sheet);
356 gboolean gtk_sheet_row_titles_visible (GtkSheet *sheet);
359 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
360 * otherwise it acts as a title */
361 void gtk_sheet_row_set_sensitivity (GtkSheet *sheet,
362 gint row, gboolean sensitive);
364 /* set sensitivity for all row buttons */
365 void gtk_sheet_rows_set_sensitivity (GtkSheet *sheet, gboolean sensitive);
366 void gtk_sheet_rows_set_resizable (GtkSheet *sheet, gboolean resizable);
367 gboolean gtk_sheet_rows_resizable (GtkSheet *sheet);
369 /* set row visibility. The default value is TRUE. If FALSE, the
371 void gtk_sheet_row_set_visibility (GtkSheet *sheet,
372 gint row, gboolean visible);
374 void gtk_sheet_row_label_set_visibility (GtkSheet *sheet,
375 gint row, gboolean visible);
377 void gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
380 /* select the row. The range is then highlighted, and the bounds are stored
382 void gtk_sheet_select_row (GtkSheet * sheet, gint row);
384 /* select the column. The range is then highlighted, and the bounds are stored
386 void gtk_sheet_select_column (GtkSheet * sheet, gint column);
388 /* highlight the selected range and store bounds in sheet->range */
389 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
391 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
395 void gtk_sheet_unselect_range (GtkSheet *sheet);
397 /* set active cell where the entry will be displayed
398 * returns FALSE if current cell can't be deactivated or
399 * requested cell can't be activated */
400 gboolean gtk_sheet_set_active_cell (GtkSheet *sheet,
401 gint row, gint column);
403 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
404 ROW and/or COLUMN may be null if the caller is not interested in their
406 void gtk_sheet_get_active_cell (GtkSheet *sheet,
407 gint *row, gint *column);
409 /* get cell contents */
410 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
412 /* clear cell contents */
413 void gtk_sheet_cell_clear (GtkSheet *sheet, gint row, gint col);
415 /* clear range contents. If range==NULL the whole sheet will be cleared */
416 void gtk_sheet_range_clear (GtkSheet *sheet,
417 const GtkSheetRange *range);
419 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
420 GtkStateType gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
422 /* get area of a given cell */
423 gboolean gtk_sheet_get_cell_area (GtkSheet *sheet,
429 void gtk_sheet_set_row_height (GtkSheet * sheet,
434 /* delete nrows rows starting in row */
435 void gtk_sheet_delete_rows (GtkSheet *sheet, guint row, guint nrows);
437 /* append nrows row to the end of the sheet */
438 void gtk_sheet_add_row (GtkSheet *sheet, guint nrows);
440 /* insert nrows rows before the given row and pull right */
441 void gtk_sheet_insert_rows (GtkSheet *sheet, guint row, guint nrows);
443 /* set abckground color of the given range */
444 void gtk_sheet_range_set_background (GtkSheet *sheet,
445 const GtkSheetRange *range,
446 const GdkColor *color);
448 /* set foreground color (text color) of the given range */
449 void gtk_sheet_range_set_foreground (GtkSheet *sheet,
450 const GtkSheetRange *range,
451 const GdkColor *color);
453 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
454 * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
455 * default justification for numbers is GTK_JUSTIFY_RIGHT */
456 void gtk_sheet_range_set_justification (GtkSheet *sheet,
457 const GtkSheetRange *range,
458 GtkJustification justification);
460 void gtk_sheet_column_set_justification (GtkSheet *sheet,
462 GtkJustification justification);
464 /* set if cell contents can be edited or not in the given range:
465 * accepted values are TRUE or FALSE. */
466 void gtk_sheet_range_set_editable (GtkSheet *sheet,
467 const GtkSheetRange *range,
470 /* set if cell contents are visible or not in the given range:
471 * accepted values are TRUE or FALSE.*/
472 void gtk_sheet_range_set_visible (GtkSheet *sheet,
473 const GtkSheetRange *range,
476 /* set cell border style in the given range.
477 * mask values are CELL_LEFT_BORDER, CELL_RIGHT_BORDER, CELL_TOP_BORDER,
479 * width is the width of the border line in pixels
480 * line_style is the line_style for the border line */
481 void gtk_sheet_range_set_border (GtkSheet *sheet,
482 const GtkSheetRange *range,
487 /* set border color for the given range */
488 void gtk_sheet_range_set_border_color (GtkSheet *sheet,
489 const GtkSheetRange *range,
490 const GdkColor *color);
492 /* set font for the given range */
493 void gtk_sheet_range_set_font (GtkSheet *sheet,
494 const GtkSheetRange *range,
495 PangoFontDescription *font);
497 /* get cell attributes of the given cell */
498 /* TRUE means that the cell is currently allocated */
499 gboolean gtk_sheet_get_attributes (const GtkSheet *sheet,
501 GtkSheetCellAttr *attributes);
504 void gtk_sheet_set_model (GtkSheet *sheet,
507 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
513 #endif /* __GTK_SHEET_H__ */