Merge branch '896-variant-type-docs' into 'master'
[glib.git] / gio / glistmodel.h
blob48348afd54e7e70a6b76b4b9164c761190094919
1 /*
2 * Copyright 2015 Lars Uebernickel
3 * Copyright 2015 Ryan Lortie
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
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 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 * Authors:
19 * Lars Uebernickel <lars@uebernic.de>
20 * Ryan Lortie <desrt@desrt.ca>
23 #ifndef __G_LIST_MODEL_H__
24 #define __G_LIST_MODEL_H__
26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27 #error "Only <gio/gio.h> can be included directly."
28 #endif
30 #include <gio/giotypes.h>
32 G_BEGIN_DECLS
34 #define G_TYPE_LIST_MODEL g_list_model_get_type ()
35 GLIB_AVAILABLE_IN_2_44
36 G_DECLARE_INTERFACE(GListModel, g_list_model, G, LIST_MODEL, GObject)
38 struct _GListModelInterface
40 GTypeInterface g_iface;
42 GType (* get_item_type) (GListModel *list);
44 guint (* get_n_items) (GListModel *list);
46 gpointer (* get_item) (GListModel *list,
47 guint position);
50 GLIB_AVAILABLE_IN_2_44
51 GType g_list_model_get_item_type (GListModel *list);
53 GLIB_AVAILABLE_IN_2_44
54 guint g_list_model_get_n_items (GListModel *list);
56 GLIB_AVAILABLE_IN_2_44
57 gpointer g_list_model_get_item (GListModel *list,
58 guint position);
60 GLIB_AVAILABLE_IN_2_44
61 GObject * g_list_model_get_object (GListModel *list,
62 guint position);
64 GLIB_AVAILABLE_IN_2_44
65 void g_list_model_items_changed (GListModel *list,
66 guint position,
67 guint removed,
68 guint added);
70 G_END_DECLS
72 #endif /* __G_LIST_MODEL_H__ */