fixed spacing in the headers to get rid of some warnings and some other
[blender.git] / source / blender / include / BIF_fsmenu.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  * 
32  */
33
34 #ifndef BSE_FSMENU_H
35 #define BSE_FSMENU_H
36
37         /** Returns the number of entries in the Fileselect Menu */
38 int             fsmenu_get_nentries             (void);
39
40         /** Returns true if the fsmenu entry at @a index exists and
41          * is a seperator.
42          */
43 char*   fsmenu_is_entry_a_seperator     (int index);
44
45         /** Returns the fsmenu entry at @a index (or NULL if a bad index)
46      * or a seperator.
47          */
48 char*   fsmenu_get_entry                (int index);
49
50         /** Returns a new menu description string representing the
51          * fileselect menu. Should be free'd with MEM_freeN.
52          */
53 char*   fsmenu_build_menu               (void);
54
55         /** Append a seperator to the FSMenu, inserts always follow the
56          * last seperator.
57          */
58 void    fsmenu_append_seperator (void);
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             (char *path, int sorted);
65
66         /** Removes the fsmenu entry at the given @a index. */
67 void    fsmenu_remove_entry             (int index);
68
69         /** Free's all the memory associated with the fsmenu */
70 void    fsmenu_free                             (void);
71
72 #endif
73