Convert comments in .h files to Doxygen style comments
[geeqie.git] / src / pan-view / pan-view-filter.h
1 /*
2  * Copyright (C) 2006 John Ellis
3  * Copyright (C) 2008 - 2016 The Geeqie Team
4  *
5  * Author: John Ellis
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 2 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 along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21
22 #ifndef PAN_VIEW_PAN_VIEW_FILTER_H
23 #define PAN_VIEW_PAN_VIEW_FILTER_H
24
25 #include "main.h"
26 #include "pan-types.h"
27
28 typedef enum {
29         PAN_VIEW_FILTER_REQUIRE,
30         PAN_VIEW_FILTER_EXCLUDE,
31         PAN_VIEW_FILTER_INCLUDE,
32         PAN_VIEW_FILTER_GROUP
33 } PanViewFilterMode;
34
35 typedef struct _PanViewFilterElement PanViewFilterElement;
36 struct _PanViewFilterElement
37 {
38         PanViewFilterMode mode;
39         gchar *keyword;
40         GRegex *kw_regex;
41 };
42
43 typedef struct _PanFilterCallbackState PanFilterCallbackState;
44 struct _PanFilterCallbackState
45 {
46         PanWindow *pw;
47         GList *filter_element;
48 };
49
50 struct _PanViewFilterUi
51 {
52         GtkWidget *filter_box;
53         GtkWidget *filter_entry;
54         GtkWidget *filter_label;
55         GtkWidget *filter_button;
56         GtkWidget *filter_button_arrow;
57         GtkWidget *filter_kw_hbox;
58         GtkWidget *filter_check_buttons[FILE_FORMAT_CLASSES];
59         GtkListStore *filter_mode_model;
60         GtkWidget *filter_mode_combo;
61         GList *filter_elements;  /**< List of #PanViewFilterElement. */
62         gint filter_classes;
63 };
64
65 void pan_filter_toggle_visible(PanWindow *pw, gboolean enable);
66 void pan_filter_activate(PanWindow *pw);
67 void pan_filter_activate_cb(const gchar *text, gpointer data);
68 void pan_filter_toggle_cb(GtkWidget *button, gpointer data);
69 void pan_filter_toggle_button_cb(GtkWidget *button, gpointer data);
70
71 /**
72  * \headerfile pan_filter_ui_new
73  * Creates a new #PanViewFilterUi instance and returns it.
74  */
75 PanViewFilterUi *pan_filter_ui_new(PanWindow *pw);
76
77 /**
78  * \headerfile pan_filter_ui_destroy
79  * Destroys the specified #PanViewFilterUi and sets the pointer to NULL.
80  */
81 void pan_filter_ui_destroy(PanViewFilterUi **ui);
82
83 gboolean pan_filter_fd_list(GList **fd_list, GList *filter_elements, gint filter_classes);
84
85 #endif
86 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */