Blender V5.3
ED_fileselect.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2008 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include <string>
12
13#include "BLI_vector.hh"
14
15#include "DNA_uuid_types.h"
16
17namespace blender {
18
19struct ARegion;
21struct FileDirEntry;
22struct FileSelectParams;
23struct FSMenu;
24struct FSMenuEntry;
25struct ID;
26struct ScrArea;
27struct SpaceFile;
28struct bContext;
29struct bScreen;
30namespace ui {
31struct Block;
32}
33struct wmOperator;
34struct wmWindow;
35struct wmWindowManager;
36struct View2D;
37struct rcti;
38namespace asset_system {
39class AssetLibrary;
40}
41
42enum eFileSortType : short;
43
44#define FILE_LAYOUT_HOR 1
45#define FILE_LAYOUT_VER 2
46
55
58 const char *name;
59
60 float width;
63
65 int text_align; /* eFontStyle_Align */
66};
67
108
110 int first;
111 int last;
112};
113
125
132
133void ED_fileselect_init_layout(SpaceFile *sfile, ARegion *region);
134
136
138int ED_fileselect_layout_offset(FileLayout *layout, int x, int y);
140
145void ED_fileselect_layout_maskrect(const FileLayout *layout, const View2D *v2d, rcti *r_rect);
146bool ED_fileselect_layout_is_inside_pt(const FileLayout *layout, const View2D *v2d, int x, int y);
148 const View2D *v2d,
149 const rcti *rect,
150 rcti *r_dst);
151void ED_fileselect_layout_tilepos(const FileLayout *layout, int tile, int *x, int *y);
152
154
157
159
164
165void ED_fileselect_activate_asset_catalog(const SpaceFile *sfile, bUUID catalog_id);
166
180int /* #eAssetImportMethod */ ED_fileselect_asset_import_method_get(const SpaceFile *sfile,
181 const FileDirEntry *file);
182
187void ED_fileselect_activate_by_id(SpaceFile *sfile, ID *asset_id, bool deferred);
188
190void ED_fileselect_activate_by_relpath(SpaceFile *sfile, const char *relative_path);
191
192void ED_fileselect_window_params_get(const wmWindow *win, int r_win_size[2], bool *r_is_maximized);
193
197ScrArea *ED_fileselect_handler_area_find(const wmWindow *win, const wmOperator *file_operator);
203
208void ED_fileselect_ensure_default_filepath(bContext *C, wmOperator *op, const char *extension);
209
211
212/* TODO: Maybe we should move this to BLI?
213 * On the other hand, it's using defines from space-file area, so not sure... */
214int ED_path_extension_type(const char *path);
215int ED_file_extension_icon(const char *path);
216int ED_file_icon(const FileDirEntry *file);
217
219
226
227void ED_file_path_button(bScreen *screen,
228 SpaceFile *sfile,
229 FileSelectParams *params,
230 ui::Block *block);
231
232/* File menu stuff */
233
234/* FSMenuEntry's without paths indicate separators */
237
238 char *path;
239 char name[/*FILE_MAXFILE*/ 256];
240 short save;
241 int icon;
242};
243
252
255 FS_INSERT_SAVE = (1 << 1),
257 FS_INSERT_FIRST = (1 << 2),
259 FS_INSERT_LAST = (1 << 3),
260};
261
262FSMenu *ED_fsmenu_get();
263FSMenuEntry *ED_fsmenu_get_category(FSMenu *fsmenu, FSMenuCategory category);
264void ED_fsmenu_set_category(FSMenu *fsmenu, FSMenuCategory category, FSMenuEntry *fsm_head);
265
266int ED_fsmenu_get_nentries(FSMenu *fsmenu, FSMenuCategory category);
267
268FSMenuEntry *ED_fsmenu_get_entry(FSMenu *fsmenu, FSMenuCategory category, int idx);
269
270char *ED_fsmenu_entry_get_path(FSMenuEntry *fsentry);
271void ED_fsmenu_entry_set_path(FSMenuEntry *fsentry, const char *path);
272
273char *ED_fsmenu_entry_get_name(FSMenuEntry *fsentry);
274void ED_fsmenu_entry_set_name(FSMenuEntry *fsentry, const char *name);
275
276int ED_fsmenu_entry_get_icon(FSMenuEntry *fsentry);
277void ED_fsmenu_entry_set_icon(FSMenuEntry *fsentry, int icon);
278
279} // namespace blender
#define C
Definition RandGen.cpp:29
const ccl_global KernelWorkTile * tile
BMesh Iterators.
FSMenu * ED_fsmenu_get()
Definition fsmenu.cc:48
Vector< std::string > ED_fileselect_selected_files_full_paths(const SpaceFile *sfile)
Definition filesel.cc:1534
int ED_fileselect_layout_offset(FileLayout *layout, int x, int y)
Definition filesel.cc:853
int ED_fileselect_layout_numfiles(FileLayout *layout, ARegion *region)
Definition filesel.cc:767
void ED_file_change_dir_ex(bContext *C, ScrArea *area)
Definition filesel.cc:1193
FileLayout * ED_fileselect_get_layout(SpaceFile *sfile, ARegion *region)
Definition filesel.cc:1185
void ED_file_change_dir(bContext *C)
Definition filesel.cc:1226
int ED_file_icon(const FileDirEntry *file)
Definition filelist.cc:446
int ED_path_extension_type(const char *path)
Definition filelist.cc:1852
void ED_operatormacros_file()
Definition file_ops.cc:3442
FSMenuEntry * ED_fsmenu_get_entry(FSMenu *fsmenu, FSMenuCategory category, int idx)
Definition fsmenu.cc:113
char * ED_fsmenu_entry_get_name(FSMenuEntry *fsentry)
Definition fsmenu.cc:177
bool ED_fileselect_is_asset_browser(const SpaceFile *sfile)
Definition filesel.cc:486
void ED_fsmenu_entry_set_path(FSMenuEntry *fsentry, const char *path)
Definition fsmenu.cc:131
FileSelectParams * ED_fileselect_ensure_active_params(SpaceFile *sfile)
Definition filesel.cc:374
void ED_fileselect_layout_tilepos(const FileLayout *layout, int tile, int *x, int *y)
Definition filesel.cc:905
void ED_file_read_bookmarks()
int ED_file_extension_icon(const char *path)
Definition filelist.cc:1946
ScrArea * ED_fileselect_handler_area_find(const wmWindow *win, const wmOperator *file_operator)
Definition filesel.cc:1480
int ED_fsmenu_entry_get_icon(FSMenuEntry *fsentry)
Definition fsmenu.cc:150
void ED_fileselect_activate_asset_catalog(const SpaceFile *sfile, bUUID catalog_id)
Definition filesel.cc:519
void ED_fsmenu_set_category(FSMenu *fsmenu, FSMenuCategory category, FSMenuEntry *fsm_head)
Definition fsmenu.cc:80
void ED_fsmenu_entry_set_name(FSMenuEntry *fsentry, const char *name)
Definition fsmenu.cc:191
bool ED_fileselect_layout_is_inside_pt(const FileLayout *layout, const View2D *v2d, int x, int y)
Definition filesel.cc:888
FileSelection ED_fileselect_layout_offset_rect(FileLayout *layout, const rcti *rect)
Definition filesel.cc:801
void ED_fileselect_activate_by_id(SpaceFile *sfile, ID *asset_id, bool deferred)
Definition filesel.cc:582
void ED_fileselect_params_to_userdef(SpaceFile *sfile)
Definition filesel.cc:723
void ED_fileselect_ensure_default_filepath(bContext *C, wmOperator *op, const char *extension)
Definition filesel.cc:1515
void ED_fileselect_clear(wmWindowManager *wm, SpaceFile *sfile)
Definition filesel.cc:1335
int ED_fileselect_asset_import_method_get(const SpaceFile *sfile, const FileDirEntry *file)
Definition filesel.cc:531
void ED_fileselect_activate_by_relpath(SpaceFile *sfile, const char *relative_path)
Definition filesel.cc:621
FileAttributeColumnType
@ ATTRIBUTE_COLUMN_MAX
void ED_file_path_button(bScreen *screen, SpaceFile *sfile, FileSelectParams *params, ui::Block *block)
Definition file_draw.cc:94
FileSelectParams * ED_fileselect_get_active_params(const SpaceFile *sfile)
Definition filesel.cc:393
void ED_fileselect_clear_main_assets(wmWindowManager *wm, SpaceFile *sfile)
Definition filesel.cc:1350
void ED_fileselect_layout_maskrect(const FileLayout *layout, const View2D *v2d, rcti *r_rect)
Definition filesel.cc:882
bool ED_fileselect_is_file_browser(const SpaceFile *sfile)
Definition filesel.cc:481
void ED_fsmenu_entry_set_icon(FSMenuEntry *fsentry, int icon)
Definition fsmenu.cc:155
void ED_fileselect_set_params_from_userdef(SpaceFile *sfile)
Definition filesel.cc:688
FileSelectParams * ED_fileselect_get_file_params(const SpaceFile *sfile)
Definition filesel.cc:411
FileAssetSelectParams * ED_fileselect_get_asset_params(const SpaceFile *sfile)
Definition filesel.cc:416
char * ED_fsmenu_entry_get_path(FSMenuEntry *fsentry)
Definition fsmenu.cc:126
asset_system::AssetLibrary * ED_fileselect_active_asset_library_get(const SpaceFile *sfile)
Definition filesel.cc:491
@ FS_CATEGORY_BOOKMARKS
@ FS_CATEGORY_SYSTEM_BOOKMARKS
ID * ED_fileselect_active_asset_get(const SpaceFile *sfile)
Definition filesel.cc:500
int ED_fsmenu_get_nentries(FSMenu *fsmenu, FSMenuCategory category)
Definition fsmenu.cc:101
bool ED_fileselect_is_local_asset_library(const SpaceFile *sfile)
Definition filesel.cc:421
ScrArea * ED_fileselect_handler_area_find_any_with_op(const wmWindow *win)
Definition filesel.cc:1497
FSMenuEntry * ED_fsmenu_get_category(FSMenu *fsmenu, FSMenuCategory category)
Definition fsmenu.cc:56
void ED_fileselect_deselect_all(SpaceFile *sfile)
Definition filesel.cc:649
bool ED_fileselect_layout_isect_rect(const FileLayout *layout, const View2D *v2d, const rcti *rect, rcti *r_dst)
Definition filesel.cc:895
void ED_fileselect_init_layout(SpaceFile *sfile, ARegion *region)
Definition filesel.cc:1069
void ED_fileselect_window_params_get(const wmWindow *win, int r_win_size[2], bool *r_is_maximized)
Definition filesel.cc:660
void ED_fileselect_exit(wmWindowManager *wm, SpaceFile *sfile)
Definition filesel.cc:1367
FileAttributeColumn attribute_columns[ATTRIBUTE_COLUMN_MAX]
Universally Unique Identifier according to RFC4122.