FileBrowser: Editable Bookmarks.
[blender-staging.git] / source / blender / editors / include / ED_fileselect.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file ED_fileselect.h
28  *  \ingroup editors
29  */
30
31 #ifndef __ED_FILESELECT_H__
32 #define __ED_FILESELECT_H__
33
34 struct ARegion;
35 struct FileSelectParams;
36 struct SpaceFile;
37 struct bContext;
38 struct wmWindowManager;
39
40 #define FILE_LAYOUT_HOR 1
41 #define FILE_LAYOUT_VER 2
42
43 #define MAX_FILE_COLUMN 8
44
45 typedef enum FileListColumns {
46         COLUMN_NAME = 0,
47         COLUMN_DATE,
48         COLUMN_TIME,
49         COLUMN_SIZE,
50         COLUMN_MODE1,
51         COLUMN_MODE2,
52         COLUMN_MODE3,
53         COLUMN_OWNER
54 } FileListColumns;
55
56 typedef struct FileLayout {
57         /* view settings - XXX - move into own struct */
58         int prv_w;
59         int prv_h;
60         int tile_w;
61         int tile_h;
62         int tile_border_x;
63         int tile_border_y;
64         int prv_border_x;
65         int prv_border_y;
66         int rows;
67         int columns;
68         int width;
69         int height;
70         int flag;
71         int dirty;
72         int textheight;
73         float column_widths[MAX_FILE_COLUMN];
74 } FileLayout;
75
76 typedef struct FileSelection {
77         int first;
78         int last;
79 } FileSelection;
80
81 struct rcti;
82
83 struct FileSelectParams *ED_fileselect_get_params(struct SpaceFile *sfile);
84
85 short ED_fileselect_set_params(struct SpaceFile *sfile);
86
87 void ED_fileselect_reset_params(struct SpaceFile *sfile);
88
89
90 void ED_fileselect_init_layout(struct SpaceFile *sfile, struct ARegion *ar);
91
92
93 FileLayout *ED_fileselect_get_layout(struct SpaceFile *sfile, struct ARegion *ar);
94
95 int ED_fileselect_layout_numfiles(FileLayout *layout, struct ARegion *ar);
96 int ED_fileselect_layout_offset(FileLayout *layout, int x, int y);
97 FileSelection ED_fileselect_layout_offset_rect(FileLayout *layout, const struct rcti *rect);
98
99 void ED_fileselect_layout_tilepos(FileLayout *layout, int tile, int *x, int *y);
100
101 void ED_operatormacros_file(void);
102
103 void ED_fileselect_clear(struct wmWindowManager *wm, struct SpaceFile *sfile);
104
105 void ED_fileselect_exit(struct wmWindowManager *wm, struct SpaceFile *sfile);
106
107 int ED_file_extension_icon(const char *relname);
108
109 void ED_file_read_bookmarks(void);
110
111 void ED_file_change_dir(struct bContext *C, const bool checkdir);
112
113 /* File menu stuff */
114
115 typedef enum FSMenuCategory {
116         FS_CATEGORY_SYSTEM,
117         FS_CATEGORY_SYSTEM_BOOKMARKS,
118         FS_CATEGORY_BOOKMARKS,
119         FS_CATEGORY_RECENT
120 } FSMenuCategory;
121
122 typedef enum FSMenuInsert {
123         FS_INSERT_SORTED = (1 << 0),
124         FS_INSERT_SAVE   = (1 << 1),
125         FS_INSERT_FIRST  = (1 << 2),  /* moves the item to the front of the list when its not already there */
126         FS_INSERT_LAST   = (1 << 3),  /* just append to preseve delivered order */
127 } FSMenuInsert;
128
129 struct FSMenu;
130 struct FSMenuEntry;
131
132 struct FSMenu *ED_fsmenu_get(void);
133 struct FSMenuEntry *ED_fsmenu_get_category(struct FSMenu *fsmenu, FSMenuCategory category);
134 void ED_fsmenu_set_category(struct FSMenu *fsmenu, FSMenuCategory category, struct FSMenuEntry *fsm_head);
135
136 int ED_fsmenu_get_nentries(struct FSMenu *fsmenu, FSMenuCategory category);
137
138 struct FSMenuEntry *ED_fsmenu_get_entry(struct FSMenu *fsmenu, FSMenuCategory category, int index);
139
140 char *ED_fsmenu_entry_get_path(struct FSMenuEntry *fsentry);
141 void ED_fsmenu_entry_set_path(struct FSMenuEntry *fsentry, const char *path);
142
143 char *ED_fsmenu_entry_get_name(struct FSMenuEntry *fsentry);
144 void ED_fsmenu_entry_set_name(struct FSMenuEntry *fsentry, const char *name);
145
146 #endif /* __ED_FILESELECT_H__ */
147