1/* gtkcellareacontext.h
2 *
3 * Copyright (C) 2010 Openismus GmbH
4 *
5 * Authors:
6 * Tristan Van Berkom <tristanvb@openismus.com>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
17 *
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#ifndef __GTK_CELL_AREA_CONTEXT_H__
23#define __GTK_CELL_AREA_CONTEXT_H__
24
25#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
26#error "Only <gtk/gtk.h> can be included directly."
27#endif
28
29#include <gtk/gtkcellarea.h>
30
31G_BEGIN_DECLS
32
33#define GTK_TYPE_CELL_AREA_CONTEXT (gtk_cell_area_context_get_type ())
34#define GTK_CELL_AREA_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CELL_AREA_CONTEXT, GtkCellAreaContext))
35#define GTK_CELL_AREA_CONTEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CELL_AREA_CONTEXT, GtkCellAreaContextClass))
36#define GTK_IS_CELL_AREA_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CELL_AREA_CONTEXT))
37#define GTK_IS_CELL_AREA_CONTEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CELL_AREA_CONTEXT))
38#define GTK_CELL_AREA_CONTEXT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CELL_AREA_CONTEXT, GtkCellAreaContextClass))
39
40typedef struct _GtkCellAreaContextPrivate GtkCellAreaContextPrivate;
41typedef struct _GtkCellAreaContextClass GtkCellAreaContextClass;
42
43struct _GtkCellAreaContext
44{
45 /*< private >*/
46 GObject parent_instance;
47
48 GtkCellAreaContextPrivate *priv;
49};
50
51/**
52 * GtkCellAreaContextClass:
53 * @allocate: This tells the context that an allocation width or height
54 * (or both) have been decided for a group of rows. The context should
55 * store any allocations for internally aligned cells at this point so
56 * that they dont need to be recalculated at gtk_cell_area_render() time.
57 * @reset: Clear any previously stored information about requested and
58 * allocated sizes for the context.
59 * @get_preferred_height_for_width: Returns the aligned height for the given
60 * width that context must store while collecting sizes for it’s rows.
61 * @get_preferred_width_for_height: Returns the aligned width for the given
62 * height that context must store while collecting sizes for it’s rows.
63 */
64struct _GtkCellAreaContextClass
65{
66 /*< private >*/
67 GObjectClass parent_class;
68
69 /*< public >*/
70 void (* allocate) (GtkCellAreaContext *context,
71 gint width,
72 gint height);
73 void (* reset) (GtkCellAreaContext *context);
74 void (* get_preferred_height_for_width) (GtkCellAreaContext *context,
75 gint width,
76 gint *minimum_height,
77 gint *natural_height);
78 void (* get_preferred_width_for_height) (GtkCellAreaContext *context,
79 gint height,
80 gint *minimum_width,
81 gint *natural_width);
82
83 /*< private >*/
84 /* Padding for future expansion */
85 void (*_gtk_reserved1) (void);
86 void (*_gtk_reserved2) (void);
87 void (*_gtk_reserved3) (void);
88 void (*_gtk_reserved4) (void);
89 void (*_gtk_reserved5) (void);
90 void (*_gtk_reserved6) (void);
91};
92
93GDK_AVAILABLE_IN_ALL
94GType gtk_cell_area_context_get_type (void) G_GNUC_CONST;
95
96/* Main apis */
97GDK_AVAILABLE_IN_ALL
98GtkCellArea *gtk_cell_area_context_get_area (GtkCellAreaContext *context);
99GDK_AVAILABLE_IN_ALL
100void gtk_cell_area_context_allocate (GtkCellAreaContext *context,
101 gint width,
102 gint height);
103GDK_AVAILABLE_IN_ALL
104void gtk_cell_area_context_reset (GtkCellAreaContext *context);
105
106/* Apis for GtkCellArea clients to consult cached values
107 * for a series of GtkTreeModel rows
108 */
109GDK_AVAILABLE_IN_ALL
110void gtk_cell_area_context_get_preferred_width (GtkCellAreaContext *context,
111 gint *minimum_width,
112 gint *natural_width);
113GDK_AVAILABLE_IN_ALL
114void gtk_cell_area_context_get_preferred_height (GtkCellAreaContext *context,
115 gint *minimum_height,
116 gint *natural_height);
117GDK_AVAILABLE_IN_ALL
118void gtk_cell_area_context_get_preferred_height_for_width (GtkCellAreaContext *context,
119 gint width,
120 gint *minimum_height,
121 gint *natural_height);
122GDK_AVAILABLE_IN_ALL
123void gtk_cell_area_context_get_preferred_width_for_height (GtkCellAreaContext *context,
124 gint height,
125 gint *minimum_width,
126 gint *natural_width);
127GDK_AVAILABLE_IN_ALL
128void gtk_cell_area_context_get_allocation (GtkCellAreaContext *context,
129 gint *width,
130 gint *height);
131
132/* Apis for GtkCellArea implementations to update cached values
133 * for multiple GtkTreeModel rows
134 */
135GDK_AVAILABLE_IN_ALL
136void gtk_cell_area_context_push_preferred_width (GtkCellAreaContext *context,
137 gint minimum_width,
138 gint natural_width);
139GDK_AVAILABLE_IN_ALL
140void gtk_cell_area_context_push_preferred_height (GtkCellAreaContext *context,
141 gint minimum_height,
142 gint natural_height);
143
144G_END_DECLS
145
146#endif /* __GTK_CELL_AREA_CONTEXT_H__ */
147