gtkcelllayout.h 8.16 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/* gtkcelllayout.h
 * Copyright (C) 2003  Kristian Rietveld  <kris@gtk.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16
17
 */

18
19
20
#ifndef __GTK_CELL_LAYOUT_H__
#define __GTK_CELL_LAYOUT_H__

21
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
22
23
24
#error "Only <gtk/gtk.h> can be included directly."
#endif

25
#include <gtk/gtkcellrenderer.h>
26
#include <gtk/gtkcellarea.h>
Johan Dahlin's avatar
Johan Dahlin committed
27
28
#include <gtk/gtkbuildable.h>
#include <gtk/gtkbuilder.h>
29
30
31
32
33
34
35
36
37
38
39
40

G_BEGIN_DECLS

#define GTK_TYPE_CELL_LAYOUT            (gtk_cell_layout_get_type ())
#define GTK_CELL_LAYOUT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CELL_LAYOUT, GtkCellLayout))
#define GTK_IS_CELL_LAYOUT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CELL_LAYOUT))
#define GTK_CELL_LAYOUT_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_CELL_LAYOUT, GtkCellLayoutIface))

typedef struct _GtkCellLayout           GtkCellLayout; /* dummy typedef */
typedef struct _GtkCellLayoutIface      GtkCellLayoutIface;

/* keep in sync with GtkTreeCellDataFunc */
41
42
/**
 * GtkCellLayoutDataFunc:
Matthias Clasen's avatar
Matthias Clasen committed
43
 * @cell_layout: a `GtkCellLayout`
44
45
 * @cell: the cell renderer whose value is to be set
 * @tree_model: the model
Matthias Clasen's avatar
Matthias Clasen committed
46
 * @iter: a `GtkTreeIter` indicating the row to set the value for
47
 * @data: (closure): user data passed to gtk_cell_layout_set_cell_data_func()
48
 *
49
 * A function which should set the value of @cell_layout’s cell renderer(s)
50
51
 * as appropriate. 
 */
52
53
54
55
56
57
typedef void (* GtkCellLayoutDataFunc) (GtkCellLayout   *cell_layout,
                                        GtkCellRenderer *cell,
                                        GtkTreeModel    *tree_model,
                                        GtkTreeIter     *iter,
                                        gpointer         data);

58
59
60
61
62
63
64
65
/**
 * GtkCellLayoutIface:
 * @pack_start: Packs the cell into the beginning of cell_layout.
 * @pack_end: Adds the cell to the end of cell_layout.
 * @clear: Unsets all the mappings on all renderers on cell_layout and
 *    removes all renderers from cell_layout.
 * @add_attribute: Adds an attribute mapping to the list in
 *    cell_layout.
Matthias Clasen's avatar
Matthias Clasen committed
66
 * @set_cell_data_func: Sets the `GtkCellLayout`DataFunc to use for
67
68
69
70
71
72
 *    cell_layout.
 * @clear_attributes: Clears all existing attributes previously set
 *    with gtk_cell_layout_set_attributes().
 * @reorder: Re-inserts cell at position.
 * @get_cells: Get the cell renderers which have been added to
 *    cell_layout.
Matthias Clasen's avatar
Matthias Clasen committed
73
74
75
 * @get_area: Get the underlying `GtkCellArea` which might be
 *    cell_layout if called on a `GtkCellArea` or might be NULL if no
 *    `GtkCellArea` is used by cell_layout.
76
 */
77
78
struct _GtkCellLayoutIface
{
79
  /*< private >*/
80
81
  GTypeInterface g_iface;

82
83
  /*< public >*/

84
85
86
87
88
89
90
91
92
93
  /* Virtual Table */
  void (* pack_start)         (GtkCellLayout         *cell_layout,
                               GtkCellRenderer       *cell,
                               gboolean               expand);
  void (* pack_end)           (GtkCellLayout         *cell_layout,
                               GtkCellRenderer       *cell,
                               gboolean               expand);
  void (* clear)              (GtkCellLayout         *cell_layout);
  void (* add_attribute)      (GtkCellLayout         *cell_layout,
                               GtkCellRenderer       *cell,
Benjamin Otte's avatar
Benjamin Otte committed
94
                               const char            *attribute,
Benjamin Otte's avatar
Benjamin Otte committed
95
                               int                    column);
96
97
98
99
100
101
102
  void (* set_cell_data_func) (GtkCellLayout         *cell_layout,
                               GtkCellRenderer       *cell,
                               GtkCellLayoutDataFunc  func,
                               gpointer               func_data,
                               GDestroyNotify         destroy);
  void (* clear_attributes)   (GtkCellLayout         *cell_layout,
                               GtkCellRenderer       *cell);
Kristian Rietveld's avatar
Kristian Rietveld committed
103
104
  void (* reorder)            (GtkCellLayout         *cell_layout,
                               GtkCellRenderer       *cell,
Benjamin Otte's avatar
Benjamin Otte committed
105
                               int                    position);
106
  GList* (* get_cells)        (GtkCellLayout         *cell_layout);
107
108

