1/*
2 * Copyright © 2018 Benjamin Otte
3 *
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.
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 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 *
17 * Authors: Benjamin Otte <otte@gnome.org>
18 */
19
20#ifndef __GTK_MAP_LIST_MODEL_H__
21#define __GTK_MAP_LIST_MODEL_H__
22
23
24#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
25#error "Only <gtk/gtk.h> can be included directly."
26#endif
27
28#include <gio/gio.h>
29#include <gtk/gtkwidget.h>
30
31
32G_BEGIN_DECLS
33
34#define GTK_TYPE_MAP_LIST_MODEL (gtk_map_list_model_get_type ())
35
36GDK_AVAILABLE_IN_ALL
37G_DECLARE_FINAL_TYPE (GtkMapListModel, gtk_map_list_model, GTK, MAP_LIST_MODEL, GObject)
38
39/**
40 * GtkMapListModelMapFunc:
41 * @item: (type GObject) (transfer full): The item to map
42 * @user_data: user data
43 *
44 * User function that is called to map an @item of the original model to
45 * an item expected by the map model.
46 *
47 * The returned items must conform to the item type of the model they are
48 * used with.
49 *
50 * Returns: (type GObject) (transfer full): The item to map to
51 */
52typedef gpointer (* GtkMapListModelMapFunc) (gpointer item, gpointer user_data);
53
54GDK_AVAILABLE_IN_ALL
55GtkMapListModel * gtk_map_list_model_new (GListModel *model,
56 GtkMapListModelMapFunc map_func,
57 gpointer user_data,
58 GDestroyNotify user_destroy);
59
60GDK_AVAILABLE_IN_ALL
61void gtk_map_list_model_set_map_func (GtkMapListModel *self,
62 GtkMapListModelMapFunc map_func,
63 gpointer user_data,
64 GDestroyNotify user_destroy);
65GDK_AVAILABLE_IN_ALL
66void gtk_map_list_model_set_model (GtkMapListModel *self,
67 GListModel *model);
68GDK_AVAILABLE_IN_ALL
69GListModel * gtk_map_list_model_get_model (GtkMapListModel *self);
70GDK_AVAILABLE_IN_ALL
71gboolean gtk_map_list_model_has_map (GtkMapListModel *self);
72
73G_END_DECLS
74
75#endif /* __GTK_MAP_LIST_MODEL_H__ */
76

source code of gtk/gtk/gtkmaplistmodel.h