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"
39 #endif /* __cplusplus */
47 GTK_SHEET_JUSTIFICATION,
49 GTK_SHEET_BORDER_COLOR,
50 GTK_SHEET_IS_EDITABLE,
59 GTK_SHEET_ROW_SELECTED,
60 GTK_SHEET_COLUMN_SELECTED,
61 GTK_SHEET_RANGE_SELECTED
65 #define GTK_TYPE_SHEET_RANGE (gtk_sheet_range_get_type ())
66 #define GTK_TYPE_SHEET (gtk_sheet_get_type ())
68 #define GTK_SHEET(obj) GTK_CHECK_CAST (obj, gtk_sheet_get_type (), GtkSheet)
69 #define GTK_SHEET_CLASS(klass) GTK_CHECK_CLASS_CAST (klass, gtk_sheet_get_type (), GtkSheetClass)
70 #define GTK_IS_SHEET(obj) GTK_CHECK_TYPE (obj, gtk_sheet_get_type ())
72 /* Public flags, for compatibility */
74 #define GTK_SHEET_ROW_FROZEN(sheet) !gtk_sheet_rows_resizable (sheet)
75 #define GTK_SHEET_COLUMN_FROZEN(sheet) !gtk_sheet_columns_resizable (sheet)
76 #define GTK_SHEET_AUTORESIZE(sheet) gtk_sheet_autoresize (sheet)
77 #define GTK_SHEET_ROW_TITLES_VISIBLE(sheet) gtk_sheet_row_titles_visible (sheet)
78 #define GTK_SHEET_COL_TITLES_VISIBLE(sheet) gtk_sheet_column_titles_visible (sheet)
79 #define GTK_SHEET_AUTO_SCROLL(sheet) gtk_sheet_autoscroll (sheet)
80 #define GTK_SHEET_JUSTIFY_ENTRY(sheet) gtk_sheet_justify_entry (sheet)
83 typedef struct _GtkSheetClass GtkSheetClass;
84 typedef struct _GtkSheetCellAttr GtkSheetCellAttr;
85 typedef struct _GtkSheetCell GtkSheetCell;
86 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
89 struct _GtkSheetCellAttr
91 GtkJustification justification;
92 const PangoFontDescription *font_desc;
95 GtkSheetCellBorder border;
106 struct _GtkSheetHoverTitle
115 GtkContainer container;
118 gboolean dispose_has_run;
119 GSheetColumn *column_geometry;
120 GSheetRow *row_geometry;
126 GtkSelectionMode selection_mode;
129 gboolean justify_entry;
131 /* Background colors */
139 /* allocation rectangle after the container_border_width
140 and the width of the shadow border */
141 GdkRectangle internal_allocation;
143 gint16 column_requisition;
144 gint16 row_requisition;
146 gboolean rows_resizable;
147 gboolean columns_resizable;
150 GtkSheetCell active_cell;
151 GtkWidget *sheet_entry;
155 /* expanding selection */
156 GtkSheetCell selection_cell;
158 /* global selection button */
167 /*the scrolling window and it's height and width to
168 * make things a little speedier */
169 GdkWindow *sheet_window;
170 guint sheet_window_width;
171 guint sheet_window_height;
173 /* sheet backing pixmap */
176 /* offsets for scrolling */
179 gfloat old_hadjustment;
180 gfloat old_vadjustment;
182 /* border shadow style */
183 GtkShadowType shadow_type;
186 GdkRectangle column_title_area;
187 GdkWindow *column_title_window;
188 gboolean column_titles_visible;
191 GdkRectangle row_title_area;
192 GdkWindow *row_title_window;
193 gboolean row_titles_visible;
196 GtkAdjustment *hadjustment;
197 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 GtkContainerClass 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,
274 /* create a new browser sheet. It cells can not be edited */
276 gtk_sheet_new_browser (guint rows, guint columns, const gchar *title);
279 gtk_sheet_construct_browser (GtkSheet *sheet,
280 guint rows, guint columns, const gchar *title);
282 /* create a new sheet with custom entry */
284 gtk_sheet_new_with_custom_entry (GSheetRow *vgeo,
288 gtk_sheet_construct_with_custom_entry (GtkSheet *sheet,
292 /* change scroll adjustments */
294 gtk_sheet_set_hadjustment (GtkSheet *sheet,
295 GtkAdjustment *adjustment);
297 gtk_sheet_set_vadjustment (GtkSheet *sheet,
298 GtkAdjustment *adjustment);
301 gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
303 /* Returns sheet's entry widget */
305 gtk_sheet_get_entry (GtkSheet *sheet);
307 gtk_sheet_get_entry_widget (GtkSheet *sheet);
309 /* Returns sheet->state
310 * Added by Steven Rostedt <steven.rostedt@lmco.com> */
312 gtk_sheet_get_state (GtkSheet *sheet);
314 /* Returns sheet's ranges
315 * Added by Murray Cumming */
317 gtk_sheet_get_columns_count (GtkSheet *sheet);
320 gtk_sheet_get_rows_count (GtkSheet *sheet);
323 gtk_sheet_get_visible_range (GtkSheet *sheet,
324 GtkSheetRange *range);
327 gtk_sheet_get_selected_range (GtkSheet *sheet,
328 GtkSheetRange *range);
331 gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
334 gtk_sheet_set_autoresize (GtkSheet *sheet, gboolean autoresize);
337 gtk_sheet_autoresize (GtkSheet *sheet);
340 gtk_sheet_set_autoscroll (GtkSheet *sheet, gboolean autoscroll);
343 gtk_sheet_autoscroll (GtkSheet *sheet);
346 gtk_sheet_set_justify_entry (GtkSheet *sheet, gboolean justify);
349 gtk_sheet_justify_entry (GtkSheet *sheet);
352 gtk_sheet_set_locked (GtkSheet *sheet, gboolean lock);
355 gtk_sheet_locked (const GtkSheet *sheet);
357 /* set sheet title */
359 gtk_sheet_set_title (GtkSheet *sheet, const gchar *title);
361 /* freeze all visual updates of the sheet.
362 * Then thaw the sheet after you have made a number of changes.
363 * The updates will occure in a more efficent way than if
364 * you made them on a unfrozen sheet */
366 gtk_sheet_freeze (GtkSheet *sheet);
368 gtk_sheet_thaw (GtkSheet *sheet);
369 /* Background colors */
371 gtk_sheet_set_background (GtkSheet *sheet,
374 gtk_sheet_set_grid (GtkSheet *sheet,
375 GdkColor *grid_color);
377 gtk_sheet_show_grid (GtkSheet *sheet,
380 gtk_sheet_grid_visible (GtkSheet *sheet);
382 /* set/get column title */
384 gtk_sheet_set_column_title (GtkSheet * sheet,
386 const gchar * title);
389 gtk_sheet_get_column_title (GtkSheet * sheet,
392 /* set/get row title */
394 gtk_sheet_set_row_title (GtkSheet * sheet,
396 const gchar * title);
398 gtk_sheet_get_row_title (GtkSheet * sheet,
402 /* set/get button label */
404 gtk_sheet_row_button_add_label (GtkSheet *sheet,
405 gint row, const gchar *label);
407 gtk_sheet_row_button_get_label (GtkSheet *sheet,
410 gtk_sheet_row_button_justify (GtkSheet *sheet,
411 gint row, GtkJustification justification);
415 /* scroll the viewing area of the sheet to the given column
416 * and row; row_align and col_align are between 0-1 representing the
417 * location the row should appear on the screen, 0.0 being top or left,
418 * 1.0 being bottom or right; if row or column is negative then there
421 gtk_sheet_moveto (GtkSheet *sheet,
429 gtk_sheet_show_row_titles (GtkSheet *sheet);
431 gtk_sheet_hide_row_titles (GtkSheet *sheet);
433 gtk_sheet_row_titles_visible (GtkSheet *sheet);
436 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
437 * otherwise it acts as a title */
439 gtk_sheet_row_set_sensitivity (GtkSheet *sheet,
440 gint row, gboolean sensitive);
442 /* set sensitivity for all row buttons */
444 gtk_sheet_rows_set_sensitivity (GtkSheet *sheet, gboolean sensitive);
446 gtk_sheet_rows_set_resizable (GtkSheet *sheet, gboolean resizable);
448 gtk_sheet_rows_resizable (GtkSheet *sheet);
450 /* set row visibility. The default value is TRUE. If FALSE, the
453 gtk_sheet_row_set_visibility (GtkSheet *sheet,
454 gint row, gboolean visible);
456 gtk_sheet_row_label_set_visibility (GtkSheet *sheet,
457 gint row, gboolean visible);
459 gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
462 /* select the row. The range is then highlighted, and the bounds are stored
465 gtk_sheet_select_row (GtkSheet * sheet,
468 /* select the column. The range is then highlighted, and the bounds are stored
471 gtk_sheet_select_column (GtkSheet * sheet,
474 /* get scrollbars adjustment */
476 gtk_sheet_get_vadjustment (GtkSheet * sheet);
478 gtk_sheet_get_hadjustment (GtkSheet * sheet);
480 /* highlight the selected range and store bounds in sheet->range */
481 void gtk_sheet_select_range (GtkSheet *sheet,
482 const GtkSheetRange *range);
485 void gtk_sheet_unselect_range (GtkSheet *sheet);
487 /* set active cell where the entry will be displayed
488 * returns FALSE if current cell can't be deactivated or
489 * requested cell can't be activated */
491 gtk_sheet_set_active_cell (GtkSheet *sheet,
492 gint row, gint column);
494 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
495 ROW and/or COLUMN may be null if the caller is not interested in their
498 gtk_sheet_get_active_cell (GtkSheet *sheet,
499 gint *row, gint *column);
501 /* set cell contents and allocate memory if needed */
503 gtk_sheet_set_cell (GtkSheet *sheet,
505 GtkJustification justification,
508 gtk_sheet_set_cell_text (GtkSheet *sheet,
511 /* get cell contents */
513 gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
515 /* clear cell contents */
517 gtk_sheet_cell_clear (GtkSheet *sheet, gint row, gint col);
519 /* clear range contents. If range==NULL the whole sheet will be cleared */
521 gtk_sheet_range_clear (GtkSheet *sheet,
522 const GtkSheetRange *range);
524 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
526 gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
528 /* get row and column correspondig to the given position in the screen */
530 gtk_sheet_get_pixel_info (GtkSheet * sheet,
536 /* get area of a given cell */
538 gtk_sheet_get_cell_area (GtkSheet *sheet,
545 gtk_sheet_set_row_height (GtkSheet * sheet,
550 /* delete nrows rows starting in row */
552 gtk_sheet_delete_rows (GtkSheet *sheet, guint row, guint nrows);
554 /* append nrows row to the end of the sheet */
556 gtk_sheet_add_row (GtkSheet *sheet, guint nrows);
558 /* insert nrows rows before the given row and pull right */
560 gtk_sheet_insert_rows (GtkSheet *sheet, guint row, guint nrows);
562 /* set abckground color of the given range */
564 gtk_sheet_range_set_background (GtkSheet *sheet,
565 const GtkSheetRange *range,
566 const GdkColor *color);
568 /* set foreground color (text color) of the given range */
570 gtk_sheet_range_set_foreground (GtkSheet *sheet,
571 const GtkSheetRange *range,
572 const GdkColor *color);
574 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
575 * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
576 * default justification for numbers is GTK_JUSTIFY_RIGHT */
578 gtk_sheet_range_set_justification (GtkSheet *sheet,
579 const GtkSheetRange *range,
580 GtkJustification justification);
582 gtk_sheet_column_set_justification (GtkSheet *sheet,
584 GtkJustification justification);
585 /* set if cell contents can be edited or not in the given range:
586 * accepted values are TRUE or FALSE. */
588 gtk_sheet_range_set_editable (GtkSheet *sheet,
589 const GtkSheetRange *range,
592 /* set if cell contents are visible or not in the given range:
593 * accepted values are TRUE or FALSE.*/
595 gtk_sheet_range_set_visible (GtkSheet *sheet,
596 const GtkSheetRange *range,
599 /* set cell border style in the given range.
600 * mask values are CELL_LEFT_BORDER, CELL_RIGHT_BORDER, CELL_TOP_BORDER,
602 * width is the width of the border line in pixels
603 * line_style is the line_style for the border line */
605 gtk_sheet_range_set_border (GtkSheet *sheet,
606 const GtkSheetRange *range,
611 /* set border color for the given range */
613 gtk_sheet_range_set_border_color (GtkSheet *sheet,
614 const GtkSheetRange *range,
615 const GdkColor *color);
617 /* set font for the given range */
619 gtk_sheet_range_set_font (GtkSheet *sheet,
620 const GtkSheetRange *range,
621 PangoFontDescription *font);
623 /* get cell attributes of the given cell */
624 /* TRUE means that the cell is currently allocated */
626 gtk_sheet_get_attributes (const GtkSheet *sheet,
628 GtkSheetCellAttr *attributes);
632 gtk_sheet_put (GtkSheet *sheet,
636 gtk_sheet_attach_floating (GtkSheet *sheet,
640 gtk_sheet_attach_default (GtkSheet *sheet,
644 gtk_sheet_attach (GtkSheet *sheet,
654 gtk_sheet_move_child (GtkSheet *sheet,
659 gtk_sheet_get_child_at (GtkSheet *sheet,
663 gtk_sheet_button_attach (GtkSheet *sheet,
669 void gtk_sheet_set_model (GtkSheet *sheet,
672 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
677 #endif /* __cplusplus */
680 #endif /* __GTK_SHEET_H__ */