glib-2.0/gio/gliststore.h

0001 /*
0002  * Copyright 2015 Lars Uebernickel
0003  * Copyright 2015 Ryan Lortie
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Authors:
0021  *     Lars Uebernickel <lars@uebernic.de>
0022  *     Ryan Lortie <desrt@desrt.ca>
0023  */
0024
0025 #ifndef __G_LIST_STORE_H__
0026 #define __G_LIST_STORE_H__
0027
0028 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0029 #error "Only <gio/gio.h> can be included directly."
0030 #endif
0031
0032 #include <gio/giotypes.h>
0033
0034 G_BEGIN_DECLS
0035
0036 #define G_TYPE_LIST_STORE (g_list_store_get_type ())
0037 GIO_AVAILABLE_IN_2_44
0038 G_DECLARE_FINAL_TYPE(GListStore, g_list_store, G, LIST_STORE, GObject)
0039
0040 GIO_AVAILABLE_IN_2_44
0041 GListStore *            g_list_store_new                                (GType       item_type);
0042
0043 GIO_AVAILABLE_IN_2_44
0044 void                    g_list_store_insert                             (GListStore *store,
0045                                                                          guint       position,
0046                                                                          gpointer    item);
0047
0048 GIO_AVAILABLE_IN_2_44
0049 guint                   g_list_store_insert_sorted                      (GListStore       *store,
0050                                                                          gpointer          item,
0051                                                                          GCompareDataFunc  compare_func,
0052                                                                          gpointer          user_data);
0053
0054 GIO_AVAILABLE_IN_2_46
0055 void                   g_list_store_sort                                (GListStore       *store,
0056                                                                          GCompareDataFunc  compare_func,
0057                                                                          gpointer          user_data);
0058
0059 GIO_AVAILABLE_IN_2_44
0060 void                    g_list_store_append                             (GListStore *store,
0061                                                                          gpointer    item);
0062
0063 GIO_AVAILABLE_IN_2_44
0064 void                    g_list_store_remove                             (GListStore *store,
0065                                                                          guint       position);
0066
0067 GIO_AVAILABLE_IN_2_44
0068 void                    g_list_store_remove_all                         (GListStore *store);
0069
0070 GIO_AVAILABLE_IN_2_44
0071 void                    g_list_store_splice                             (GListStore *store,
0072                                                                          guint       position,
0073                                                                          guint       n_removals,
0074                                                                          gpointer   *additions,
0075                                                                          guint       n_additions);
0076
0077 GIO_AVAILABLE_IN_2_64
0078 gboolean                g_list_store_find                               (GListStore *store,
0079                                                                          gpointer    item,
0080                                                                          guint      *position);
0081
0082 GIO_AVAILABLE_IN_2_64
0083 gboolean                g_list_store_find_with_equal_func               (GListStore *store,
0084                                                                          gpointer    item,
0085                                                                          GEqualFunc  equal_func,
0086                                                                          guint      *position);
0087
0088 GIO_AVAILABLE_IN_2_74
0089 gboolean                g_list_store_find_with_equal_func_full          (GListStore     *store,
0090                                                                          gpointer        item,
0091                                                                          GEqualFuncFull  equal_func,
0092                                                                          gpointer        user_data,
0093                                                                          guint          *position);
0094
0095 G_END_DECLS
0096
0097 #endif /* __G_LIST_STORE_H__ */