FileBrowser: Editable Bookmarks.
[blender-staging.git] / source / blender / editors / space_file / fsmenu.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * 
27  */
28
29 /** \file blender/editors/space_file/fsmenu.h
30  *  \ingroup spfile
31  */
32
33
34 #ifndef __FSMENU_H__
35 #define __FSMENU_H__
36
37 /* XXX could become UserPref */
38 #define FSMENU_RECENT_MAX 10
39
40 enum FSMenuCategory;
41 enum FSMenuInsert;
42
43 struct FSMenu;
44 struct FSMenuEntry;
45
46 /** Inserts a new fsmenu entry with the given \a path.
47  * Duplicate entries are not added.
48  * \param flag Options for inserting the entry.
49  */
50 void    fsmenu_insert_entry(struct FSMenu *fsmenu, enum FSMenuCategory category, const char *path, const char *name, const enum FSMenuInsert flag);
51
52 /** Return whether the entry was created by the user and can be saved and deleted */
53 short   fsmenu_can_save(struct FSMenu *fsmenu, enum FSMenuCategory category, int index);
54
55 /** Removes the fsmenu entry at the given \a index. */
56 void    fsmenu_remove_entry(struct FSMenu *fsmenu, enum FSMenuCategory category, int index);
57
58 /** saves the 'bookmarks' to the specified file */
59 void    fsmenu_write_file(struct FSMenu *fsmenu, const char *filename);
60         
61 /** reads the 'bookmarks' from the specified file */
62 void    fsmenu_read_bookmarks(struct FSMenu *fsmenu, const char *filename);
63
64 /** adds system specific directories */
65 void    fsmenu_read_system(struct FSMenu *fsmenu, int read_bookmarks);
66
67 /** Free's all the memory associated with the fsmenu */
68 void    fsmenu_free(void);
69
70 /** Refresh system directory menu */
71 void    fsmenu_refresh_system_category(struct FSMenu *fsmenu);
72
73 /** Get active index based on given directory. */
74 int     fsmenu_get_active_indices(struct FSMenu *fsmenu, enum FSMenuCategory category, const char *dir);
75
76 #endif
77