lib/gtksheet/gsheetmodel.h

   1 /* GSheetModel --- an abstract model for the GtkSheet widget.
   2  * Copyright (C) 2006 Free Software Foundation
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18
  19 #ifndef __G_SHEET_MODEL_H__
  20 #define __G_SHEET_MODEL_H__
  21
  22
  23 /* This file provides an abstract interface or the data displayed by the
  24    GtkSheet widget */
  25
  26 #include <glib-object.h>
  27 #include <gdk/gdk.h>
  28 #include <gtk/gtk.h>
  29 #include "gtkextra-sheet.h"
  30
  31 G_BEGIN_DECLS
  32
  33 #define G_TYPE_SHEET_MODEL            (g_sheet_model_get_type ())
  34 #define G_SHEET_MODEL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SHEET_MODEL, GSheetModel))
  35 #define G_IS_SHEET_MODEL(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SHEET_MODEL))
  36 #define G_SHEET_MODEL_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SHEET_MODEL, GSheetModelIface))
  37
  38 typedef enum
  39 {
  40   GTK_SHEET_LEFT_BORDER     = 1 << 0,
  41   GTK_SHEET_RIGHT_BORDER    = 1 << 1,
  42   GTK_SHEET_TOP_BORDER      = 1 << 2,
  43   GTK_SHEET_BOTTOM_BORDER   = 1 << 3
  44 } GtkSheetBorderType ;
  45
  46
  47 typedef struct _GSheetModel        GSheetModel; /* Dummy typedef */
  48 typedef struct _GSheetModelIface   GSheetModelIface;
  49 typedef struct _GtkSheetRange GtkSheetRange;
  50 typedef struct _GtkSheetCellBorder     GtkSheetCellBorder;
  51
  52 struct _GtkSheetRange
  53 {
  54   glong row0, col0; /* upper-left cell */
  55   glong rowi, coli; /* lower-right cell */
  56 };
  57
  58 struct _GtkSheetCellBorder
  59 {
  60   GtkSheetBorderType mask;
  61   guint width;
  62   GdkLineStyle line_style;
  63   GdkCapStyle cap_style;
  64   GdkJoinStyle join_style;
  65   GdkColor color;
  66 };
  67
  68
  69
  70 struct _GSheetModelIface
  71 {
  72   GTypeInterface g_iface;
  73
  74   gboolean free_strings;
  75
  76   /* Signals */
  77   void         (* range_changed)    (GSheetModel *sheet_model,
  78                                      glong row0, glong col0,
  79                                      glong rowi, glong coli);
  80
  81   void         (* rows_inserted)    (GSheetModel *sheet_model,
  82                                      glong row, glong n_rows);
  83
  84   void         (* rows_deleted)     (GSheetModel *sheet_model,
  85                                      glong row, glong n_rows);
  86
  87   void         (* columns_inserted)    (GSheetModel *sheet_model,
  88                                         glong column, glong n_columns);
  89
  90   void         (* columns_deleted)     (GSheetModel *sheet_model,
  91                                         glong column, glong n_columns);
  92
  93
  94
  95
  96
  97
  98   /* Virtual Table */
  99
 100   gchar *      (* get_string)      (const GSheetModel *sheet_model,
 101                                     glong row, glong column);
 102
 103   gboolean  (* set_string) (GSheetModel *sheet_model,
 104                             const gchar *s, glong row, glong column);
 105
 106   gboolean  (* clear_datum) (GSheetModel *sheet_model,
 107                              glong row, glong column);
 108
 109   gboolean (* is_visible) (const GSheetModel *sheet_model, glong row, glong column);
 110   gboolean (* is_editable) (const GSheetModel *sheet_model, glong row, glong column);
 111
 112   GdkColor *  (* get_foreground) (const GSheetModel *sheet_model,
 113                                   glong row, glong column);
 114
 115   GdkColor *  (* get_background) (const GSheetModel *sheet_model,
 116                                   glong row, glong column);
 117
 118   const GtkJustification *  (* get_justification) (const GSheetModel *sheet_model,
 119                                                    glong row, glong column);
 120
 121   const PangoFontDescription *  (* get_font_desc) (const GSheetModel *sheet_model,
 122                                                    glong row, glong column);
 123
 124   const GtkSheetCellBorder *  (* get_cell_border) (const GSheetModel *sheet_model,
 125                                                    glong row, glong column);
 126
 127
 128
 129   /* column related metadata */
 130
 131   gchar * (*get_column_title) (const GSheetModel *mode, gint col);
 132   gchar * (*get_column_subtitle) (const GSheetModel *mode, gint col);
 133   gboolean * (*get_column_sensitivity) (const GSheetModel *mode, gint col);
 134   GtkJustification (*get_column_justification) (const GSheetModel *mode, gint col);
 135   const GtkSheetButton * (* get_button) (const GSheetModel *model, gint col);
 136
 137   glong (*get_column_count) (const GSheetModel *model);
 138
 139
 140   /* row related metadata */
 141   glong (*get_row_count) (const GSheetModel *model);
 142 };
 143
 144
 145
 146 GType              g_sheet_model_get_type   (void) G_GNUC_CONST;
 147
 148
 149 gchar * g_sheet_model_get_string (const GSheetModel *sheet_model,
 150                                   glong row, glong column);
 151
 152 gboolean  g_sheet_model_set_string (GSheetModel *sheet_model,
 153                                     const gchar *s,
 154                                     glong row, glong column);
 155
 156 gboolean g_sheet_model_datum_clear    (GSheetModel *sheet_model,
 157                                        glong row, glong column);
 158
 159
 160 void g_sheet_model_range_changed (GSheetModel *sheet_model,
 161                                   glong row0, glong col0,
 162                                   glong rowi, glong coli);
 163
 164 void g_sheet_model_rows_deleted (GSheetModel *sheet_model,
 165                                  glong row, glong n_rows);
 166
 167 void g_sheet_model_rows_inserted (GSheetModel *sheet_model,
 168                                   glong row, glong n_rows);
 169
 170 void g_sheet_model_columns_inserted (GSheetModel *sheet_model,
 171                                      glong column, glong n_columns);
 172
 173 void g_sheet_model_columns_deleted (GSheetModel *sheet_model,
 174                                     glong column, glong n_columns);
 175
 176
 177 gboolean g_sheet_model_is_editable (const GSheetModel *model,
 178                                     glong row, glong column);
 179
 180 gboolean g_sheet_model_is_visible
 181  (const GSheetModel *model, glong row, glong column);
 182
 183
 184 GdkColor *g_sheet_model_get_foreground
 185  (const GSheetModel *model, glong row, glong column);
 186
 187 GdkColor *g_sheet_model_get_background
 188  (const GSheetModel *model, glong row, glong column);
 189
 190
 191 const GtkJustification *g_sheet_model_get_justification
 192  (const GSheetModel *model, glong row, glong column);
 193
 194
 195 const PangoFontDescription *g_sheet_model_get_font_desc
 196  (const GSheetModel *model, glong row, glong column);
 197
 198 const GtkSheetCellBorder * g_sheet_model_get_cell_border
 199  (const GSheetModel *model, glong row, glong column);
 200
 201 gboolean g_sheet_model_free_strings (const GSheetModel *sheet_model);
 202
 203 glong g_sheet_model_get_column_count (const GSheetModel *sheet_model);
 204
 205 gint g_sheet_model_get_row_count (const GSheetModel *sheet_model);
 206
 207 \f
 208
 209 gboolean g_sheet_model_get_column_sensitivity (const GSheetModel *model,
 210                                                gint col);
 211
 212 gchar * g_sheet_model_get_column_subtitle (const GSheetModel *model,
 213                                             gint col);
 214
 215 GtkSheetButton * g_sheet_model_get_column_button (const GSheetModel *, gint);
 216
 217 GtkJustification g_sheet_model_get_column_justification (const GSheetModel *,
 218                                                          gint);
 219
 220
 221 G_END_DECLS
 222
 223 #endif /* __G_SHEET_MODEL_H__ */