1 /* GIMP - The GNU Image Manipulation Program
2  * Copyright (C) 1995-1997 Spencer Kimball and Peter Mattis
3  *
4  * gimplist.h
5  * Copyright (C) 2001-2016 Michael Natterer <mitch@gimp.org>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef __GIMP_LIST_H__
22 #define __GIMP_LIST_H__
23 
24 
25 #include "gimpcontainer.h"
26 
27 
28 #define GIMP_TYPE_LIST            (gimp_list_get_type ())
29 #define GIMP_LIST(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_LIST, GimpList))
30 #define GIMP_LIST_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_LIST, GimpListClass))
31 #define GIMP_IS_LIST(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_LIST))
32 #define GIMP_IS_LIST_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_LIST))
33 #define GIMP_LIST_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_LIST, GimpListClass))
34 
35 
36 typedef struct _GimpListClass GimpListClass;
37 
38 struct _GimpList
39 {
40   GimpContainer  parent_instance;
41 
42   GQueue        *queue;
43   gboolean       unique_names;
44   GCompareFunc   sort_func;
45   gboolean       append;
46 };
47 
48 struct _GimpListClass
49 {
50   GimpContainerClass  parent_class;
51 };
52 
53 
54 GType           gimp_list_get_type      (void) G_GNUC_CONST;
55 
56 GimpContainer * gimp_list_new           (GType         children_type,
57                                          gboolean      unique_names);
58 GimpContainer * gimp_list_new_weak      (GType         children_type,
59                                          gboolean      unique_names);
60 
61 void            gimp_list_reverse       (GimpList     *list);
62 void            gimp_list_set_sort_func (GimpList     *list,
63                                          GCompareFunc  sort_func);
64 GCompareFunc    gimp_list_get_sort_func (GimpList     *list);
65 void            gimp_list_sort          (GimpList     *list,
66                                          GCompareFunc  sort_func);
67 void            gimp_list_sort_by_name  (GimpList     *list);
68 
69 
70 #endif  /* __GIMP_LIST_H__ */
71