Simplify vflist_get_formatted()
[geeqie.git] / src / collect.h
1 /*
2  * Copyright (C) 2004 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 COLLECT_H
23 #define COLLECT_H
24
25
26 CollectInfo *collection_info_new(FileData *fd, struct stat *st, GdkPixbuf *pixbuf);
27
28 void collection_info_free_thumb(CollectInfo *ci);
29 void collection_info_free(CollectInfo *ci);
30
31 void collection_info_set_thumb(CollectInfo *ci, GdkPixbuf *pixbuf);
32 gboolean collection_info_load_thumb(CollectInfo *ci);
33
34 void collection_list_free(GList *list);
35
36 GList *collection_list_sort(GList *list, SortType method);
37 GList *collection_list_add(GList *list, CollectInfo *ci, SortType method);
38 GList *collection_list_insert(GList *list, CollectInfo *ci, CollectInfo *insert_ci, SortType method);
39 GList *collection_list_remove(GList *list, CollectInfo *ci);
40 CollectInfo *collection_list_find_fd(GList *list, FileData *fd);
41 GList *collection_list_to_filelist(GList *list);
42
43 CollectionData *collection_new(const gchar *path);
44 void collection_free(CollectionData *cd);
45
46 void collection_ref(CollectionData *cd);
47 void collection_unref(CollectionData *cd);
48
49 void collection_path_changed(CollectionData *cd);
50
51 gint collection_to_number(CollectionData *cd);
52 CollectionData *collection_from_number(gint n);
53
54 /**
55  * @headerfile collection_from_dnd_data
56  * pass a NULL pointer to whatever you don't need
57  * use free_selected_list to free list, and
58  * g_list_free to free info_list, which is a list of
59  * CollectInfo pointers into CollectionData
60  */
61 CollectionData *collection_from_dnd_data(const gchar *data, GList **list, GList **info_list);
62 gchar *collection_info_list_to_dnd_data(CollectionData *cd, GList *list, gint *length);
63
64 gint collection_info_valid(CollectionData *cd, CollectInfo *info);
65
66 CollectInfo *collection_next_by_info(CollectionData *cd, CollectInfo *info);
67 CollectInfo *collection_prev_by_info(CollectionData *cd, CollectInfo *info);
68 CollectInfo *collection_get_first(CollectionData *cd);
69 CollectInfo *collection_get_last(CollectionData *cd);
70
71 void collection_set_sort_method(CollectionData *cd, SortType method);
72 void collection_randomize(CollectionData *cd);
73 void collection_set_update_info_func(CollectionData *cd,
74                                      void (*func)(CollectionData *, CollectInfo *, gpointer), gpointer data);
75
76 gboolean collection_add(CollectionData *cd, FileData *fd, gboolean sorted);
77 gboolean collection_add_check(CollectionData *cd, FileData *fd, gboolean sorted, gboolean must_exist);
78 gboolean collection_insert(CollectionData *cd, FileData *fd, CollectInfo *insert_ci, gboolean sorted);
79 gboolean collection_remove(CollectionData *cd, FileData *fd);
80 void collection_remove_by_info_list(CollectionData *cd, GList *list);
81 gboolean collection_rename(CollectionData *cd, FileData *fd);
82
83 void collection_update_geometry(CollectionData *cd);
84
85 CollectWindow *collection_window_new(const gchar *path);
86 void collection_window_close_by_collection(CollectionData *cd);
87 CollectWindow *collection_window_find(CollectionData *cd);
88 CollectWindow *collection_window_find_by_path(const gchar *path);
89 gboolean collection_window_modified_exists(void);
90
91 gboolean is_collection(const gchar *param);
92 gchar *collection_path(const gchar *param);
93 void collection_contents(const gchar *name, GString **contents);
94 GList *collection_contents_fd(const gchar *name);
95
96 #endif
97 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */