doxygen: blender/editors tagged.
[blender.git] / source / blender / editors / space_file / filelist.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  * The Original Code is Copyright (C) 2007 Blender Foundation.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL LICENSE BLOCK *****
31  */
32
33 /** \file blender/editors/space_file/filelist.h
34  *  \ingroup spfile
35  */
36
37
38 #ifndef FILELIST_H
39 #define FILELIST_H
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 struct FileList;
46 struct FolderList;
47 struct direntry;
48 struct BlendHandle;
49 struct Scene;
50 struct Main;
51 struct rcti;
52 struct ReportList;
53
54 struct FileList *       filelist_new(short type);
55 void                            filelist_init_icons(void);
56 void                            filelist_free_icons(void);
57 int                                     filelist_find(struct FileList* filelist, char *file);
58 void                            filelist_free(struct FileList* filelist);
59 void                            filelist_sort(struct FileList* filelist, short sort);
60 int                                     filelist_numfiles(struct FileList* filelist);
61 const char *            filelist_dir(struct FileList* filelist);
62 void                            filelist_setdir(struct FileList* filelist, const char *dir);
63 struct direntry *       filelist_file(struct FileList* filelist, int index);
64 void                            filelist_hidedot(struct FileList* filelist, short hide);
65 void                            filelist_setfilter(struct FileList* filelist, unsigned int filter);
66 void                            filelist_setfilter_types(struct FileList* filelist, const char *filter_glob);
67 void                            filelist_filter(struct FileList* filelist);
68 void                            filelist_swapselect(struct FileList* filelist);
69 void                            filelist_imgsize(struct FileList* filelist, short w, short h);
70 struct ImBuf *          filelist_getimage(struct FileList* filelist, int index);
71 struct ImBuf *          filelist_geticon(struct FileList* filelist, int index);
72 short                           filelist_changed(struct FileList* filelist);
73 void                            filelist_readdir(struct FileList* filelist);
74
75 int                                     filelist_empty(struct FileList* filelist);
76 void                            filelist_parent(struct FileList* filelist);
77
78 struct BlendHandle *filelist_lib(struct FileList* filelist);
79 int                                     filelist_islibrary (struct FileList* filelist, char* dir, char* group);
80 void                            filelist_from_main(struct FileList* filelist);
81 void                            filelist_from_library(struct FileList* filelist);
82 void                            filelist_freelib(struct FileList* filelist);
83 void                            filelist_hideparent(struct FileList* filelist, short hide);
84
85 struct ListBase *       folderlist_new(void);
86 void                            folderlist_free(struct ListBase* folderlist);
87 struct ListBase *       folderlist_duplicate(ListBase* folderlist);
88 void                            folderlist_popdir(struct ListBase* folderlist, char *dir);
89 void                            folderlist_pushdir(struct ListBase* folderlist, const char *dir);
90 int                                     folderlist_clear_next(struct SpaceFile* sfile);
91
92 void                            thumbnails_stop(struct FileList* filelist, const struct bContext* C);
93 void                            thumbnails_start(struct FileList* filelist, const struct bContext* C);
94 int                                     thumbnails_running(struct FileList* filelist, const struct bContext* C);
95
96 #ifdef __cplusplus
97 }
98 #endif
99
100 #endif
101