  GtkCellArea *(* get_area)   (GtkCellLayout         *cell_layout);
109
110
};

111
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
112
GType gtk_cell_layout_get_type           (void) G_GNUC_CONST;
113
GDK_AVAILABLE_IN_ALL
114
115
116
void  gtk_cell_layout_pack_start         (GtkCellLayout         *cell_layout,
                                          GtkCellRenderer       *cell,
                                          gboolean               expand);
117
GDK_AVAILABLE_IN_ALL
118
119
120
void  gtk_cell_layout_pack_end           (GtkCellLayout         *cell_layout,
                                          GtkCellRenderer       *cell,
                                          gboolean               expand);
121
GDK_AVAILABLE_IN_ALL
122
GList *gtk_cell_layout_get_cells         (GtkCellLayout         *cell_layout);
123
GDK_AVAILABLE_IN_ALL
124
void  gtk_cell_layout_clear              (GtkCellLayout         *cell_layout);
125
GDK_AVAILABLE_IN_ALL
126
127
void  gtk_cell_layout_set_attributes     (GtkCellLayout         *cell_layout,
                                          GtkCellRenderer       *cell,
128
                                          ...) G_GNUC_NULL_TERMINATED;
129
GDK_AVAILABLE_IN_ALL
130
131
void  gtk_cell_layout_add_attribute      (GtkCellLayout         *cell_layout,
                                          GtkCellRenderer       *cell,
Benjamin Otte's avatar
Benjamin Otte committed
132
                                          const char            *attribute,
Benjamin Otte's avatar
Benjamin Otte committed
133
                                          int                    column);
134
GDK_AVAILABLE_IN_ALL
135
136
137
138
139
void  gtk_cell_layout_set_cell_data_func (GtkCellLayout         *cell_layout,
                                          GtkCellRenderer       *cell,
                                          GtkCellLayoutDataFunc  func,
                                          gpointer               func_data,
                                          GDestroyNotify         destroy);
140
GDK_AVAILABLE_IN_ALL
141
142
void  gtk_cell_layout_clear_attributes   (GtkCellLayout         *cell_layout,
                                          GtkCellRenderer       *cell);
143
GDK_AVAILABLE_IN_ALL
Kristian Rietveld's avatar
Kristian Rietveld committed
144
145
void  gtk_cell_layout_reorder            (GtkCellLayout         *cell_layout,
                                          GtkCellRenderer       *cell,
Benjamin Otte's avatar
Benjamin Otte committed
146
                                          int                    position);
147
GDK_AVAILABLE_IN_ALL
148
149
GtkCellArea *gtk_cell_layout_get_area    (GtkCellLayout         *cell_layout);

150
151
152
gboolean _gtk_cell_layout_buildable_custom_tag_start (GtkBuildable       *buildable,
                                                      GtkBuilder         *builder,
                                                      GObject            *child,
Benjamin Otte's avatar
Benjamin Otte committed
153
                                                      const char         *tagname,
154
155
156
157
158
                                                      GtkBuildableParser *parser,
                                                      gpointer           *data);
gboolean _gtk_cell_layout_buildable_custom_tag_end   (GtkBuildable       *buildable,
                                                      GtkBuilder         *builder,
                                                      GObject            *child,
Benjamin Otte's avatar
Benjamin Otte committed
159
                                                      const char         *tagname,
160
161
162
163
                                                      gpointer           *data);
void     _gtk_cell_layout_buildable_add_child        (GtkBuildable       *buildable,
                                                      GtkBuilder         *builder,
                                                      GObject            *child,
Benjamin Otte's avatar
Benjamin Otte committed
164
                                                      const char         *type);
165
166
167
168

G_END_DECLS

#endif /* __GTK_CELL_LAYOUT_H__ */