#include <string>
#include "BLI_vector.hh"
#include "DNA_uuid_types.h"

Classes
struct	FileAttributeColumn
struct	FileLayout
struct	FileSelection
struct	FSMenuEntry

Namespaces
namespace	blender
namespace	blender::asset_system

Macros
#define	FILE_LAYOUT_HOR 1
#define	FILE_LAYOUT_VER 2

Enumerations
enum	FileAttributeColumnType { COLUMN_NONE = -1 , COLUMN_NAME = 0 , COLUMN_DATETIME , COLUMN_SIZE , ATTRIBUTE_COLUMN_MAX }
enum	FSMenuCategory { FS_CATEGORY_SYSTEM , FS_CATEGORY_SYSTEM_BOOKMARKS , FS_CATEGORY_BOOKMARKS , FS_CATEGORY_RECENT , FS_CATEGORY_OTHER }
enum	FSMenuInsert { FS_INSERT_SORTED = (1 << 0) , FS_INSERT_SAVE = (1 << 1) , FS_INSERT_FIRST = (1 << 2) , FS_INSERT_LAST = (1 << 3) , FS_INSERT_NO_VALIDATE = (1 << 4) }

Functions
FileSelectParams *	ED_fileselect_ensure_active_params (SpaceFile *sfile)
FileSelectParams *	ED_fileselect_get_active_params (const SpaceFile *sfile)
FileSelectParams *	ED_fileselect_get_file_params (const SpaceFile *sfile)
FileAssetSelectParams *	ED_fileselect_get_asset_params (const SpaceFile *sfile)
bool	ED_fileselect_is_local_asset_library (const SpaceFile *sfile)
void	ED_fileselect_set_params_from_userdef (SpaceFile *sfile)
void	ED_fileselect_params_to_userdef (SpaceFile *sfile, const int temp_win_size[2], bool is_maximized)
void	ED_fileselect_init_layout (SpaceFile sfile, ARegion region)
FileLayout *	ED_fileselect_get_layout (SpaceFile sfile, ARegion region)
int	ED_fileselect_layout_numfiles (FileLayout layout, ARegion region)
int	ED_fileselect_layout_offset (FileLayout *layout, int x, int y)
FileSelection	ED_fileselect_layout_offset_rect (FileLayout layout, const rcti rect)
void	ED_fileselect_layout_maskrect (const FileLayout layout, const View2D v2d, rcti *r_rect)
bool	ED_fileselect_layout_is_inside_pt (const FileLayout layout, const View2D v2d, int x, int y)
bool	ED_fileselect_layout_isect_rect (const FileLayout layout, const View2D v2d, const rcti rect, rcti r_dst)
void	ED_fileselect_layout_tilepos (const FileLayout layout, int tile, int x, int *y)
void	ED_operatormacros_file ()
void	ED_fileselect_clear (wmWindowManager wm, SpaceFile sfile)
void	ED_fileselect_clear_main_assets (wmWindowManager wm, SpaceFile sfile)
void	ED_fileselect_exit (wmWindowManager wm, SpaceFile sfile)
bool	ED_fileselect_is_file_browser (const SpaceFile *sfile)
bool	ED_fileselect_is_asset_browser (const SpaceFile *sfile)
blender::asset_system::AssetLibrary *	ED_fileselect_active_asset_library_get (const SpaceFile *sfile)
ID *	ED_fileselect_active_asset_get (const SpaceFile *sfile)
void	ED_fileselect_activate_asset_catalog (const SpaceFile *sfile, bUUID catalog_id)
int	ED_fileselect_asset_import_method_get (const SpaceFile sfile, const FileDirEntry file)
void	ED_fileselect_activate_by_id (SpaceFile sfile, ID asset_id, bool deferred)
void	ED_fileselect_deselect_all (SpaceFile *sfile)
void	ED_fileselect_activate_by_relpath (SpaceFile sfile, const char relative_path)
void	ED_fileselect_window_params_get (const wmWindow win, int r_win_size[2], bool r_is_maximized)
ScrArea *	ED_fileselect_handler_area_find (const wmWindow win, const wmOperator file_operator)
ScrArea *	ED_fileselect_handler_area_find_any_with_op (const wmWindow *win)
void	ED_fileselect_ensure_default_filepath (bContext C, wmOperator op, const char *extension)
blender::Vector< std::string >	ED_fileselect_selected_files_full_paths (const SpaceFile *sfile)
int	ED_path_extension_type (const char *path)
int	ED_file_extension_icon (const char *path)
int	ED_file_icon (const FileDirEntry *file)
void	ED_file_read_bookmarks ()
void	ED_file_change_dir_ex (bContext C, ScrArea area)
void	ED_file_change_dir (bContext *C)
void	ED_file_path_button (bScreen screen, const SpaceFile sfile, FileSelectParams params, uiBlock block)
FSMenu *	ED_fsmenu_get ()
FSMenuEntry *	ED_fsmenu_get_category (FSMenu *fsmenu, FSMenuCategory category)
void	ED_fsmenu_set_category (FSMenu fsmenu, FSMenuCategory category, FSMenuEntry fsm_head)
int	ED_fsmenu_get_nentries (FSMenu *fsmenu, FSMenuCategory category)
FSMenuEntry *	ED_fsmenu_get_entry (FSMenu *fsmenu, FSMenuCategory category, int idx)
char *	ED_fsmenu_entry_get_path (FSMenuEntry *fsentry)
void	ED_fsmenu_entry_set_path (FSMenuEntry fsentry, const char path)
char *	ED_fsmenu_entry_get_name (FSMenuEntry *fsentry)
void	ED_fsmenu_entry_set_name (FSMenuEntry fsentry, const char name)
int	ED_fsmenu_entry_get_icon (FSMenuEntry *fsentry)
void	ED_fsmenu_entry_set_icon (FSMenuEntry *fsentry, int icon)

