34aefa9122549b8a1b029cab2b52237ef0804317
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #ifndef ED_FILES_H
29 #define ED_FILES_H
30
31 struct SpaceFile;
32
33 #define FILE_SHORTDISPLAY       1
34 #define FILE_LONGDISPLAY        2
35 #define FILE_IMGDISPLAY         3
36
37 typedef struct FileSelectParams {
38         char title[24]; /* title, also used for the text of the execute button */
39         char dir[240]; /* directory */
40         char file[80]; /* file */
41
42         short flag; /* settings for filter, hiding files and display mode */
43         short sort; /* sort order */
44         short display; /* display mode flag */
45         short filter; /* filter when (flags & FILE_FILTER) is true */
46
47         /* XXX - temporary, better move to filelist */
48         short active_bookmark;
49         int     active_file;
50         int selstate;
51
52         /* XXX --- still unused -- */
53         short f_fp; /* show font preview */
54         char fp_str[8]; /* string to use for font preview */
55         
56         char *pupmenu; /* allows menu for save options - result stored in menup */
57         short menu; /* currently selected option in pupmenu */
58         /* XXX --- end unused -- */
59 } FileSelectParams;
60
61 #define FILE_LAYOUT_HOR 1
62 #define FILE_LAYOUT_VER 2
63
64 #define MAX_FILE_COLUMN 8
65
66 typedef enum FileListColumns {
67         COLUMN_NAME = 0,
68         COLUMN_DATE,
69         COLUMN_TIME,
70         COLUMN_SIZE,
71         COLUMN_MODE1,
72         COLUMN_MODE2,
73         COLUMN_MODE3,
74         COLUMN_OWNER
75 } FileListColumns;
76
77 typedef struct FileLayout
78 {
79         /* view settings - XXX - move into own struct */
80         short prv_w;
81         short prv_h;
82         short tile_w;
83         short tile_h;
84         short tile_border_x;
85         short tile_border_y;
86         short prv_border_x;
87         short prv_border_y;
88         short rows;
89         short columns;
90         short width;
91         short height;
92         short flag;
93         float column_widths[MAX_FILE_COLUMN];
94 } FileLayout;
95
96 FileSelectParams* ED_fileselect_get_params(struct SpaceFile *sfile);
97
98 short ED_fileselect_set_params(struct SpaceFile *sfile, const char *title, const char *path, 
99                                                    short flag, short display, short filter, short sort);
100
101 void ED_fileselect_reset_params(struct SpaceFile *sfile);
102
103
104 void ED_fileselect_init_layout(struct SpaceFile *sfile, struct ARegion *ar);
105
106
107 FileLayout* ED_fileselect_get_layout(struct SpaceFile *sfile, struct ARegion *ar);
108
109 int ED_fileselect_layout_offset(FileLayout* layout, int x, int y);
110
111 void ED_fileselect_layout_tilepos(FileLayout* layout, int tile, short *x, short *y);
112
113
114 #endif /* ED_FILES_H */
115