doxygen: editor entry
[blender.git] / source / blender / editors / include / ED_fileselect.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) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file ED_fileselect.h
30  *  \ingroup editors
31  */
32
33 #ifndef ED_FILES_H
34 #define ED_FILES_H
35
36 struct SpaceFile;
37 struct ARegion;
38 struct FileSelectParams;
39 struct bContext;
40
41 #define FILE_LAYOUT_HOR 1
42 #define FILE_LAYOUT_VER 2
43
44 #define MAX_FILE_COLUMN 8
45
46 typedef enum FileListColumns {
47         COLUMN_NAME = 0,
48         COLUMN_DATE,
49         COLUMN_TIME,
50         COLUMN_SIZE,
51         COLUMN_MODE1,
52         COLUMN_MODE2,
53         COLUMN_MODE3,
54         COLUMN_OWNER
55 } FileListColumns;
56
57 typedef struct FileLayout
58 {
59         /* view settings - XXX - move into own struct */
60         int prv_w;
61         int prv_h;
62         int tile_w;
63         int tile_h;
64         int tile_border_x;
65         int tile_border_y;
66         int prv_border_x;
67         int prv_border_y;
68         int rows;
69         int columns;
70         int width;
71         int height;
72         int flag;
73         int dirty;
74         int textheight;
75         float column_widths[MAX_FILE_COLUMN];
76 } FileLayout;
77
78 struct FileSelectParams* ED_fileselect_get_params(struct SpaceFile *sfile);
79
80 short ED_fileselect_set_params(struct SpaceFile *sfile);
81
82 void ED_fileselect_reset_params(struct SpaceFile *sfile);
83
84
85 void ED_fileselect_init_layout(struct SpaceFile *sfile, struct ARegion *ar);
86
87
88 FileLayout* ED_fileselect_get_layout(struct SpaceFile *sfile, struct ARegion *ar);
89
90 int ED_fileselect_layout_numfiles(FileLayout* layout, struct ARegion *ar);
91 int ED_fileselect_layout_offset(FileLayout* layout, int clamp_bounds, int x, int y);
92
93 void ED_fileselect_layout_tilepos(FileLayout* layout, int tile, int *x, int *y);
94
95 void ED_operatormacros_file(void);
96
97 void ED_fileselect_clear(struct bContext *C, struct SpaceFile *sfile);
98
99 void ED_fileselect_exit(struct bContext *C, struct SpaceFile *sfile);
100
101 int ED_file_extension_icon(char *relname);
102
103 #endif /* ED_FILES_H */
104