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;
89 struct _GtkSheetCellAttr
91 GtkJustification justification;
92 const PangoFontDescription *font_desc;
95 GtkSheetCellBorder border;
108 GtkContainer container;
110 GSheetColumn *column_geometry;
111 GSheetRow *row_geometry;
117 GtkSelectionMode selection_mode;
121 gboolean justify_entry;
125 /* Background colors */
133 /* allocation rectangle after the container_border_width
134 and the width of the shadow border */
135 GdkRectangle internal_allocation;
139 gint16 column_requisition;
140 gint16 row_requisition;
142 gboolean rows_resizable;
143 gboolean columns_resizable;
145 /* Displayed range */
149 GtkSheetCell active_cell;
150 GtkWidget *sheet_entry;
154 /* expanding selection */
155 GtkSheetCell selection_cell;
157 /* timer for automatic scroll during selection */
159 /* timer for flashing clipped range */
163 /* global selection button */
172 /*the scrolling window and it's height and width to
173 * make things a little speedier */
174 GdkWindow *sheet_window;
175 guint sheet_window_width;
176 guint sheet_window_height;
178 /* sheet backing pixmap */
181 /* offsets for scrolling */
184 gfloat old_hadjustment;
185 gfloat old_vadjustment;
187 /* border shadow style */
188 GtkShadowType shadow_type;
191 GdkRectangle column_title_area;
192 GdkWindow *column_title_window;
193 gboolean column_titles_visible;
196 GdkRectangle row_title_area;
197 GdkWindow *row_title_window;
198 gboolean row_titles_visible;
201 GtkAdjustment *hadjustment;
202 GtkAdjustment *vadjustment;
204 /* xor GC for the verticle drag line */
207 /* gc for drawing unselected cells */
211 /* cursor used to indicate dragging */
212 GdkCursor *cursor_drag;
214 /* the current x-pixel location of the xor-drag vline */
217 /* the current y-pixel location of the xor-drag hline */
220 /* current cell being dragged */
221 GtkSheetCell drag_cell;
222 /* current range being dragged */
223 GtkSheetRange drag_range;
226 GtkSheetRange clip_range;
229 struct _GtkSheetClass
231 GtkContainerClass parent_class;
233 void (*set_scroll_adjustments) (GtkSheet *sheet,
234 GtkAdjustment *hadjustment,
235 GtkAdjustment *vadjustment);
237 void (*select_row) (GtkSheet *sheet, gint row);
239 void (*select_column) (GtkSheet *sheet, gint column);
241 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
243 void (*clip_range) (GtkSheet *sheet, GtkSheetRange *clip_range);
245 void (*resize_range) (GtkSheet *sheet,
246 GtkSheetRange *old_range,
247 GtkSheetRange *new_range);
249 void (*move_range) (GtkSheet *sheet,
250 GtkSheetRange *old_range,
251 GtkSheetRange *new_range);
253 gboolean (*traverse) (GtkSheet *sheet,
254 gint row, gint column,
255 gint *new_row, gint *new_column);
257 gboolean (*deactivate) (GtkSheet *sheet,
258 gint row, gint column);
260 gboolean (*activate) (GtkSheet *sheet,
261 gint row, gint column);
263 void (*set_cell) (GtkSheet *sheet,
264 gint row, gint column);
266 void (*clear_cell) (GtkSheet *sheet,
267 gint row, gint column);
269 void (*changed) (GtkSheet *sheet,
270 gint row, gint column);
272 void (*new_column_width) (GtkSheet *sheet,
276 void (*new_row_height) (GtkSheet *sheet,
282 GType gtk_sheet_get_type (void);
283 GtkType gtk_sheet_range_get_type (void);
286 /* create a new sheet */
287 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
294 /* create a new browser sheet. It cells can not be edited */
296 gtk_sheet_new_browser (guint rows, guint columns, const gchar *title);
299 gtk_sheet_construct_browser (GtkSheet *sheet,
300 guint rows, guint columns, const gchar *title);
302 /* create a new sheet with custom entry */
304 gtk_sheet_new_with_custom_entry (GSheetRow *vgeo,
309 gtk_sheet_construct_with_custom_entry (GtkSheet *sheet,
314 /* change scroll adjustments */
316 gtk_sheet_set_hadjustment (GtkSheet *sheet,
317 GtkAdjustment *adjustment);
319 gtk_sheet_set_vadjustment (GtkSheet *sheet,
320 GtkAdjustment *adjustment);
323 gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
325 /* Returns sheet's entry widget */
327 gtk_sheet_get_entry (GtkSheet *sheet);
329 gtk_sheet_get_entry_widget (GtkSheet *sheet);
331 /* Returns sheet->state
332 * Added by Steven Rostedt <steven.rostedt@lmco.com> */
334 gtk_sheet_get_state (GtkSheet *sheet);
336 /* Returns sheet's ranges
337 * Added by Murray Cumming */
339 gtk_sheet_get_columns_count (GtkSheet *sheet);
342 gtk_sheet_get_rows_count (GtkSheet *sheet);
345 gtk_sheet_get_visible_range (GtkSheet *sheet,
346 GtkSheetRange *range);
348 gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
351 gtk_sheet_set_autoresize (GtkSheet *sheet, gboolean autoresize);
354 gtk_sheet_autoresize (GtkSheet *sheet);
357 gtk_sheet_set_autoscroll (GtkSheet *sheet, gboolean autoscroll);
360 gtk_sheet_autoscroll (GtkSheet *sheet);
363 gtk_sheet_set_clip_text (GtkSheet *sheet, gboolean clip_text);
366 gtk_sheet_clip_text (GtkSheet *sheet);
369 gtk_sheet_set_justify_entry (GtkSheet *sheet, gboolean justify);
372 gtk_sheet_justify_entry (GtkSheet *sheet);
375 gtk_sheet_set_locked (GtkSheet *sheet, gboolean lock);
378 gtk_sheet_locked (const GtkSheet *sheet);
380 /* set sheet title */
382 gtk_sheet_set_title (GtkSheet *sheet, const gchar *title);
384 /* freeze all visual updates of the sheet.
385 * Then thaw the sheet after you have made a number of changes.
386 * The updates will occure in a more efficent way than if
387 * you made them on a unfrozen sheet */
389 gtk_sheet_freeze (GtkSheet *sheet);
391 gtk_sheet_thaw (GtkSheet *sheet);
392 /* Background colors */
394 gtk_sheet_set_background (GtkSheet *sheet,
397 gtk_sheet_set_grid (GtkSheet *sheet,
398 GdkColor *grid_color);
400 gtk_sheet_show_grid (GtkSheet *sheet,
403 gtk_sheet_grid_visible (GtkSheet *sheet);
405 /* set/get column title */
407 gtk_sheet_set_column_title (GtkSheet * sheet,
409 const gchar * title);
412 gtk_sheet_get_column_title (GtkSheet * sheet,
415 /* set/get row title */
417 gtk_sheet_set_row_title (GtkSheet * sheet,
419 const gchar * title);
421 gtk_sheet_get_row_title (GtkSheet * sheet,
425 /* set/get button label */
427 gtk_sheet_row_button_add_label (GtkSheet *sheet,
428 gint row, const gchar *label);
430 gtk_sheet_row_button_get_label (GtkSheet *sheet,
433 gtk_sheet_row_button_justify (GtkSheet *sheet,
434 gint row, GtkJustification justification);
438 /* scroll the viewing area of the sheet to the given column
439 * and row; row_align and col_align are between 0-1 representing the
440 * location the row should appear on the screen, 0.0 being top or left,
441 * 1.0 being bottom or right; if row or column is negative then there
444 gtk_sheet_moveto (GtkSheet * sheet,
452 gtk_sheet_show_row_titles (GtkSheet *sheet);
454 gtk_sheet_hide_row_titles (GtkSheet *sheet);
456 gtk_sheet_row_titles_visible (GtkSheet *sheet);
459 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
460 * otherwise it acts as a title */
462 gtk_sheet_row_set_sensitivity (GtkSheet *sheet,
463 gint row, gboolean sensitive);
465 /* set sensitivity for all row buttons */
467 gtk_sheet_rows_set_sensitivity (GtkSheet *sheet, gboolean sensitive);
469 gtk_sheet_rows_set_resizable (GtkSheet *sheet, gboolean resizable);
471 gtk_sheet_rows_resizable (GtkSheet *sheet);
473 /* set row visibility. The default value is TRUE. If FALSE, the
476 gtk_sheet_row_set_visibility (GtkSheet *sheet,
477 gint row, gboolean visible);
479 gtk_sheet_row_label_set_visibility (GtkSheet *sheet,
480 gint row, gboolean visible);
482 gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
485 /* select the row. The range is then highlighted, and the bounds are stored
488 gtk_sheet_select_row (GtkSheet * sheet,
491 /* select the column. The range is then highlighted, and the bounds are stored
494 gtk_sheet_select_column (GtkSheet * sheet,
497 /* save selected range to "clipboard" */
499 gtk_sheet_clip_range (GtkSheet *sheet, const GtkSheetRange *range);
502 gtk_sheet_unclip_range (GtkSheet *sheet);
505 gtk_sheet_in_clip (GtkSheet *sheet);
507 /* get scrollbars adjustment */
509 gtk_sheet_get_vadjustment (GtkSheet * sheet);
511 gtk_sheet_get_hadjustment (GtkSheet * sheet);
513 /* highlight the selected range and store bounds in sheet->range */
514 void gtk_sheet_select_range (GtkSheet *sheet,
515 const GtkSheetRange *range);
518 void gtk_sheet_unselect_range (GtkSheet *sheet);
520 /* set active cell where the entry will be displayed
521 * returns FALSE if current cell can't be deactivated or
522 * requested cell can't be activated */
524 gtk_sheet_set_active_cell (GtkSheet *sheet,
525 gint row, gint column);
527 gtk_sheet_get_active_cell (GtkSheet *sheet,
528 gint *row, gint *column);
530 /* set cell contents and allocate memory if needed */
532 gtk_sheet_set_cell (GtkSheet *sheet,
534 GtkJustification justification,
537 gtk_sheet_set_cell_text (GtkSheet *sheet,
540 /* get cell contents */
542 gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
544 /* clear cell contents */
546 gtk_sheet_cell_clear (GtkSheet *sheet, gint row, gint col);
547 /* clear cell contents and remove links */
549 gtk_sheet_cell_delete (GtkSheet *sheet, gint row, gint col);
551 /* clear range contents. If range==NULL the whole sheet will be cleared */
553 gtk_sheet_range_clear (GtkSheet *sheet,
554 const GtkSheetRange *range);
555 /* clear range contents and remove links */
557 gtk_sheet_range_delete (GtkSheet *sheet,
558 const GtkSheetRange *range);
560 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
562 gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
564 /* get row and column correspondig to the given position in the screen */
566 gtk_sheet_get_pixel_info (GtkSheet * sheet,
572 /* get area of a given cell */
574 gtk_sheet_get_cell_area (GtkSheet *sheet,
581 gtk_sheet_set_row_height (GtkSheet * sheet,
586 /* delete nrows rows starting in row */
588 gtk_sheet_delete_rows (GtkSheet *sheet, guint row, guint nrows);
590 /* append nrows row to the end of the sheet */
592 gtk_sheet_add_row (GtkSheet *sheet, guint nrows);
594 /* insert nrows rows before the given row and pull right */
596 gtk_sheet_insert_rows (GtkSheet *sheet, guint row, guint nrows);
598 /* set abckground color of the given range */
600 gtk_sheet_range_set_background (GtkSheet *sheet,
601 const GtkSheetRange *range,
602 const GdkColor *color);
604 /* set foreground color (text color) of the given range */
606 gtk_sheet_range_set_foreground (GtkSheet *sheet,
607 const GtkSheetRange *range,
608 const GdkColor *color);
610 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
611 * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
612 * default justification for numbers is GTK_JUSTIFY_RIGHT */
614 gtk_sheet_range_set_justification (GtkSheet *sheet,
615 const GtkSheetRange *range,
616 GtkJustification justification);
618 gtk_sheet_column_set_justification (GtkSheet *sheet,
620 GtkJustification justification);
621 /* set if cell contents can be edited or not in the given range:
622 * accepted values are TRUE or FALSE. */
624 gtk_sheet_range_set_editable (GtkSheet *sheet,
625 const GtkSheetRange *range,
628 /* set if cell contents are visible or not in the given range:
629 * accepted values are TRUE or FALSE.*/
631 gtk_sheet_range_set_visible (GtkSheet *sheet,
632 const GtkSheetRange *range,
635 /* set cell border style in the given range.
636 * mask values are CELL_LEFT_BORDER, CELL_RIGHT_BORDER, CELL_TOP_BORDER,
638 * width is the width of the border line in pixels
639 * line_style is the line_style for the border line */
641 gtk_sheet_range_set_border (GtkSheet *sheet,
642 const GtkSheetRange *range,
647 /* set border color for the given range */
649 gtk_sheet_range_set_border_color (GtkSheet *sheet,
650 const GtkSheetRange *range,
651 const GdkColor *color);
653 /* set font for the given range */
655 gtk_sheet_range_set_font (GtkSheet *sheet,
656 const GtkSheetRange *range,
657 PangoFontDescription *font);
659 /* get cell attributes of the given cell */
660 /* TRUE means that the cell is currently allocated */
662 gtk_sheet_get_attributes (const GtkSheet *sheet,
664 GtkSheetCellAttr *attributes);
668 gtk_sheet_put (GtkSheet *sheet,
672 gtk_sheet_attach_floating (GtkSheet *sheet,
676 gtk_sheet_attach_default (GtkSheet *sheet,
680 gtk_sheet_attach (GtkSheet *sheet,
690 gtk_sheet_move_child (GtkSheet *sheet,
695 gtk_sheet_get_child_at (GtkSheet *sheet,
699 gtk_sheet_button_attach (GtkSheet *sheet,
705 void gtk_sheet_set_model(GtkSheet *sheet,
708 GSheetModel * gtk_sheet_get_model(const GtkSheet *sheet);
713 #endif /* __cplusplus */
716 #endif /* __GTK_SHEET_H__ */