1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/*
* Copyright © 2019 Benjamin Otte
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Authors: Benjamin Otte <otte@gnome.org>
*/
#pragma once
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#include <gdk/gdk.h>
G_BEGIN_DECLS
/**
* GtkFilterMatch:
* @GTK_FILTER_MATCH_SOME: The filter matches some items,
* [method@Gtk.Filter.match] may return true or false
* @GTK_FILTER_MATCH_NONE: The filter does not match any item,
* [method@Gtk.Filter.match] will always return false
* @GTK_FILTER_MATCH_ALL: The filter matches all items,
* [method@Gtk.Filter.match] will alays return true
*
* Describes the known strictness of a filter.
*
* Note that for filters where the strictness is not known,
* `GTK_FILTER_MATCH_SOME` is always an acceptable value,
* even if a filter does match all or no items.
*/
typedef enum {
GTK_FILTER_MATCH_SOME = 0,
GTK_FILTER_MATCH_NONE,
GTK_FILTER_MATCH_ALL
} GtkFilterMatch;
/**
* GtkFilterChange:
* @GTK_FILTER_CHANGE_DIFFERENT: The filter change cannot be
* described with any of the other enumeration values
* @GTK_FILTER_CHANGE_LESS_STRICT: The filter is less strict than
* it was before: All items that it used to return true
* still return true, others now may, too.
* @GTK_FILTER_CHANGE_MORE_STRICT: The filter is more strict than
* it was before: All items that it used to return false
* still return false, others now may, too.
*
* Describes changes in a filter in more detail and allows objects
* using the filter to optimize refiltering items.
*
* If you are writing an implementation and are not sure which
* value to pass, `GTK_FILTER_CHANGE_DIFFERENT` is always a correct
* choice.
*
* New values may be added in the future.
*/
/**
* GTK_FILTER_CHANGE_DIFFERENT_REWATCH:
*
* Similar to [enum@Gtk.FilterChange.DIFFERENT],
* but signs that item watches should be recreated. This is used by
* [class@Gtk.FilterListModel] to keep the list up-to-date when items
* change.
*
* Since: 4.20
*/
/**
* GTK_FILTER_CHANGE_LESS_STRICT_REWATCH:
*
* Similar to [enum@Gtk.FilterChange.LESS_STRICT],
* but signs that item watches should be recreated. This is used by
* [class@Gtk.FilterListModel] to keep the list up-to-date when items
* change.
*
* Since: 4.20
*/
/**
* GTK_FILTER_CHANGE_MORE_STRICT_REWATCH:
* Similar to [enum@Gtk.FilterChange.MORE_STRICT],
* but signs that item watches should be recreated. This is used by
* [class@Gtk.FilterListModel] to keep the list up-to-date when items
* change.
*
* Since: 4.20
*/
typedef enum {
GTK_FILTER_CHANGE_DIFFERENT = 0,
GTK_FILTER_CHANGE_LESS_STRICT,
GTK_FILTER_CHANGE_MORE_STRICT,
GTK_FILTER_CHANGE_DIFFERENT_REWATCH,
GTK_FILTER_CHANGE_LESS_STRICT_REWATCH,
GTK_FILTER_CHANGE_MORE_STRICT_REWATCH,
} GtkFilterChange;
#define GTK_TYPE_FILTER (gtk_filter_get_type ())
GDK_AVAILABLE_IN_ALL
G_DECLARE_DERIVABLE_TYPE (GtkFilter, gtk_filter, GTK, FILTER, GObject)
struct _GtkFilterClass
{
GObjectClass parent_class;
gboolean (* match) (GtkFilter *self,
gpointer item);
/* optional */
GtkFilterMatch (* get_strictness) (GtkFilter *self);
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
void (*_gtk_reserved3) (void);
void (*_gtk_reserved4) (void);
void (*_gtk_reserved5) (void);
void (*_gtk_reserved6) (void);
void (*_gtk_reserved7) (void);
void (*_gtk_reserved8) (void);
};
GDK_AVAILABLE_IN_ALL
gboolean gtk_filter_match (GtkFilter *self,
gpointer item);
GDK_AVAILABLE_IN_ALL
GtkFilterMatch gtk_filter_get_strictness (GtkFilter *self);
/* for filter implementations */
GDK_AVAILABLE_IN_ALL
void gtk_filter_changed (GtkFilter *self,
GtkFilterChange change);
G_END_DECLS
|
