1/*
2 * Copyright (C) 2010 Openismus GmbH
3 * Copyright (C) 2013 Red Hat, Inc.
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
14 *
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
17
18 *
19 * Authors:
20 * Tristan Van Berkom <tristanvb@openismus.com>
21 * Matthias Clasen <mclasen@redhat.com>
22 * William Jon McCann <jmccann@redhat.com>
23 */
24
25#ifndef __GTK_FLOW_BOX_H__
26#define __GTK_FLOW_BOX_H__
27
28#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
29#error "Only <gtk/gtk.h> can be included directly."
30#endif
31
32#include <gtk/gtkwidget.h>
33
34G_BEGIN_DECLS
35
36
37#define GTK_TYPE_FLOW_BOX (gtk_flow_box_get_type ())
38#define GTK_FLOW_BOX(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FLOW_BOX, GtkFlowBox))
39#define GTK_IS_FLOW_BOX(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FLOW_BOX))
40
41typedef struct _GtkFlowBox GtkFlowBox;
42typedef struct _GtkFlowBoxChild GtkFlowBoxChild;
43typedef struct _GtkFlowBoxChildClass GtkFlowBoxChildClass;
44
45#define GTK_TYPE_FLOW_BOX_CHILD (gtk_flow_box_child_get_type ())
46#define GTK_FLOW_BOX_CHILD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FLOW_BOX_CHILD, GtkFlowBoxChild))
47#define GTK_FLOW_BOX_CHILD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FLOW_BOX_CHILD, GtkFlowBoxChildClass))
48#define GTK_IS_FLOW_BOX_CHILD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FLOW_BOX_CHILD))
49#define GTK_IS_FLOW_BOX_CHILD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FLOW_BOX_CHILD))
50#define GTK_FLOW_BOX_CHILD_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), EG_TYPE_FLOW_BOX_CHILD, GtkFlowBoxChildClass))
51
52struct _GtkFlowBoxChild
53{
54 /*< private >*/
55 GtkWidget parent_instance;
56};
57
58struct _GtkFlowBoxChildClass
59{
60 /*< private >*/
61 GtkWidgetClass parent_class;
62
63 /*< public >*/
64 void (* activate) (GtkFlowBoxChild *child);
65
66 /*< private >*/
67 gpointer padding[8];
68};
69
70/**
71 * GtkFlowBoxCreateWidgetFunc:
72 * @item: (type GObject): the item from the model for which to create a widget for
73 * @user_data: (closure): user data from gtk_flow_box_bind_model()
74 *
75 * Called for flow boxes that are bound to a `GListModel`.
76 *
77 * This function is called for each item that gets added to the model.
78 *
79 * Returns: (transfer full): a `GtkWidget` that represents @item
80 */
81typedef GtkWidget * (*GtkFlowBoxCreateWidgetFunc) (gpointer item,
82 gpointer user_data);
83
84GDK_AVAILABLE_IN_ALL
85GType gtk_flow_box_child_get_type (void) G_GNUC_CONST;
86GDK_AVAILABLE_IN_ALL
87GtkWidget* gtk_flow_box_child_new (void);
88
89GDK_AVAILABLE_IN_ALL
90void gtk_flow_box_child_set_child (GtkFlowBoxChild *self,
91 GtkWidget *child);
92GDK_AVAILABLE_IN_ALL
93GtkWidget * gtk_flow_box_child_get_child (GtkFlowBoxChild *self);
94
95GDK_AVAILABLE_IN_ALL
96int gtk_flow_box_child_get_index (GtkFlowBoxChild *child);
97GDK_AVAILABLE_IN_ALL
98gboolean gtk_flow_box_child_is_selected (GtkFlowBoxChild *child);
99GDK_AVAILABLE_IN_ALL
100void gtk_flow_box_child_changed (GtkFlowBoxChild *child);
101
102
103GDK_AVAILABLE_IN_ALL
104GType gtk_flow_box_get_type (void) G_GNUC_CONST;
105
106GDK_AVAILABLE_IN_ALL
107GtkWidget *gtk_flow_box_new (void);
108
109GDK_AVAILABLE_IN_ALL
110void gtk_flow_box_bind_model (GtkFlowBox *box,
111 GListModel *model,
112 GtkFlowBoxCreateWidgetFunc create_widget_func,
113 gpointer user_data,
114 GDestroyNotify user_data_free_func);
115
116GDK_AVAILABLE_IN_ALL
117void gtk_flow_box_set_homogeneous (GtkFlowBox *box,
118 gboolean homogeneous);
119GDK_AVAILABLE_IN_ALL
120gboolean gtk_flow_box_get_homogeneous (GtkFlowBox *box);
121GDK_AVAILABLE_IN_ALL
122void gtk_flow_box_set_row_spacing (GtkFlowBox *box,
123 guint spacing);
124GDK_AVAILABLE_IN_ALL
125guint gtk_flow_box_get_row_spacing (GtkFlowBox *box);
126
127GDK_AVAILABLE_IN_ALL
128void gtk_flow_box_set_column_spacing (GtkFlowBox *box,
129 guint spacing);
130GDK_AVAILABLE_IN_ALL
131guint gtk_flow_box_get_column_spacing (GtkFlowBox *box);
132
133GDK_AVAILABLE_IN_ALL
134void gtk_flow_box_set_min_children_per_line (GtkFlowBox *box,
135 guint n_children);
136GDK_AVAILABLE_IN_ALL
137guint gtk_flow_box_get_min_children_per_line (GtkFlowBox *box);
138
139GDK_AVAILABLE_IN_ALL
140void gtk_flow_box_set_max_children_per_line (GtkFlowBox *box,
141 guint n_children);
142GDK_AVAILABLE_IN_ALL
143guint gtk_flow_box_get_max_children_per_line (GtkFlowBox *box);
144GDK_AVAILABLE_IN_ALL
145void gtk_flow_box_set_activate_on_single_click (GtkFlowBox *box,
146 gboolean single);
147GDK_AVAILABLE_IN_ALL
148gboolean gtk_flow_box_get_activate_on_single_click (GtkFlowBox *box);
149
150GDK_AVAILABLE_IN_4_6
151void gtk_flow_box_prepend (GtkFlowBox *self,
152 GtkWidget *child);
153GDK_AVAILABLE_IN_4_6
154void gtk_flow_box_append (GtkFlowBox *self,
155 GtkWidget *child);
156GDK_AVAILABLE_IN_ALL
157void gtk_flow_box_insert (GtkFlowBox *box,
158 GtkWidget *widget,
159 int position);
160GDK_AVAILABLE_IN_ALL
161void gtk_flow_box_remove (GtkFlowBox *box,
162 GtkWidget *widget);
163GDK_AVAILABLE_IN_ALL
164GtkFlowBoxChild *gtk_flow_box_get_child_at_index (GtkFlowBox *box,
165 int idx);
166
167GDK_AVAILABLE_IN_ALL
168GtkFlowBoxChild *gtk_flow_box_get_child_at_pos (GtkFlowBox *box,
169 int x,
170 int y);
171
172typedef void (* GtkFlowBoxForeachFunc) (GtkFlowBox *box,
173 GtkFlowBoxChild *child,
174 gpointer user_data);
175
176GDK_AVAILABLE_IN_ALL
177void gtk_flow_box_selected_foreach (GtkFlowBox *box,
178 GtkFlowBoxForeachFunc func,
179 gpointer data);
180GDK_AVAILABLE_IN_ALL
181GList *gtk_flow_box_get_selected_children (GtkFlowBox *box);
182GDK_AVAILABLE_IN_ALL
183void gtk_flow_box_select_child (GtkFlowBox *box,
184 GtkFlowBoxChild *child);
185GDK_AVAILABLE_IN_ALL
186void gtk_flow_box_unselect_child (GtkFlowBox *box,
187 GtkFlowBoxChild *child);
188GDK_AVAILABLE_IN_ALL
189void gtk_flow_box_select_all (GtkFlowBox *box);
190GDK_AVAILABLE_IN_ALL
191void gtk_flow_box_unselect_all (GtkFlowBox *box);
192GDK_AVAILABLE_IN_ALL
193void gtk_flow_box_set_selection_mode (GtkFlowBox *box,
194 GtkSelectionMode mode);
195GDK_AVAILABLE_IN_ALL
196GtkSelectionMode gtk_flow_box_get_selection_mode (GtkFlowBox *box);
197GDK_AVAILABLE_IN_ALL
198void gtk_flow_box_set_hadjustment (GtkFlowBox *box,
199 GtkAdjustment *adjustment);
200GDK_AVAILABLE_IN_ALL
201void gtk_flow_box_set_vadjustment (GtkFlowBox *box,
202 GtkAdjustment *adjustment);
203
204typedef gboolean (*GtkFlowBoxFilterFunc) (GtkFlowBoxChild *child,
205 gpointer user_data);
206
207GDK_AVAILABLE_IN_ALL
208void gtk_flow_box_set_filter_func (GtkFlowBox *box,
209 GtkFlowBoxFilterFunc filter_func,
210 gpointer user_data,
211 GDestroyNotify destroy);
212GDK_AVAILABLE_IN_ALL
213void gtk_flow_box_invalidate_filter (GtkFlowBox *box);
214
215typedef int (*GtkFlowBoxSortFunc) (GtkFlowBoxChild *child1,
216 GtkFlowBoxChild *child2,
217 gpointer user_data);
218
219GDK_AVAILABLE_IN_ALL
220void gtk_flow_box_set_sort_func (GtkFlowBox *box,
221 GtkFlowBoxSortFunc sort_func,
222 gpointer user_data,
223 GDestroyNotify destroy);
224GDK_AVAILABLE_IN_ALL
225void gtk_flow_box_invalidate_sort (GtkFlowBox *box);
226
227G_END_DECLS
228
229
230#endif /* __GTK_FLOW_BOX_H__ */
231

source code of gtk/gtk/gtkflowbox.h