]> Pileus Git - ~andy/gtk/blob - gtk/gtkcellrenderer.h
This commit adds a cell_background property for cell renderers. With this
[~andy/gtk] / gtk / gtkcellrenderer.h
1 /* gtkcellrenderer.h
2  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 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  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 #ifndef __GTK_CELL_RENDERER_H__
21 #define __GTK_CELL_RENDERER_H__
22
23 #include <gtk/gtkobject.h>
24 #include <gtk/gtkwidget.h>
25 #include <gtk/gtkcelleditable.h>
26
27 G_BEGIN_DECLS
28
29 typedef enum
30 {
31   GTK_CELL_RENDERER_SELECTED    = 1 << 0,
32   GTK_CELL_RENDERER_PRELIT      = 1 << 1,
33   GTK_CELL_RENDERER_INSENSITIVE = 1 << 2,
34   /* this flag means the cell is in the sort column/row */
35   GTK_CELL_RENDERER_SORTED      = 1 << 3
36 } GtkCellRendererState;
37
38 typedef enum
39 {
40   GTK_CELL_RENDERER_MODE_INERT,
41   GTK_CELL_RENDERER_MODE_ACTIVATABLE,
42   GTK_CELL_RENDERER_MODE_EDITABLE
43 } GtkCellRendererMode;
44
45 #define GTK_TYPE_CELL_RENDERER            (gtk_cell_renderer_get_type ())
46 #define GTK_CELL_RENDERER(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_CELL_RENDERER, GtkCellRenderer))
47 #define GTK_CELL_RENDERER_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_CELL_RENDERER, GtkCellRendererClass))
48 #define GTK_IS_CELL_RENDERER(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_CELL_RENDERER))
49 #define GTK_IS_CELL_RENDERER_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CELL_RENDERER))
50 #define GTK_CELL_RENDERER_GET_CLASS(obj)  (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_CELL_RENDERER, GtkCellRendererClass))
51
52 typedef struct _GtkCellRenderer GtkCellRenderer;
53 typedef struct _GtkCellRendererClass GtkCellRendererClass;
54
55 struct _GtkCellRenderer
56 {
57   GtkObject parent;
58
59   gfloat xalign;
60   gfloat yalign;
61
62   gint width;
63   gint height;
64
65   guint16 xpad;
66   guint16 ypad;
67
68   guint mode : 2;
69   guint visible : 1;
70   guint is_expander : 1;
71   guint is_expanded : 1;
72
73   guint cell_background_set : 1;
74
75   GdkColor cell_background;
76 };
77
78 struct _GtkCellRendererClass
79 {
80   GtkObjectClass parent_class;
81
82   /* vtable - not signals */
83   void             (* get_size)      (GtkCellRenderer      *cell,
84                                       GtkWidget            *widget,
85                                       GdkRectangle         *cell_area,
86                                       gint                 *x_offset,
87                                       gint                 *y_offset,
88                                       gint                 *width,
89                                       gint                 *height);
90   void             (* render)        (GtkCellRenderer      *cell,
91                                       GdkWindow            *window,
92                                       GtkWidget            *widget,
93                                       GdkRectangle         *background_area,
94                                       GdkRectangle         *cell_area,
95                                       GdkRectangle         *expose_area,
96                                       GtkCellRendererState  flags);
97   gboolean         (* activate)      (GtkCellRenderer      *cell,
98                                       GdkEvent             *event,
99                                       GtkWidget            *widget,
100                                       const gchar          *path,
101                                       GdkRectangle         *background_area,
102                                       GdkRectangle         *cell_area,
103                                       GtkCellRendererState  flags);
104   GtkCellEditable *(* start_editing) (GtkCellRenderer      *cell,
105                                       GdkEvent             *event,
106                                       GtkWidget            *widget,
107                                       const gchar          *path,
108                                       GdkRectangle         *background_area,
109                                       GdkRectangle         *cell_area,
110                                       GtkCellRendererState  flags);
111
112   /* Padding for future expansion */
113   void (*_gtk_reserved1) (void);
114   void (*_gtk_reserved2) (void);
115   void (*_gtk_reserved3) (void);
116   void (*_gtk_reserved4) (void);
117 };
118
119 GType            gtk_cell_renderer_get_type       (void) G_GNUC_CONST;
120
121 void             gtk_cell_renderer_get_size       (GtkCellRenderer      *cell,
122                                                    GtkWidget            *widget,
123                                                    GdkRectangle         *cell_area,
124                                                    gint                 *x_offset,
125                                                    gint                 *y_offset,
126                                                    gint                 *width,
127                                                    gint                 *height);
128 void             gtk_cell_renderer_render         (GtkCellRenderer      *cell,
129                                                    GdkWindow            *window,
130                                                    GtkWidget            *widget,
131                                                    GdkRectangle         *background_area,
132                                                    GdkRectangle         *cell_area,
133                                                    GdkRectangle         *expose_area,
134                                                    GtkCellRendererState  flags);
135 gboolean         gtk_cell_renderer_activate       (GtkCellRenderer      *cell,
136                                                    GdkEvent             *event,
137                                                    GtkWidget            *widget,
138                                                    const gchar          *path,
139                                                    GdkRectangle         *background_area,
140                                                    GdkRectangle         *cell_area,
141                                                    GtkCellRendererState  flags);
142 GtkCellEditable *gtk_cell_renderer_start_editing  (GtkCellRenderer      *cell,
143                                                    GdkEvent             *event,
144                                                    GtkWidget            *widget,
145                                                    const gchar          *path,
146                                                    GdkRectangle         *background_area,
147                                                    GdkRectangle         *cell_area,
148                                                    GtkCellRendererState  flags);
149 void             gtk_cell_renderer_set_fixed_size (GtkCellRenderer      *cell,
150                                                    gint                  width,
151                                                    gint                  height);
152 void             gtk_cell_renderer_get_fixed_size (GtkCellRenderer      *cell,
153                                                    gint                 *width,
154                                                    gint                 *height);
155
156
157  
158 G_END_DECLS
159
160 #endif /* __GTK_CELL_RENDERER_H__ */