Blender V5.3
file_intern.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 "DNA_space_types.h"
12
13#include "BKE_report.hh"
14
15#include "ED_fileselect.hh"
16
17namespace blender {
18
19/* internal exports only */
20
21struct ARegion;
22struct ARegionType;
25struct FileSelectParams;
26struct FolderList;
27struct Main;
28struct SpaceFile;
29struct View2D;
30namespace asset_system {
31class AssetLibrary;
32}
33namespace ui {
34struct Layout;
35} // namespace ui
36
38
39/* `file_context.cc` */
40
41int /*eContextResult*/ file_context(const bContext *C,
42 const char *member,
44
45/* `file_draw.cc` */
46
47#define ATTRIBUTE_COLUMN_PADDING (0.5f * UI_UNIT_X)
48
49#define FILE_LAYOUT_COMPACT(_layout) \
50 (_layout->flag & FILE_LAYOUT_VER && (_layout->width / UI_SCALE_FAC) < 500)
51#define FILE_LAYOUT_HIDE_DATE(_layout) \
52 (_layout->flag & FILE_LAYOUT_VER && (_layout->width / UI_SCALE_FAC) < 250)
53#define FILE_LAYOUT_HIDE_SIZE(_layout) \
54 (_layout->flag & FILE_LAYOUT_VER && (_layout->width / UI_SCALE_FAC) < 350)
55
56void file_draw_list(const bContext *C, ARegion *region);
57bool file_banner_poll(const SpaceFile *sfile);
58void file_draw_banner(const bContext *C, const SpaceFile *sfile, ARegion *region);
63bool file_draw_hint_if_invalid(const bContext *C, const SpaceFile *sfile, ARegion *region);
64
70void file_draw_check_cb(bContext *C, void *arg1, void *arg2);
72
73/* file_ops.h */
74
75struct wmOperator;
76struct wmOperatorType;
77
92
95
115
124void file_directory_enter_handle(bContext *C, void *arg_unused, void *arg_but);
125void file_filename_enter_handle(bContext *C, void *arg_unused, void *arg_but);
126
127int file_highlight_set(SpaceFile *sfile, ARegion *region, int mx, int my);
128
132void file_sfile_filepath_set(SpaceFile *sfile, const char *filepath);
134 bContext *C, Main *bmain, wmOperator *op, SpaceFile *sfile, char *filepath);
135void file_sfile_to_operator(bContext *C, Main *bmain, wmOperator *op, SpaceFile *sfile);
136
137void file_operator_to_sfile(Main *bmain, SpaceFile *sfile, wmOperator *op);
138
139/* `space_file.cc` */
140
141extern "C" const char *file_context_dir[]; /* doc access */
142
143/* `filesel.cc` */
144
149void fileselect_file_set(bContext *C, SpaceFile *sfile, int index);
152 const FileLayout *layout);
157 const FileLayout *layout,
158 int x,
159 int y);
164 const FileSelectParams *params,
165 FileLayout *layout,
166 int x);
167float file_string_width(const char *str);
168
169float file_font_pointsize();
171int file_select_match(SpaceFile *sfile, const char *pattern, char *matched_file);
172int autocomplete_directory(bContext *C, char *str, void *arg_v);
173int autocomplete_file(bContext *C, char *str, void *arg_v);
174
188 wmWindow *win,
189 SpaceFile *sfile,
190 const FileDirEntry *rename_file);
196
202};
203
204using onReloadFnData = void *;
205using onReloadFn = void (*)(SpaceFile *space_data, onReloadFnData custom_data);
207 /* Called once after the file browser has reloaded. Reset to NULL after calling.
208 * Use file_on_reload_callback_register() to register a callback. */
211
212 /* Indicates, if the current filepath is a blendfile library one, if its status has been checked,
213 * and if it is readable. */
217
219};
220
226 onReloadFn callback,
227 onReloadFnData custom_data);
228
229/* folder_history.cc */
230
231/* not listbase itself */
232void folderlist_free(ListBaseT<FolderList> *folderlist);
233void folderlist_popdir(ListBaseT<FolderList> *folderlist, char *dir);
234void folderlist_pushdir(ListBaseT<FolderList> *folderlist, const char *dir);
235const char *folderlist_peeklastdir(ListBaseT<FolderList> *folderlist);
237
240ListBaseT<FileFolderHistory> folder_history_list_duplicate(ListBaseT<FileFolderHistory> *listbase);
241
242/* `file_panels.cc` */
243
247
248/* `file_utils.cc` */
249
250void file_tile_boundbox(const ARegion *region, FileLayout *layout, int file, rcti *r_bounds);
251
255void file_path_to_ui_path(const char *path, char *r_path, int r_path_maxncpy);
256
257/* asset_catalog_tree_view.cc */
258
259namespace ed::asset_browser {
260
262 asset_system::AssetLibrary *asset_library,
263 ui::Layout &layout,
264 SpaceFile *space_file,
265 FileAssetSelectParams *params);
266
267class AssetCatalogFilterSettings;
268
269AssetCatalogFilterSettings *file_create_asset_catalog_filter_settings();
270void file_delete_asset_catalog_filter_settings(AssetCatalogFilterSettings **filter_settings);
276 AssetCatalogFilterSettings *filter_settings,
278 const bUUID &catalog_id);
279void file_ensure_updated_catalog_filter_data(AssetCatalogFilterSettings *filter_settings,
280 const asset_system::AssetLibrary *asset_library);
282 const AssetCatalogFilterSettings *filter_settings, const AssetMetaData *asset_data);
283
284} // namespace ed::asset_browser
285
286} // namespace blender
#define C
Definition RandGen.cpp:29
#define str(s)
void file_ensure_updated_catalog_filter_data(AssetCatalogFilterSettings *filter_settings, const asset_system::AssetLibrary *asset_library)
bool file_set_asset_catalog_filter_settings(AssetCatalogFilterSettings *filter_settings, eFileSel_Params_AssetCatalogVisibility catalog_visibility, const bUUID &catalog_id)
void file_create_asset_catalog_tree_view_in_layout(const bContext *C, asset_system::AssetLibrary *asset_library, ui::Layout &layout, SpaceFile *space_file, FileAssetSelectParams *params)
AssetCatalogFilterSettings * file_create_asset_catalog_filter_settings()
bool file_is_asset_visible_in_catalog_filter_settings(const AssetCatalogFilterSettings *filter_settings, const AssetMetaData *asset_data)
void file_delete_asset_catalog_filter_settings(AssetCatalogFilterSettings **filter_settings)
BMesh Iterators.
void file_params_renamefile_activate(SpaceFile *sfile, FileSelectParams *params)
Definition filesel.cc:1437
void FILE_OT_select_bookmark(wmOperatorType *ot)
Definition file_ops.cc:1146
void file_draw_check_cb(bContext *C, void *arg1, void *arg2)
Definition file_ops.cc:1799
const char * file_context_dir[]
void FILE_OT_highlight(wmOperatorType *ot)
Definition file_ops.cc:1499
void FILE_OT_bookmark_move(wmOperatorType *ot)
Definition file_ops.cc:1367
void file_tile_boundbox(const ARegion *region, FileLayout *layout, int file, rcti *r_bounds)
Definition file_utils.cc:23
const char * folderlist_peeklastdir(ListBaseT< FolderList > *folderlist)
void file_draw_check(bContext *C)
Definition file_ops.cc:1793
int file_select_match(SpaceFile *sfile, const char *pattern, char *matched_file)
Definition filesel.cc:1241
void FILE_OT_delete(wmOperatorType *ot)
Definition file_ops.cc:3352
void FILE_OT_rename(wmOperatorType *ot)
Definition file_ops.cc:3246
void(*)(SpaceFile *space_data, onReloadFnData custom_data) onReloadFn
void FILE_OT_view_selected(wmOperatorType *ot)
Definition file_ops.cc:1102
void FILE_OT_directory_new(wmOperatorType *ot)
Definition file_ops.cc:2812
void FILE_OT_bookmark_cleanup(wmOperatorType *ot)
Definition file_ops.cc:1279
void folder_history_list_ensure_for_active_browse_mode(SpaceFile *sfile)
bool file_banner_poll(const SpaceFile *sfile)
void FILE_OT_smoothscroll(wmOperatorType *ot)
Definition file_ops.cc:2614
bool file_draw_hint_if_invalid(const bContext *C, const SpaceFile *sfile, ARegion *region)
void FILE_OT_cancel(wmOperatorType *ot)
Definition file_ops.cc:1598
void folderlist_free(ListBaseT< FolderList > *folderlist)
void FILE_OT_select_box(wmOperatorType *ot)
Definition file_ops.cc:542
void FILE_OT_select(wmOperatorType *ot)
Definition file_ops.cc:659
void file_directory_enter_handle(bContext *C, void *arg_unused, void *arg_but)
Definition file_ops.cc:2954
int autocomplete_file(bContext *C, char *str, void *arg_v)
Definition filesel.cc:1315
void file_params_smoothscroll_timer_clear(wmWindowManager *wm, wmWindow *win, SpaceFile *sfile)
Definition filesel.cc:1387
int autocomplete_directory(bContext *C, char *str, void *arg_v)
Definition filesel.cc:1266
void file_select_deselect_all(SpaceFile *sfile, eDirEntry_SelectFlag flag)
Definition filesel.cc:1232
void file_path_to_ui_path(const char *path, char *r_path, int r_path_maxncpy)
Definition file_utils.cc:36
void FILE_OT_parent(wmOperatorType *ot)
Definition file_ops.cc:2346
void file_tool_props_region_panels_register(ARegionType *art)
void fileselect_refresh_params(SpaceFile *sfile)
Definition filesel.cc:473
void FILE_OT_edit_directory_path(wmOperatorType *ot)
Definition file_ops.cc:3424
void file_execute_region_panels_register(ARegionType *art)
void FILE_OT_filepath_drop(wmOperatorType *ot)
Definition file_ops.cc:2661
FileAttributeColumnType file_attribute_column_type_find_isect(const View2D *v2d, const FileSelectParams *params, FileLayout *layout, int x)
Definition filesel.cc:949
void FILE_OT_start_filter(wmOperatorType *ot)
Definition file_ops.cc:3388
void file_params_rename_end(wmWindowManager *wm, wmWindow *win, SpaceFile *sfile, const FileDirEntry *rename_file)
Definition filesel.cc:1406
void FILE_OT_filenum(wmOperatorType *ot)
Definition file_ops.cc:3189
void file_sfile_to_operator_ex(bContext *C, Main *bmain, wmOperator *op, SpaceFile *sfile, char *filepath)
Definition file_ops.cc:1616
void FILE_OT_hidedot(wmOperatorType *ot)
Definition file_ops.cc:3111
void FILE_OT_next(wmOperatorType *ot)
Definition file_ops.cc:2419
ListBaseT< FileFolderHistory > folder_history_list_duplicate(ListBaseT< FileFolderHistory > *listbase)
void FILE_OT_external_operation(wmOperatorType *ot)
Definition file_ops.cc:1944
void file_external_operations_menu_register()
Definition file_ops.cc:2097
void file_params_renamefile_clear(FileSelectParams *params)
Definition filesel.cc:1423
void file_params_invoke_rename_postscroll(wmWindowManager *wm, wmWindow *win, SpaceFile *sfile)
Definition filesel.cc:1393
void FILE_OT_sort_column_ui_context(wmOperatorType *ot)
Definition file_ops.cc:1552
void folderlist_pushdir(ListBaseT< FolderList > *folderlist, const char *dir)
void FILE_OT_refresh(wmOperatorType *ot)
Definition file_ops.cc:2305
FileAttributeColumnType
void FILE_OT_bookmark_add(wmOperatorType *ot)
Definition file_ops.cc:1190
bool folderlist_clear_next(SpaceFile *sfile)
void file_draw_list(const bContext *C, ARegion *region)
void file_operator_to_sfile(Main *bmain, SpaceFile *sfile, wmOperator *op)
Definition file_ops.cc:1722
int file_context(const bContext *C, const char *member, bContextDataResult *result)
void FILE_OT_bookmark_delete(wmOperatorType *ot)
Definition file_ops.cc:1227
void folder_history_list_free(SpaceFile *sfile)
bool file_draw_check_exists(SpaceFile *sfile)
Definition file_ops.cc:1804
void FILE_OT_mouse_execute(wmOperatorType *ot)
Definition file_ops.cc:2268
eFileSel_Params_AssetCatalogVisibility
void FILE_OT_select_walk(wmOperatorType *ot)
Definition file_ops.cc:945
void file_sfile_filepath_set(SpaceFile *sfile, const char *filepath)
Definition file_ops.cc:1750
void FILE_OT_execute(wmOperatorType *ot)
Definition file_ops.cc:2210
float file_string_width(const char *str)
Definition filesel.cc:989
void file_sfile_to_operator(bContext *C, Main *bmain, wmOperator *op, SpaceFile *sfile)
Definition file_ops.cc:1715
void file_draw_check_ex(bContext *C, ScrArea *area)
Definition file_ops.cc:1769
void file_draw_banner(const bContext *C, const SpaceFile *sfile, ARegion *region)
int file_highlight_set(SpaceFile *sfile, ARegion *region, int mx, int my)
Definition file_ops.cc:1435
void folderlist_popdir(ListBaseT< FolderList > *folderlist, char *dir)
void FILE_OT_reset_recent(wmOperatorType *ot)
Definition file_ops.cc:1416
void file_filename_enter_handle(bContext *C, void *arg_unused, void *arg_but)
Definition file_ops.cc:3040
void fileselect_file_set(bContext *C, SpaceFile *sfile, int index)
Definition filesel.cc:753
void file_tools_region_panels_register(ARegionType *art)
void file_on_reload_callback_register(SpaceFile *sfile, onReloadFn callback, onReloadFnData custom_data)
void FILE_OT_previous(wmOperatorType *ot)
Definition file_ops.cc:2382
float file_font_pointsize()
Definition filesel.cc:996
bool file_main_region_needs_refresh_before_draw(SpaceFile *sfile)
bool file_attribute_column_type_enabled(const FileSelectParams *params, FileAttributeColumnType column, const FileLayout *layout)
Definition filesel.cc:931
void FILE_OT_select_all(wmOperatorType *ot)
Definition file_ops.cc:1041
void * onReloadFnData
bool file_attribute_column_header_is_inside(const View2D *v2d, const FileLayout *layout, int x, int y)
Definition filesel.cc:921
The meta-data of an asset. By creating and giving this for a data-block (ID.asset_data),...
onReloadFnData on_reload_custom_data
ReportList is_blendfile_readable_reports
Universally Unique Identifier according to RFC4122.