Macro Definition Documentation

◆ FILE_LAYOUT_HOR

#define FILE_LAYOUT_HOR 1

Definition at line 38 of file ED_fileselect.hh.

Referenced by ED_fileselect_init_layout(), ED_fileselect_layout_numfiles(), ED_fileselect_layout_offset(), ED_fileselect_layout_offset_rect(), ED_fileselect_layout_tilepos(), file_box_select_find_last_selected(), file_draw_list(), file_ensure_selection_inside_viewbounds(), file_smoothscroll_invoke(), and file_walk_select_do().

◆ FILE_LAYOUT_VER

#define FILE_LAYOUT_VER 2

Definition at line 39 of file ED_fileselect.hh.

Referenced by ED_fileselect_init_layout(), file_box_select_find_last_selected(), file_ensure_selection_inside_viewbounds(), and file_walk_select_do().

Enumeration Type Documentation

◆ FileAttributeColumnType

enum FileAttributeColumnType

Enumerator
COLUMN_NONE
COLUMN_NAME
COLUMN_DATETIME
COLUMN_SIZE
ATTRIBUTE_COLUMN_MAX

Definition at line 41 of file ED_fileselect.hh.

◆ FSMenuCategory

enum FSMenuCategory

Enumerator
FS_CATEGORY_SYSTEM
FS_CATEGORY_SYSTEM_BOOKMARKS
FS_CATEGORY_BOOKMARKS
FS_CATEGORY_RECENT
FS_CATEGORY_OTHER	For internal use, a list of known paths that are used to match paths to icons and names.

Definition at line 245 of file ED_fileselect.hh.

◆ FSMenuInsert

enum FSMenuInsert

Enumerator
FS_INSERT_SORTED
FS_INSERT_SAVE
FS_INSERT_FIRST	moves the item to the front of the list when its not already there
FS_INSERT_LAST	just append to preserve delivered order
FS_INSERT_NO_VALIDATE	Do not validate the link when inserted.

Definition at line 254 of file ED_fileselect.hh.

Function Documentation

◆ ED_file_change_dir()

void ED_file_change_dir ( bContext * C )

Definition at line 1190 of file filesel.cc.

References C, CTX_wm_area(), ED_file_change_dir(), and ED_file_change_dir_ex().

Referenced by bookmark_select_exec(), ED_file_change_dir(), file_directory_enter_handle(), file_directory_new_exec(), file_execute(), file_filename_enter_handle(), file_next_exec(), file_parent_exec(), file_previous_exec(), and file_select_do().

