Start of new branch involving major rewrite of lib/gtksheet/*
[pspp-builds.git] / lib / gtksheet / gtksheet.h
index 4f402252aabfd8473a2d5d31be3f1967ca46ce7e..6aaa49a99c6ca388cf7d3776fa07a5c9ee100280 100644 (file)
@@ -34,9 +34,7 @@
 #include "gsheet-row-iface.h"
 
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
 
 
 typedef enum
@@ -69,13 +67,9 @@ enum
 #define GTK_SHEET_CLASS(klass)  GTK_CHECK_CLASS_CAST (klass, gtk_sheet_get_type (), GtkSheetClass)
 #define GTK_IS_SHEET(obj)       GTK_CHECK_TYPE (obj, gtk_sheet_get_type ())
 
-/* Public flags, for compatibility */
 
-#define GTK_SHEET_ROW_FROZEN(sheet)      !gtk_sheet_rows_resizable (sheet)
-#define GTK_SHEET_COLUMN_FROZEN(sheet)   !gtk_sheet_columns_resizable (sheet)
+
 #define GTK_SHEET_AUTORESIZE(sheet)      gtk_sheet_autoresize (sheet)
-#define GTK_SHEET_ROW_TITLES_VISIBLE(sheet)   gtk_sheet_row_titles_visible (sheet)
-#define GTK_SHEET_COL_TITLES_VISIBLE(sheet)   gtk_sheet_column_titles_visible (sheet)
 #define GTK_SHEET_AUTO_SCROLL(sheet)     gtk_sheet_autoscroll (sheet)
 #define GTK_SHEET_JUSTIFY_ENTRY(sheet)   gtk_sheet_justify_entry (sheet)
 
@@ -103,6 +97,7 @@ struct _GtkSheetCell
   gint col;
 };
 
