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_CLIP_TEXT(sheet) gtk_sheet_clip_text (sheet)
78 #define GTK_SHEET_ROW_TITLES_VISIBLE(sheet) gtk_sheet_row_titles_visible (sheet)
79 #define GTK_SHEET_COL_TITLES_VISIBLE(sheet) gtk_sheet_column_titles_visible (sheet)
80 #define GTK_SHEET_AUTO_SCROLL(sheet) gtk_sheet_autoscroll (sheet)
81 #define GTK_SHEET_JUSTIFY_ENTRY(sheet) gtk_sheet_justify_entry (sheet)
84 typedef struct _GtkSheetClass GtkSheetClass;
85 typedef struct _GtkSheetCellAttr GtkSheetCellAttr;
86 typedef struct _GtkSheetCell GtkSheetCell;
87 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
90 struct _GtkSheetCellAttr
92 GtkJustification justification;
93 const PangoFontDescription *font_desc;
96 GtkSheetCellBorder border;
107 struct _GtkSheetHoverTitle
115 GtkContainer container;
117 GSheetColumn *column_geometry;
118 GSheetRow *row_geometry;
124 GtkSelectionMode selection_mode;
128 gboolean justify_entry;
132 /* Background colors */
140 /* allocation rectangle after the container_border_width
141 and the width of the shadow border */
142 GdkRectangle internal_allocation;
146 gint16 column_requisition;
147 gint16 row_requisition;
149 gboolean rows_resizable;
150 gboolean columns_resizable;
153 GtkSheetCell active_cell;
154 GtkWidget *sheet_entry;
158 /* expanding selection */
159 GtkSheetCell selection_cell;
161 /* timer for flashing clipped range */
165 /* global selection button */
174 /*the scrolling window and it's height and width to
175 * make things a little speedier */
176 GdkWindow *sheet_window;
177 guint sheet_window_width;
178 guint sheet_window_height;
180 /* sheet backing pixmap */
183 /* offsets for scrolling */
186 gfloat old_hadjustment;
187 gfloat old_vadjustment;
189 /* border shadow style */
190 GtkShadowType shadow_type;
193 GdkRectangle column_title_area;
194 GdkWindow *column_title_window;
195 gboolean column_titles_visible;
198 GdkRectangle row_title_area;
199 GdkWindow *row_title_window;
200 gboolean row_titles_visible;
203 GtkAdjustment *hadjustment;
204 GtkAdjustment *vadjustment;
206 /* xor GC for the verticle drag line */
209 /* gc for drawing unselected cells */
213 /* cursor used to indicate dragging */
214 GdkCursor *cursor_drag;
216 /* the current x-pixel location of the xor-drag vline */
219 /* the current y-pixel location of the xor-drag hline */
222 /* current cell being dragged */
223 GtkSheetCell drag_cell;
224 /* current range being dragged */
225 GtkSheetRange drag_range;
228 GtkSheetRange clip_range;
230 /* Used for the subtitle (popups) */
232 GtkSheetHoverTitle *hover_window;
235 struct _GtkSheetClass
237 GtkContainerClass parent_class;
239 void (*set_scroll_adjustments) (GtkSheet *sheet,
240 GtkAdjustment *hadjustment,
241 GtkAdjustment *vadjustment);
243 void (*select_row) (GtkSheet *sheet, gint row);
245 void (*select_column) (GtkSheet *sheet, gint column);
247 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
249 void (*clip_range) (GtkSheet *sheet, GtkSheetRange *clip_range);
251 void (*resize_range) (GtkSheet *sheet,
252 GtkSheetRange *old_range,
253 GtkSheetRange *new_range);
255 void (*move_range) (GtkSheet *sheet,
256 GtkSheetRange *old_range,
257 GtkSheetRange *new_range);
259 gboolean (*traverse) (GtkSheet *sheet,
260 gint row, gint column,
261 gint *new_row, gint *new_column);
263 gboolean (*deactivate) (GtkSheet *sheet,
264 gint row, gint column);
266 gboolean (*activate) (GtkSheet *sheet,
267 gint row, gint column);
269 void (*set_cell) (GtkSheet *sheet,
270 gint row, gint column);
272 void (*clear_cell) (GtkSheet *sheet,
273 gint row, gint column);
275 void (*changed) (GtkSheet *sheet,
276 gint row, gint column);
278 void (*new_column_width) (GtkSheet *sheet,
282 void (*new_row_height) (GtkSheet *sheet,
288 GType gtk_sheet_get_type (void);
289 GtkType gtk_sheet_range_get_type (void);
292 /* create a new sheet */
293 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
300 /* create a new browser sheet. It cells can not be edited */
302 gtk_sheet_new_browser (guint rows, guint columns, const gchar *title);
305 gtk_sheet_construct_browser (GtkSheet *sheet,
306 guint rows, guint columns, const gchar *title);
308 /* create a new sheet with custom entry */
310 gtk_sheet_new_with_custom_entry (GSheetRow *vgeo,
315 gtk_sheet_construct_with_custom_entry (GtkSheet *sheet,
320 /* change scroll adjustments */
322 gtk_sheet_set_hadjustment (GtkSheet *sheet,
323 GtkAdjustment *adjustment);
325 gtk_sheet_set_vadjustment (GtkSheet *sheet,
326 GtkAdjustment *adjustment);
329 gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
331 /* Returns sheet's entry widget */
333 gtk_sheet_get_entry (GtkSheet *sheet);
335 gtk_sheet_get_entry_widget (GtkSheet *sheet);
337 /* Returns sheet->state
338 * Added by Steven Rostedt <steven.rostedt@lmco.com> */
340 gtk_sheet_get_state (GtkSheet *sheet);
342 /* Returns sheet's ranges
343 * Added by Murray Cumming */
345 gtk_sheet_get_columns_count (GtkSheet *sheet);
348 gtk_sheet_get_rows_count (GtkSheet *sheet);
351 gtk_sheet_get_visible_range (GtkSheet *sheet,
352 GtkSheetRange *range);
355 gtk_sheet_get_selected_range (GtkSheet *sheet,
356 GtkSheetRange *range);
359 gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
362 gtk_sheet_set_autoresize (GtkSheet *sheet, gboolean autoresize);
365 gtk_sheet_autoresize (GtkSheet *sheet);
368 gtk_sheet_set_autoscroll (GtkSheet *sheet, gboolean autoscroll);
371 gtk_sheet_autoscroll (GtkSheet *sheet);
374 gtk_sheet_set_clip_text (GtkSheet *sheet, gboolean clip_text);
377 gtk_sheet_clip_text (GtkSheet *sheet);
380 gtk_sheet_set_justify_entry (GtkSheet *sheet, gboolean justify);
383 gtk_sheet_justify_entry (GtkSheet *sheet);
386 gtk_sheet_set_locked (GtkSheet *sheet, gboolean lock);
389 gtk_sheet_locked (const GtkSheet *sheet);
391 /* set sheet title */
393 gtk_sheet_set_title (GtkSheet *sheet, const gchar *title);
395 /* freeze all visual updates of the sheet.
396 * Then thaw the sheet after you have made a number of changes.
397 * The updates will occure in a more efficent way than if
398 * you made them on a unfrozen sheet */
400 gtk_sheet_freeze (GtkSheet *sheet);
402 gtk_sheet_thaw (GtkSheet *sheet);
403 /* Background colors */
405 gtk_sheet_set_background (GtkSheet *sheet,
408 gtk_sheet_set_grid (GtkSheet *sheet,
409 GdkColor *grid_color);
411 gtk_sheet_show_grid (GtkSheet *sheet,
414 gtk_sheet_grid_visible (GtkSheet *sheet);
416 /* set/get column title */
418 gtk_sheet_set_column_title (GtkSheet * sheet,
420 const gchar * title);
423 gtk_sheet_get_column_title (GtkSheet * sheet,
426 /* set/get row title */
428 gtk_sheet_set_row_title (GtkSheet * sheet,
430 const gchar * title);
432 gtk_sheet_get_row_title (GtkSheet * sheet,
436 /* set/get button label */
438 gtk_sheet_row_button_add_label (GtkSheet *sheet,
439 gint row, const gchar *label);
441 gtk_sheet_row_button_get_label (GtkSheet *sheet,
444 gtk_sheet_row_button_justify (GtkSheet *sheet,
445 gint row, GtkJustification justification);
449 /* scroll the viewing area of the sheet to the given column
450 * and row; row_align and col_align are between 0-1 representing the
451 * location the row should appear on the screen, 0.0 being top or left,
452 * 1.0 being bottom or right; if row or column is negative then there
455 gtk_sheet_moveto (GtkSheet *sheet,
463 gtk_sheet_show_row_titles (GtkSheet *sheet);
465 gtk_sheet_hide_row_titles (GtkSheet *sheet);
467 gtk_sheet_row_titles_visible (GtkSheet *sheet);
470 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
471 * otherwise it acts as a title */
473 gtk_sheet_row_set_sensitivity (GtkSheet *sheet,
474 gint row, gboolean sensitive);
476 /* set sensitivity for all row buttons */
478 gtk_sheet_rows_set_sensitivity (GtkSheet *sheet, gboolean sensitive);
480 gtk_sheet_rows_set_resizable (GtkSheet *sheet, gboolean resizable);
482 gtk_sheet_rows_resizable (GtkSheet *sheet);
484 /* set row visibility. The default value is TRUE. If FALSE, the
487 gtk_sheet_row_set_visibility (GtkSheet *sheet,
488 gint row, gboolean visible);
490 gtk_sheet_row_label_set_visibility (GtkSheet *sheet,
491 gint row, gboolean visible);
493 gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
496 /* select the row. The range is then highlighted, and the bounds are stored
499 gtk_sheet_select_row (GtkSheet * sheet,
502 /* select the column. The range is then highlighted, and the bounds are stored
505 gtk_sheet_select_column (GtkSheet * sheet,
508 /* save selected range to "clipboard" */
510 gtk_sheet_clip_range (GtkSheet *sheet, const GtkSheetRange *range);
513 gtk_sheet_unclip_range (GtkSheet *sheet);
516 gtk_sheet_in_clip (GtkSheet *sheet);
518 /* get scrollbars adjustment */
520 gtk_sheet_get_vadjustment (GtkSheet * sheet);
522 gtk_sheet_get_hadjustment (GtkSheet * sheet);
524 /* highlight the selected range and store bounds in sheet->range */
525 void gtk_sheet_select_range (GtkSheet *sheet,
526 const GtkSheetRange *range);
529 void gtk_sheet_unselect_range (GtkSheet *sheet);
531 /* set active cell where the entry will be displayed
532 * returns FALSE if current cell can't be deactivated or
533 * requested cell can't be activated */
535 gtk_sheet_set_active_cell (GtkSheet *sheet,
536 gint row, gint column);
538 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
539 ROW and/or COLUMN may be null if the caller is not interested in their
542 gtk_sheet_get_active_cell (GtkSheet *sheet,
543 gint *row, gint *column);
545 /* set cell contents and allocate memory if needed */
547 gtk_sheet_set_cell (GtkSheet *sheet,
549 GtkJustification justification,
552 gtk_sheet_set_cell_text (GtkSheet *sheet,
555 /* get cell contents */
557 gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
559 /* clear cell contents */
561 gtk_sheet_cell_clear (GtkSheet *sheet, gint row, gint col);
563 /* clear range contents. If range==NULL the whole sheet will be cleared */
565 gtk_sheet_range_clear (GtkSheet *sheet,
566 const GtkSheetRange *range);
568 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
570 gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
572 /* get row and column correspondig to the given position in the screen */
574 gtk_sheet_get_pixel_info (GtkSheet * sheet,
580 /* get area of a given cell */
582 gtk_sheet_get_cell_area (GtkSheet *sheet,
589 gtk_sheet_set_row_height (GtkSheet * sheet,
594 /* delete nrows rows starting in row */
596 gtk_sheet_delete_rows (GtkSheet *sheet, guint row, guint nrows);
598 /* append nrows row to the end of the sheet */
600 gtk_sheet_add_row (GtkSheet *sheet, guint nrows);
602 /* insert nrows rows before the given row and pull right */
604 gtk_sheet_insert_rows (GtkSheet *sheet, guint row, guint nrows);
606 /* set abckground color of the given range */
608 gtk_sheet_range_set_background (GtkSheet *sheet,
609 const GtkSheetRange *range,
610 const GdkColor *color);
612 /* set foreground color (text color) of the given range */
614 gtk_sheet_range_set_foreground (GtkSheet *sheet,
615 const GtkSheetRange *range,
616 const GdkColor *color);
618 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
619 * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
620 * default justification for numbers is GTK_JUSTIFY_RIGHT */
622 gtk_sheet_range_set_justification (GtkSheet *sheet,
623 const GtkSheetRange *range,
624 GtkJustification justification);
626 gtk_sheet_column_set_justification (GtkSheet *sheet,
628 GtkJustification justification);
629 /* set if cell contents can be edited or not in the given range:
630 * accepted values are TRUE or FALSE. */
632 gtk_sheet_range_set_editable (GtkSheet *sheet,
633 const GtkSheetRange *range,
636 /* set if cell contents are visible or not in the given range:
637 * accepted values are TRUE or FALSE.*/
639 gtk_sheet_range_set_visible (GtkSheet *sheet,
640 const GtkSheetRange *range,
643 /* set cell border style in the given range.
644 * mask values are CELL_LEFT_BORDER, CELL_RIGHT_BORDER, CELL_TOP_BORDER,
646 * width is the width of the border line in pixels
647 * line_style is the line_style for the border line */
649 gtk_sheet_range_set_border (GtkSheet *sheet,
650 const GtkSheetRange *range,
655 /* set border color for the given range */
657 gtk_sheet_range_set_border_color (GtkSheet *sheet,
658 const GtkSheetRange *range,
659 const GdkColor *color);
661 /* set font for the given range */
663 gtk_sheet_range_set_font (GtkSheet *sheet,
664 const GtkSheetRange *range,
665 PangoFontDescription *font);
667 /* get cell attributes of the given cell */
668 /* TRUE means that the cell is currently allocated */
670 gtk_sheet_get_attributes (const GtkSheet *sheet,
672 GtkSheetCellAttr *attributes);
676 gtk_sheet_put (GtkSheet *sheet,
680 gtk_sheet_attach_floating (GtkSheet *sheet,
684 gtk_sheet_attach_default (GtkSheet *sheet,
688 gtk_sheet_attach (GtkSheet *sheet,
698 gtk_sheet_move_child (GtkSheet *sheet,
703 gtk_sheet_get_child_at (GtkSheet *sheet,
707 gtk_sheet_button_attach (GtkSheet *sheet,
713 void gtk_sheet_set_model (GtkSheet *sheet,
716 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
721 #endif /* __cplusplus */
724 #endif /* __GTK_SHEET_H__ */