◆ ED_file_change_dir_ex()

void ED_file_change_dir_ex	(	bContext *	C,
		ScrArea *	area )

Support updating the directory even when this isn't the active space needed so RNA properties update function isn't context sensitive, see #70255.

Definition at line 1157 of file filesel.cc.

References FileSelectParams::active_file, C, CTX_wm_manager(), FileSelectParams::dir, ED_file_change_dir_ex(), ED_fileselect_clear(), ED_fileselect_get_active_params(), file_draw_check_ex(), filelist_dir(), filelist_is_dir(), filelist_setdir(), SpaceFile::files, FileSelectParams::filter_search, ListBase::first, folderlist_clear_next(), folderlist_free(), folderlist_pushdir(), SpaceFile::folders_next, SpaceFile::folders_prev, SPACE_FILE, ScrArea::spacedata, ScrArea::spacetype, STRNCPY(), and UNLIKELY.

Referenced by ED_file_change_dir(), and ED_file_change_dir_ex().

◆ ED_file_extension_icon()

int ED_file_extension_icon ( const char * path )

Definition at line 2842 of file filelist.cc.

References ED_file_extension_icon(), ED_path_extension_type(), FILE_TYPE_ALEMBIC, FILE_TYPE_ARCHIVE, FILE_TYPE_BLENDER, FILE_TYPE_BLENDER_BACKUP, FILE_TYPE_BTX, FILE_TYPE_COLLADA, FILE_TYPE_FTFONT, FILE_TYPE_IMAGE, FILE_TYPE_MOVIE, FILE_TYPE_OBJECT_IO, FILE_TYPE_PYSCRIPT, FILE_TYPE_SOUND, FILE_TYPE_TEXT, and FILE_TYPE_VOLUME.

Referenced by ED_file_extension_icon(), ghost_event_proc(), and blender::ed::outliner::tree_element_get_icon_from_id().

◆ ED_file_icon()

int ED_file_icon ( const FileDirEntry * file )

Definition at line 1348 of file filelist.cc.

References ED_file_icon(), filelist_geticon_file_type_ex(), and FileDirEntry::preview_icon_id.

Referenced by ED_file_icon().

◆ ED_file_path_button()

void ED_file_path_button	(	bScreen *	screen,
		const SpaceFile *	sfile,
		FileSelectParams *	params,
		uiBlock *	block )

Definition at line 76 of file file_draw.cc.

References autocomplete_directory(), BLI_assert, BLI_assert_msg, ED_file_path_button(), file_directory_enter_handle(), file_draw_check_cb(), FILE_MAX, filelist_lib(), SpaceFile::files, bScreen::id, RNA_pointer_create_discrete(), TIP_, UI_block_func_set(), UI_BTYPE_TEXT, UI_BUT_DISABLED, UI_but_flag_enable(), UI_but_flag_is_set(), UI_but_func_complete_set(), UI_but_funcN_set(), UI_but_is_utf8(), UI_BUT_UNDO, UI_UNIT_X, UI_UNIT_Y, and uiDefButR().

Referenced by ED_file_path_button(), and uiTemplateFileSelectPath().

◆ ED_file_read_bookmarks()

void ED_file_read_bookmarks ( )

Definition at line 1056 of file space_file.cc.

References BKE_appdir_folder_id(), BLENDER_BOOKMARK_FILE, BLENDER_USER_CONFIG, BLI_path_join, ED_file_read_bookmarks(), ED_fsmenu_get(), FILE_MAX, fsmenu_free(), fsmenu_read_bookmarks(), and fsmenu_read_system().

Referenced by ED_file_init(), ED_file_read_bookmarks(), and wm_history_file_read_exec().

◆ ED_fileselect_activate_asset_catalog()

void ED_fileselect_activate_asset_catalog	(	const SpaceFile *	sfile,
		bUUID	catalog_id )

Definition at line 503 of file filesel.cc.

References FileAssetSelectParams::asset_catalog_visibility, FileAssetSelectParams::catalog_id, ED_fileselect_activate_asset_catalog(), ED_fileselect_get_asset_params(), ED_fileselect_is_asset_browser(), FILE_SHOW_ASSETS_FROM_CATALOG, NC_SPACE, ND_SPACE_ASSET_PARAMS, and WM_main_add_notifier().

Referenced by blender::ed::asset::asset_catalog_new_exec(), and ED_fileselect_activate_asset_catalog().

◆ ED_fileselect_activate_by_id()

void ED_fileselect_activate_by_id	(	SpaceFile *	sfile,
		ID *	asset_id,
		bool	deferred )

Activate and select the file that corresponds to the given ID. Pass deferred=true to wait for the next refresh before activating.

Definition at line 557 of file filesel.cc.

References FileSelectParams::active_file, CHECK_ALL, ED_fileselect_activate_by_id(), ED_fileselect_get_active_params(), ED_fileselect_is_asset_browser(), file_on_reload_callback_register(), FILE_SEL_ADD, FILE_SEL_SELECTED, filelist_entry_select_set(), filelist_file_ex(), filelist_file_find_id(), filelist_needs_force_reset(), filelist_pending(), SpaceFile::files, NA_ACTIVATED, NA_SELECTED, NC_ASSET, on_reload_activate_by_id(), and WM_main_add_notifier().

Referenced by ED_fileselect_activate_by_id(), and on_reload_activate_by_id().

◆ ED_fileselect_activate_by_relpath()

void ED_fileselect_activate_by_relpath	(	SpaceFile *	sfile,
		const char *	relative_path )

◆ ED_fileselect_active_asset_get()

ID * ED_fileselect_active_asset_get ( const SpaceFile * sfile )

Definition at line 484 of file filesel.cc.

References FileSelectParams::active_file, ED_fileselect_active_asset_get(), ED_fileselect_get_active_params(), ED_fileselect_is_asset_browser(), filelist_file(), filelist_file_get_id(), and SpaceFile::files.

Referenced by ED_fileselect_active_asset_get(), and file_listener().

◆ ED_fileselect_active_asset_library_get()

blender::asset_system::AssetLibrary * ED_fileselect_active_asset_library_get ( const SpaceFile * sfile )

Definition at line 475 of file filesel.cc.

References ED_fileselect_active_asset_library_get(), ED_fileselect_is_asset_browser(), filelist_asset_library(), and SpaceFile::files.

Referenced by blender::ed::asset::asset_catalog_delete_exec(), blender::ed::asset::asset_catalog_new_exec(), blender::ed::asset::asset_catalog_operator_poll(), blender::ed::asset::asset_catalogs_save_exec(), ED_fileselect_active_asset_library_get(), and blender::ed::asset::get_catalog_service().

◆ ED_fileselect_asset_import_method_get()

int ED_fileselect_asset_import_method_get	(	const SpaceFile *	sfile,
		const FileDirEntry *	file )

Resolve this space's eFileAssetImportMethod to the eAssetImportMethod (note the different type) to be used for the actual import of a specific asset.

If the asset system dictates a certain import method, this will be returned.
If the Asset Browser is set to follow the Preferences (FILE_ASSET_IMPORT_FOLLOW_PREFS), the asset system determines the import method (which is the default from the Preferences). -1 is returned if the asset system doesn't specify a method (e.g. because the asset library doesn't come from the Preferences).
Otherwise, the Asset Browser determines (possibly overrides) the import method.

Returns: -1 on error, for example when FILE_ASSET_IMPORT_FOLLOW_PREFS was requested but the active asset library reference couldn't be found in the preferences.

Definition at line 515 of file filesel.cc.

References FileDirEntry::asset, ASSET_IMPORT_APPEND, ASSET_IMPORT_APPEND_REUSE, ASSET_IMPORT_LINK, BLI_assert, BLI_assert_unreachable, ED_fileselect_asset_import_method_get(), ED_fileselect_get_asset_params(), ED_fileselect_is_asset_browser(), FILE_ASSET_IMPORT_APPEND, FILE_ASSET_IMPORT_APPEND_REUSE, FILE_ASSET_IMPORT_FOLLOW_PREFS, FILE_ASSET_IMPORT_LINK, and FileAssetSelectParams::import_method.