1 /* GSheetModel --- an abstract model for the GtkSheet widget.
2 * Copyright (C) 2006 Free Software Foundation
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.
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.
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
18 #ifndef __G_SHEET_MODEL_H__
19 #define __G_SHEET_MODEL_H__
22 /* This file provides an abstract interface or the data displayed by the
25 #include <glib-object.h>
32 #define G_TYPE_SHEET_MODEL (g_sheet_model_get_type ())
33 #define G_SHEET_MODEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SHEET_MODEL, GSheetModel))
34 #define G_IS_SHEET_MODEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SHEET_MODEL))
35 #define G_SHEET_MODEL_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SHEET_MODEL, GSheetModelIface))
39 GTK_SHEET_LEFT_BORDER = 1 << 0,
40 GTK_SHEET_RIGHT_BORDER = 1 << 1,
41 GTK_SHEET_TOP_BORDER = 1 << 2,
42 GTK_SHEET_BOTTOM_BORDER = 1 << 3
43 } GtkSheetBorderType ;
46 typedef struct _GSheetModel GSheetModel; /* Dummy typedef */
47 typedef struct _GSheetModelIface GSheetModelIface;
48 typedef struct _GtkSheetRange GtkSheetRange;
49 typedef struct _GtkSheetCellBorder GtkSheetCellBorder;
53 gint row0,col0; /* upper-left cell */
54 gint rowi,coli; /* lower-right cell */
57 struct _GtkSheetCellBorder
59 GtkSheetBorderType mask;
61 GdkLineStyle line_style;
62 GdkCapStyle cap_style;
63 GdkJoinStyle join_style;
69 struct _GSheetModelIface
71 GTypeInterface g_iface;
74 void (* range_changed) (GSheetModel *sheet_model,
76 gint rowi, gint coli);
78 void (* rows_inserted) (GSheetModel *sheet_model,
79 gint row, gint n_rows);
81 void (* rows_deleted) (GSheetModel *sheet_model,
82 gint row, gint n_rows);
87 const gchar * (* get_string) (const GSheetModel *sheet_model,
88 gint row, gint column);
90 gboolean (* set_string) (GSheetModel *sheet_model,
91 const gchar *s, gint row, gint column);
93 gboolean (* clear_datum) (GSheetModel *sheet_model,
94 gint row, gint column);
96 gboolean (* is_visible) (const GSheetModel *sheet_model, gint row, gint column);
97 gboolean (* is_editable) (const GSheetModel *sheet_model, gint row, gint column);
99 const GdkColor * (* get_foreground) (const GSheetModel *sheet_model,
100 gint row, gint column);
102 const GdkColor * (* get_background) (const GSheetModel *sheet_model,
103 gint row, gint column);
105 const GtkJustification * (* get_justification) (const GSheetModel *sheet_model,
106 gint row, gint column);
108 const PangoFontDescription * (* get_font_desc) (const GSheetModel *sheet_model,
109 gint row, gint column);
111 const GtkSheetCellBorder * (* get_cell_border) (const GSheetModel *sheet_model,
112 gint row, gint column);
118 GType g_sheet_model_get_type (void) G_GNUC_CONST;
121 inline const gchar * g_sheet_model_get_string (const GSheetModel *sheet_model,
122 gint row, gint column);
124 inline gboolean g_sheet_model_set_string (GSheetModel *sheet_model,
126 gint row, gint column);
128 inline gboolean g_sheet_model_datum_clear (GSheetModel *sheet_model,
129 gint row, gint column);
132 inline void g_sheet_model_range_changed (GSheetModel *sheet_model,
133 gint row0, gint col0,
134 gint rowi, gint coli);
136 inline void g_sheet_model_rows_deleted (GSheetModel *sheet_model,
137 gint row, gint n_rows);
139 inline void g_sheet_model_rows_inserted (GSheetModel *sheet_model,
140 gint row, gint n_rows);
142 inline gboolean g_sheet_model_is_editable (const GSheetModel *model,
143 gint row, gint column);
145 inline gboolean g_sheet_model_is_visible
146 (const GSheetModel *model, gint row, gint column);
149 inline const GdkColor *g_sheet_model_get_foreground
150 (const GSheetModel *model, gint row, gint column);
152 inline const GdkColor *g_sheet_model_get_background
153 (const GSheetModel *model, gint row, gint column);
156 inline const GtkJustification *g_sheet_model_get_justification
157 (const GSheetModel *model, gint row, gint column);
160 inline const PangoFontDescription *g_sheet_model_get_font_desc
161 (const GSheetModel *model, gint row, gint column);
163 inline const GtkSheetCellBorder * g_sheet_model_get_cell_border
164 (const GSheetModel *model, gint row, gint column);
171 #endif /* __G_SHEET_MODEL_H__ */