Cleanup main.h header
[geeqie.git] / src / view-file.h
1 /*
2  * Copyright (C) 2008 - 2016 The Geeqie Team
3  *
4  * Author: Laurent Monin
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19  */
20
21 #ifndef VIEW_FILE_H
22 #define VIEW_FILE_H
23
24 #include <gtk/gtk.h>
25
26 #include "typedefs.h"
27
28 struct FileData;
29 struct LayoutWindow;
30 struct ThumbLoader;
31
32 struct ViewFile
33 {
34         FileViewType type;      /**< @todo (xsdg): Turn this into a union (see VFLIST and VFICON). */
35
36         gpointer info;
37
38         GtkWidget *widget;
39         GtkWidget *listview;
40         GtkWidget *scrolled;
41         GtkWidget *filter;
42         GtkWidget *filter_check[FILEDATA_MARKS_SIZE];
43
44         struct {
45                 GtkWidget *combo;
46                 GtkWidget *frame;
47                 gint count;
48                 gint last_selected;
49                 gboolean case_sensitive;
50         } file_filter;
51
52         FileData *dir_fd;
53         GList *list;
54
55         SortType sort_method;
56         gboolean sort_ascend;
57         gboolean sort_case;
58
59         /* func list */
60         void (*func_thumb_status)(ViewFile *vf, gdouble val, const gchar *text, gpointer data);
61         gpointer data_thumb_status;
62
63         void (*func_status)(ViewFile *vf, gpointer data);
64         gpointer data_status;
65
66         LayoutWindow *layout;
67
68         GtkWidget *popup;
69
70         /* thumbs updates*/
71         gboolean thumbs_running;
72         ThumbLoader *thumbs_loader;
73         FileData *thumbs_filedata;
74
75         /* marks */
76         gboolean marks_enabled;
77         gint active_mark;
78         gint clicked_mark;
79
80         /* stars */
81         FileData *stars_filedata;
82         guint stars_id;
83
84         /* refresh */
85         guint refresh_idle_id; /**< event source id */
86         time_t time_refresh_set; /**< time when refresh_idle_id was set */
87
88         GList *editmenu_fd_list; /**< file list for edit menu */
89
90         guint read_metadata_in_idle_id;
91 };
92
93 struct ViewFileInfoList
94 {
95         FileData *click_fd;
96         FileData *select_fd;
97
98         gboolean thumbs_enabled;
99
100         guint select_idle_id; /**< event source id */
101 };
102
103 struct ViewFileInfoIcon
104 {
105         /* table stuff */
106         gint columns;
107         gint rows;
108
109         GList *selection;
110         FileData *prev_selection;
111
112         GtkWidget *tip_window;
113         guint tip_delay_id; /**< event source id */
114         FileData *tip_fd;
115
116         FileData *click_fd;
117
118         FileData *focus_fd;
119         gint focus_row;
120         gint focus_column;
121
122         gboolean show_text;
123 };
124
125 #define VFLIST(_vf_) ((ViewFileInfoList *)(_vf_->info))
126 #define VFICON(_vf_) ((ViewFileInfoIcon *)(_vf_->info))
127
128 void vf_send_update(ViewFile *vf);
129
130 ViewFile *vf_new(FileViewType type, FileData *dir_fd);
131
132 void vf_set_status_func(ViewFile *vf, void (*func)(ViewFile *vf, gpointer data), gpointer data);
133 void vf_set_thumb_status_func(ViewFile *vf, void (*func)(ViewFile *vf, gdouble val, const gchar *text, gpointer data), gpointer data);
134
135 void vf_set_layout(ViewFile *vf, LayoutWindow *layout);
136
137 gboolean vf_set_fd(ViewFile *vf, FileData *fd);
138 gboolean vf_refresh(ViewFile *vf);
139 void vf_refresh_idle(ViewFile *vf);
140
141 void vf_thumb_set(ViewFile *vf, gboolean enable);
142 void vf_marks_set(ViewFile *vf, gboolean enable);
143 void vf_star_rating_set(ViewFile *vf, gboolean enable);
144 void vf_sort_set(ViewFile *vf, SortType type, gboolean ascend, gboolean case_sensitive);
145
146 guint vf_marks_get_filter(ViewFile *vf);
147 void vf_mark_filter_toggle(ViewFile *vf, gint mark);
148
149 guint vf_class_get_filter(ViewFile *vf);
150
151 GList *vf_selection_get_one(ViewFile *vf, FileData *fd);
152 GList *vf_pop_menu_file_list(ViewFile *vf);
153 GtkWidget *vf_pop_menu(ViewFile *vf);
154
155 FileData *vf_index_get_data(ViewFile *vf, gint row);
156 gint vf_index_by_fd(ViewFile *vf, FileData *in_fd);
157 guint vf_count(ViewFile *vf, gint64 *bytes);
158 GList *vf_get_list(ViewFile *vf);
159
160 guint vf_selection_count(ViewFile *vf, gint64 *bytes);
161 GList *vf_selection_get_list(ViewFile *vf);
162 GList *vf_selection_get_list_by_index(ViewFile *vf);
163
164 void vf_select_all(ViewFile *vf);
165 void vf_select_none(ViewFile *vf);
166 void vf_select_invert(ViewFile *vf);
167 void vf_select_by_fd(ViewFile *vf, FileData *fd);
168 void vf_select_list(ViewFile *vf, GList *list);
169
170 void vf_mark_to_selection(ViewFile *vf, gint mark, MarkToSelectionMode mode);
171 void vf_selection_to_mark(ViewFile *vf, gint mark, SelectionToMarkMode mode);
172
173 void vf_refresh_idle_cancel(ViewFile *vf);
174 void vf_notify_cb(FileData *fd, NotifyType type, gpointer data);
175
176 void vf_thumb_update(ViewFile *vf);
177 void vf_thumb_cleanup(ViewFile *vf);
178 void vf_thumb_stop(ViewFile *vf);
179 void vf_read_metadata_in_idle(ViewFile *vf);
180 void vf_file_filter_set(ViewFile *vf, gboolean enable);
181 GRegex *vf_file_filter_get_filter(ViewFile *vf);
182
183 void vf_star_update(ViewFile *vf);
184 gboolean vf_stars_cb(gpointer data);
185 void vf_star_stop(ViewFile *vf);
186 void vf_star_cleanup(ViewFile *vf);
187
188 #endif /* VIEW_FILE_H */
189 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */