Merging r45936 through r46042 from trunk into soc-2011-tomato
[blender.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 typedef enum FSMenuCategory {
41         FS_CATEGORY_SYSTEM,
42         FS_CATEGORY_BOOKMARKS,
43         FS_CATEGORY_RECENT
44 } FSMenuCategory;
45
46 struct FSMenu;
47
48 struct FSMenu* fsmenu_get               (void);
49
50         /** Returns the number of entries in the Fileselect Menu */
51 int             fsmenu_get_nentries             (struct FSMenu* fsmenu, FSMenuCategory category);
52
53         /** Returns the fsmenu entry at \a index (or NULL if a bad index)
54          * or a separator.
55          */
56 char*   fsmenu_get_entry                (struct FSMenu* fsmenu, FSMenuCategory category, int index);
57
58         /** Inserts a new fsmenu entry with the given \a path.
59          * Duplicate entries are not added.
60          * \param sorted Should entry be inserted in sorted order?
61          */
62 void    fsmenu_insert_entry             (struct FSMenu* fsmenu, FSMenuCategory category, const char *path, int sorted, short save);
63
64         /** Return whether the entry was created by the user and can be saved and deleted */
65 short   fsmenu_can_save                 (struct FSMenu* fsmenu, FSMenuCategory category, int index);
66
67         /** Removes the fsmenu entry at the given \a index. */
68 void    fsmenu_remove_entry             (struct FSMenu* fsmenu, FSMenuCategory category, int index);
69
70         /** saves the 'bookmarks' to the specified file */
71 void    fsmenu_write_file               (struct FSMenu* fsmenu, const char *filename);
72         
73         /** reads the 'bookmarks' from the specified file */
74 void    fsmenu_read_bookmarks   (struct FSMenu* fsmenu, const char *filename);
75
76         /** adds system specific directories */
77 void    fsmenu_read_system      (struct FSMenu* fsmenu);
78
79         /** Free's all the memory associated with the fsmenu */
80 void    fsmenu_free                             (struct FSMenu* fsmenu);
81
82 #endif
83