+
 struct _GtkSheetHoverTitle
 {
   GtkWidget *window;
@@ -112,8 +107,7 @@ struct _GtkSheetHoverTitle
 
 struct _GtkSheet
 {
-  GtkContainer container;
-
+  GtkBin parent;
 
   gboolean dispose_has_run;
   GSheetColumn *column_geometry;
@@ -133,9 +127,6 @@ struct _GtkSheet
   GdkColor grid_color;
   gboolean show_grid;
 
-  /* sheet children */
-  GList *children;
-
   /* allocation rectangle after the container_border_width
      and the width of the shadow border */
   GdkRectangle internal_allocation;
@@ -180,12 +171,6 @@ struct _GtkSheet
   /* sheet backing pixmap */
   GdkPixmap *pixmap;
 
-  /* offsets for scrolling */
-  gint hoffset;
-  gint voffset;
-  gfloat old_hadjustment;
-  gfloat old_vadjustment;
-
   /* border shadow style */
   GtkShadowType shadow_type;
 
@@ -193,18 +178,20 @@ struct _GtkSheet
   GdkRectangle column_title_area;
   GdkWindow *column_title_window;
   gboolean column_titles_visible;
+  /* TRUE if the cursor is over the column title window */
+  gboolean column_title_under;
 
   /* Row Titles */
   GdkRectangle row_title_area;
   GdkWindow *row_title_window;
   gboolean row_titles_visible;
+  /* TRUE if the cursor is over the row title window */
+  gboolean row_title_under;
 
   /*scrollbars*/
   GtkAdjustment *hadjustment;
   GtkAdjustment *vadjustment;
 
-  gint freeze_count;
-
   /* xor GC for the verticle drag line */
   GdkGC *xor_gc;
 
@@ -233,7 +220,7 @@ struct _GtkSheet
 
 struct _GtkSheetClass
 {
GtkContainerClass parent_class;
 GtkBinClass parent_class;
 
  void (*set_scroll_adjustments) (GtkSheet *sheet,
                                 GtkAdjustment *hadjustment,
@@ -275,17 +262,6 @@ GtkType gtk_sheet_range_get_type (void);
 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
                           GSheetModel *model);
 
-
-
-
-/* create a new browser sheet. It cells can not be edited */
-GtkWidget *
-gtk_sheet_new_browser                  (guint rows, guint columns, const gchar *title);
-
-void
-gtk_sheet_construct_browser            (GtkSheet *sheet,
-                                                guint rows, guint columns, const gchar *title);
-
 /* create a new sheet with custom entry */
 GtkWidget *
 gtk_sheet_new_with_custom_entry        (GSheetRow *vgeo,
@@ -296,202 +272,125 @@ gtk_sheet_construct_with_custom_entry   (GtkSheet *sheet,
                                         GSheetRow *vgeo,
                                         GSheetColumn *hgeo,
                                         GtkType entry_type);
-/* change scroll adjustments */
-void
-gtk_sheet_set_hadjustment              (GtkSheet *sheet,
-                                        GtkAdjustment *adjustment);
-void
-gtk_sheet_set_vadjustment              (GtkSheet *sheet,
-                                        GtkAdjustment *adjustment);
 /* Change entry */
-void
-gtk_sheet_change_entry                 (GtkSheet *sheet, GtkType entry_type);
+void gtk_sheet_change_entry            (GtkSheet *sheet, GtkType entry_type);
 
-/* Returns sheet's entry widget */
-GtkWidget *
-gtk_sheet_get_entry                    (GtkSheet *sheet);
-GtkWidget *
-gtk_sheet_get_entry_widget             (GtkSheet *sheet);
+GtkWidget *gtk_sheet_get_entry    (GtkSheet *sheet);
 
-/* Returns sheet->state
- * Added by Steven Rostedt <steven.rostedt@lmco.com> */
-gint
-gtk_sheet_get_state                    (GtkSheet *sheet);
 
-/* Returns sheet's ranges
- * Added by Murray Cumming */
-guint
-gtk_sheet_get_columns_count            (GtkSheet *sheet);
+guint gtk_sheet_get_columns_count (GtkSheet *sheet);
 
-guint
-gtk_sheet_get_rows_count               (GtkSheet *sheet);
+guint gtk_sheet_get_rows_count           (GtkSheet *sheet);
 
-void
-gtk_sheet_get_visible_range            (GtkSheet *sheet,
+void gtk_sheet_get_selected_range (GtkSheet *sheet,
                                         GtkSheetRange *range);
 
-void
-gtk_sheet_get_selected_range           (GtkSheet *sheet,
-                                        GtkSheetRange *range);
+void gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
 
-void
-gtk_sheet_set_selection_mode           (GtkSheet *sheet, gint mode);
+void gtk_sheet_set_autoresize    (GtkSheet *sheet, gboolean autoresize);
 
-void
-gtk_sheet_set_autoresize               (GtkSheet *sheet, gboolean autoresize);
+gboolean gtk_sheet_autoresize    (GtkSheet *sheet);
 
-gboolean
-gtk_sheet_autoresize                   (GtkSheet *sheet);
+void gtk_sheet_set_autoscroll    (GtkSheet *sheet, gboolean autoscroll);
 
-void
-gtk_sheet_set_autoscroll               (GtkSheet *sheet, gboolean autoscroll);
+gboolean gtk_sheet_autoscroll    (GtkSheet *sheet);
 
-gboolean
-gtk_sheet_autoscroll                   (GtkSheet *sheet);
+void gtk_sheet_set_justify_entry  (GtkSheet *sheet, gboolean justify);
 
-void
-gtk_sheet_set_justify_entry            (GtkSheet *sheet, gboolean justify);
+gboolean gtk_sheet_justify_entry  (GtkSheet *sheet);
 
-gboolean
-gtk_sheet_justify_entry                        (GtkSheet *sheet);
-
-void
-gtk_sheet_set_locked                   (GtkSheet *sheet, gboolean lock);
-
-gboolean
-gtk_sheet_locked                       (const GtkSheet *sheet);
-
-/* set sheet title */
-void
-gtk_sheet_set_title                    (GtkSheet *sheet, const gchar *title);
-
-/* freeze all visual updates of the sheet.
- * Then thaw the sheet after you have made a number of changes.
- * The updates will occure in a more efficent way than if
- * you made them on a unfrozen sheet */
-void
-gtk_sheet_freeze                       (GtkSheet *sheet);
-void
-gtk_sheet_thaw                         (GtkSheet *sheet);
 /* Background colors */
-void
-gtk_sheet_set_background               (GtkSheet *sheet,
+void gtk_sheet_set_background    (GtkSheet *sheet,
                                         GdkColor *bg_color);
-void
-gtk_sheet_set_grid                     (GtkSheet *sheet,
+
+void gtk_sheet_set_grid                  (GtkSheet *sheet,
                                         GdkColor *grid_color);
-void
-gtk_sheet_show_grid                    (GtkSheet *sheet,
+
+void gtk_sheet_show_grid         (GtkSheet *sheet,
                                         gboolean show);
-gboolean
-gtk_sheet_grid_visible                 (GtkSheet *sheet);
+
+gboolean gtk_sheet_grid_visible   (GtkSheet *sheet);
 
 /* set/get column title */
-void
-gtk_sheet_set_column_title             (GtkSheet * sheet,
+void gtk_sheet_set_column_title   (GtkSheet * sheet,
                                        gint column,
                                        const gchar * title);
 
-const gchar *
-gtk_sheet_get_column_title             (GtkSheet * sheet,
+const gchar *gtk_sheet_get_column_title  (GtkSheet * sheet,
                                        gint column);
 
 /* set/get row title */
-void
-gtk_sheet_set_row_title                (GtkSheet * sheet,
+void gtk_sheet_set_row_title     (GtkSheet * sheet,
                                        gint row,
                                        const gchar * title);
-const gchar *
-gtk_sheet_get_row_title                (GtkSheet * sheet,
-                                       gint row);
 
+const gchar *gtk_sheet_get_row_title (GtkSheet * sheet,
+                                     gint row);
 
 /* set/get button label */
-void
-gtk_sheet_row_button_add_label         (GtkSheet *sheet,
+void gtk_sheet_row_button_add_label (GtkSheet *sheet,
                                        gint row, const gchar *label);
-const gchar *
-gtk_sheet_row_button_get_label         (GtkSheet *sheet,
-                                       gint row);
-void
-gtk_sheet_row_button_justify           (GtkSheet *sheet,
-                                       gint row, GtkJustification justification);
 
+const gchar *gtk_sheet_row_button_get_label  (GtkSheet *sheet,
+                                             gint row);
 
+void gtk_sheet_row_button_justify   (GtkSheet *sheet,
+                                    gint row, GtkJustification justification);
 
 /* scroll the viewing area of the sheet to the given column
  * and row; row_align and col_align are between 0-1 representing the
  * location the row should appear on the screen, 0.0 being top or left,
  * 1.0 being bottom or right; if row or column is negative then there
  * is no change */
-void
-gtk_sheet_moveto (GtkSheet *sheet,
+void gtk_sheet_moveto (GtkSheet *sheet,
                  gint row,
                  gint column,
                  gfloat row_align,
                   gfloat col_align);
 
 
-void
-gtk_sheet_show_row_titles              (GtkSheet *sheet);
-void
-gtk_sheet_hide_row_titles              (GtkSheet *sheet);
-void
-gtk_sheet_show_column_titles           (GtkSheet *sheet);
-void
-gtk_sheet_hide_column_titles           (GtkSheet *sheet);
+void gtk_sheet_show_row_titles         (GtkSheet *sheet);
+void gtk_sheet_hide_row_titles         (GtkSheet *sheet);
+void gtk_sheet_show_column_titles       (GtkSheet *sheet);
+void gtk_sheet_hide_column_titles      (GtkSheet *sheet);
 
-gboolean
-gtk_sheet_row_titles_visible           (GtkSheet *sheet);
+gboolean gtk_sheet_row_titles_visible  (GtkSheet *sheet);
 
 
 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
  * otherwise it acts as a title */
-void
-gtk_sheet_row_set_sensitivity          (GtkSheet *sheet,
+void gtk_sheet_row_set_sensitivity      (GtkSheet *sheet,
                                        gint row,  gboolean sensitive);
 
 /* set sensitivity for all row buttons */
-void
-gtk_sheet_rows_set_sensitivity         (GtkSheet *sheet, gboolean sensitive);
-void
-gtk_sheet_rows_set_resizable           (GtkSheet *sheet, gboolean resizable);
-gboolean
-gtk_sheet_rows_resizable               (GtkSheet *sheet);
+void gtk_sheet_rows_set_sensitivity    (GtkSheet *sheet, gboolean sensitive);
+void gtk_sheet_rows_set_resizable      (GtkSheet *sheet, gboolean resizable);
+gboolean gtk_sheet_rows_resizable      (GtkSheet *sheet);
 
 /* set row visibility. The default value is TRUE. If FALSE, the
  * row is hidden */
-void
-gtk_sheet_row_set_visibility           (GtkSheet *sheet,
+void gtk_sheet_row_set_visibility      (GtkSheet *sheet,
                                         gint row, gboolean visible);
-void
-gtk_sheet_row_label_set_visibility     (GtkSheet *sheet,
+
+void gtk_sheet_row_label_set_visibility        (GtkSheet *sheet,
                                         gint row, gboolean visible);
-void
-gtk_sheet_rows_labels_set_visibility   (GtkSheet *sheet, gboolean visible);
+
+void gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
 
 
 /* select the row. The range is then highlighted, and the bounds are stored
  * in sheet->range  */
-void
-gtk_sheet_select_row                   (GtkSheet * sheet,
-                                       gint row);
+void gtk_sheet_select_row    (GtkSheet * sheet,  gint row);
 
 /* select the column. The range is then highlighted, and the bounds are stored
  * in sheet->range  */
-void
-gtk_sheet_select_column                (GtkSheet * sheet,
-                                       gint column);
-
-/* get scrollbars adjustment */
-GtkAdjustment *
-gtk_sheet_get_vadjustment              (GtkSheet * sheet);
-GtkAdjustment *
-gtk_sheet_get_hadjustment              (GtkSheet * sheet);
+void gtk_sheet_select_column (GtkSheet * sheet,  gint column);
 
 /* highlight the selected range and store bounds in sheet->range */
-void gtk_sheet_select_range            (GtkSheet *sheet,
-                                        const GtkSheetRange *range);
+void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
+
+void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
+
 
 /* obvious */
 void gtk_sheet_unselect_range          (GtkSheet *sheet);
@@ -499,112 +398,79 @@ void gtk_sheet_unselect_range            (GtkSheet *sheet);
 /* set active cell where the entry will be displayed
  * returns FALSE if current cell can't be deactivated or
  * requested cell can't be activated */
-gboolean
-gtk_sheet_set_active_cell              (GtkSheet *sheet,
+gboolean gtk_sheet_set_active_cell (GtkSheet *sheet,
                                        gint row, gint column);
 
 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
    ROW and/or COLUMN may be null if the caller is not interested in their
    values */
-void
-gtk_sheet_get_active_cell              (GtkSheet *sheet,
+void gtk_sheet_get_active_cell (GtkSheet *sheet,
                                        gint *row, gint *column);
 
-/* set cell contents and allocate memory if needed */
-void
-gtk_sheet_set_cell                     (GtkSheet *sheet,
-                                       gint row, gint col,
-                                        GtkJustification justification,
-                                       const gchar *text);
-void
-gtk_sheet_set_cell_text                        (GtkSheet *sheet,
-                                       gint row, gint col,
-                                       const gchar *text);
 /* get cell contents */
-gchar *
-gtk_sheet_cell_get_text                (const GtkSheet *sheet, gint row, gint col);
+gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
 
 /* clear cell contents */
-void
-gtk_sheet_cell_clear                   (GtkSheet *sheet, gint row, gint col);
+void gtk_sheet_cell_clear      (GtkSheet *sheet, gint row, gint col);
 
 /* clear range contents. If range==NULL the whole sheet will be cleared */
-void
-gtk_sheet_range_clear                  (GtkSheet *sheet,
+void gtk_sheet_range_clear     (GtkSheet *sheet,
                                         const GtkSheetRange *range);
 
 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
-GtkStateType
-gtk_sheet_cell_get_state               (GtkSheet *sheet, gint row, gint col);
-
-/* get row and column correspondig to the given position in the screen */
-gboolean
-gtk_sheet_get_pixel_info (GtkSheet * sheet,
-                         gint x,
-                         gint y,
-                         gint * row,
-                         gint * column);
+GtkStateType gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
 
 /* get area of a given cell */
-gboolean
-gtk_sheet_get_cell_area (GtkSheet *sheet,
+gboolean gtk_sheet_get_cell_area (GtkSheet *sheet,
                          gint row,
                          gint column,
                          GdkRectangle *area);
 
 /* set row height */
-void
-gtk_sheet_set_row_height (GtkSheet * sheet,
+void gtk_sheet_set_row_height (GtkSheet * sheet,
                          gint row,
                          guint height);
 
 
 /* delete nrows rows starting in row */
-void
-gtk_sheet_delete_rows                  (GtkSheet *sheet, guint row, guint nrows);
+void gtk_sheet_delete_rows    (GtkSheet *sheet, guint row, guint nrows);
 
 /* append nrows row to the end of the sheet */
-void
-gtk_sheet_add_row                      (GtkSheet *sheet, guint nrows);
+void gtk_sheet_add_row       (GtkSheet *sheet, guint nrows);
 
 /* insert nrows rows before the given row and pull right */
-void
-gtk_sheet_insert_rows                  (GtkSheet *sheet, guint row, guint nrows);
+void gtk_sheet_insert_rows    (GtkSheet *sheet, guint row, guint nrows);
 
 /* set abckground color of the given range */
-void
-gtk_sheet_range_set_background         (GtkSheet *sheet,
+void gtk_sheet_range_set_background  (GtkSheet *sheet,
                                        const GtkSheetRange *range,
                                        const GdkColor *color);
 
 /* set foreground color (text color) of the given range */
-void
-gtk_sheet_range_set_foreground         (GtkSheet *sheet,
+void gtk_sheet_range_set_foreground  (GtkSheet *sheet,
                                        const GtkSheetRange *range,
                                        const GdkColor *color);
 
 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
  * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
  * default justification for numbers is GTK_JUSTIFY_RIGHT */
-void
-gtk_sheet_range_set_justification      (GtkSheet *sheet,
+void gtk_sheet_range_set_justification (GtkSheet *sheet,
                                        const GtkSheetRange *range,
                                        GtkJustification justification);
-void
-gtk_sheet_column_set_justification      (GtkSheet *sheet,
+
+void gtk_sheet_column_set_justification (GtkSheet *sheet,
                                         gint column,
                                         GtkJustification justification);
+
 /* set if cell contents can be edited or not in the given range:
  * accepted values are TRUE or FALSE. */
-void
-gtk_sheet_range_set_editable           (GtkSheet *sheet,
+void gtk_sheet_range_set_editable (GtkSheet *sheet,
                                        const GtkSheetRange *range,
                                        gint editable);
 
 /* set if cell contents are visible or not in the given range:
  * accepted values are TRUE or FALSE.*/
-void
-gtk_sheet_range_set_visible            (GtkSheet *sheet,
+void gtk_sheet_range_set_visible  (GtkSheet *sheet,
                                        const GtkSheetRange *range,
                                        gboolean visible);
 
@@ -613,80 +479,36 @@ gtk_sheet_range_set_visible               (GtkSheet *sheet,
  * CELL_BOTTOM_BORDER
  * width is the width of the border line in pixels
  * line_style is the line_style for the border line */
-void
-gtk_sheet_range_set_border             (GtkSheet *sheet,
+void gtk_sheet_range_set_border                (GtkSheet *sheet,
                                        const GtkSheetRange *range,
                                        gint mask,
                                        guint width,
                                        gint line_style);
 
 /* set border color for the given range */
-void
-gtk_sheet_range_set_border_color       (GtkSheet *sheet,
+void gtk_sheet_range_set_border_color  (GtkSheet *sheet,
                                        const GtkSheetRange *range,
                                        const GdkColor *color);
 
 /* set font for the given range */
-void
-gtk_sheet_range_set_font               (GtkSheet *sheet,
+void gtk_sheet_range_set_font          (GtkSheet *sheet,
                                        const GtkSheetRange *range,
                                        PangoFontDescription *font);
 
 /* get cell attributes of the given cell */
 /* TRUE means that the cell is currently allocated */
-gboolean
-gtk_sheet_get_attributes               (const GtkSheet *sheet,
+gboolean gtk_sheet_get_attributes       (const GtkSheet *sheet,
                                        gint row, gint col,
                                        GtkSheetCellAttr *attributes);
 
 
-GtkSheetChild *
-gtk_sheet_put                          (GtkSheet *sheet,
-                                        GtkWidget *widget,
-                                        gint x, gint y);
-void
-gtk_sheet_attach_floating               (GtkSheet *sheet,
-                                         GtkWidget *widget,
-                                         gint row, gint col);
-void
-gtk_sheet_attach_default                (GtkSheet *sheet,
-                                         GtkWidget *widget,
-                                         gint row, gint col);
-void
-gtk_sheet_attach                        (GtkSheet *sheet,
-                                         GtkWidget *widget,
-                                         gint row, gint col,
-                                         gint xoptions,
-                                         gint yoptions,
-                                         gint xpadding,
-                                         gint ypadding);
-
-
-void
-gtk_sheet_move_child                   (GtkSheet *sheet,
-                                        GtkWidget *widget,
-                                        gint x, gint y);
-
-GtkSheetChild *
-gtk_sheet_get_child_at                 (GtkSheet *sheet,
-                                        gint row, gint col);
-
-void
-gtk_sheet_button_attach                        (GtkSheet *sheet,
-                                        GtkWidget *widget,
-                                        gint row, gint col);
-
-
-
 void           gtk_sheet_set_model (GtkSheet *sheet,
                                   GSheetModel *model);
 
 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
 
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
 
 
 #endif /* __GTK_SHEET_H__ */