doxygen: blender/editors tagged.
[blender.git] / source / blender / editors / space_file / fsmenu.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.
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
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * 
29  */
30
31 /** \file blender/editors/space_file/fsmenu.h
32  *  \ingroup spfile
33  */
34
35
36 #ifndef BSE_FSMENU_H
37 #define BSE_FSMENU_H
38
39 /* XXX could become UserPref */
40 #define FSMENU_RECENT_MAX 10
41
42 typedef enum FSMenuCategory {
43         FS_CATEGORY_SYSTEM,
44         FS_CATEGORY_BOOKMARKS,
45         FS_CATEGORY_RECENT
46 } FSMenuCategory;
47
48 struct FSMenu;
49
50 struct FSMenu* fsmenu_get               (void);
51
52         /** Returns the number of entries in the Fileselect Menu */
53 int             fsmenu_get_nentries             (struct FSMenu* fsmenu, FSMenuCategory category);
54
55         /** Returns the fsmenu entry at @a index (or NULL if a bad index)
56          * or a separator.
57          */
58 char*   fsmenu_get_entry                (struct FSMenu* fsmenu, FSMenuCategory category, int index);
59
60         /** Inserts a new fsmenu entry with the given @a path.
61          * Duplicate entries are not added.
62          * @param sorted Should entry be inserted in sorted order?
63          */
64 void    fsmenu_insert_entry             (struct FSMenu* fsmenu, FSMenuCategory category, const char *path, int sorted, short save);
65
66         /** Return whether the entry was created by the user and can be saved and deleted */
67 short   fsmenu_can_save                 (struct FSMenu* fsmenu, FSMenuCategory category, int index);
68
69         /** Removes the fsmenu entry at the given @a index. */
70 void    fsmenu_remove_entry             (struct FSMenu* fsmenu, FSMenuCategory category, int index);
71
72         /** saves the 'bookmarks' to the specified file */
73 void    fsmenu_write_file               (struct FSMenu* fsmenu, const char *filename);
74         
75         /** reads the 'bookmarks' from the specified file */
76 void    fsmenu_read_bookmarks   (struct FSMenu* fsmenu, const char *filename);
77
78         /** adds system specific directories */
79 void    fsmenu_read_system      (struct FSMenu* fsmenu);
80
81         /** Free's all the memory associated with the fsmenu */
82 void    fsmenu_free                             (struct FSMenu* fsmenu);
83
84 #endif
85