SpaceFileBrowser(Space)

base classes — bpy_struct, Space

class bpy.types.SpaceFileBrowser(Space)

File browser space data

active_operator

(readonly)

Type:

Operator

bookmarks

User’s bookmarks (default None)

Type:

bpy_prop_collection[FileBrowserFSMenuEntry]

bookmarks_active

Index of active bookmark (-1 if none) (in [-32768, 32767], default 0)

Type:

int

browse_mode

Type of the File Editor view (regular file browsing or asset browsing) (default 'FILES')

Type:

Literal[Space File Browse Mode Items]

operator

(readonly)

Type:

Operator

params

Parameters and Settings for the Filebrowser (readonly)

Type:

FileSelectParams

recent_folders

(default None)

Type:

bpy_prop_collection[FileBrowserFSMenuEntry]

recent_folders_active

Index of active recent folder (-1 if none) (in [-32768, 32767], default 0)

Type:

int

show_region_tool_props

(default False)

Type:

bool

show_region_toolbar

(default False)

Type:

bool

show_region_ui

(default False)

Type:

bool

system_bookmarks

System’s bookmarks (default None, readonly)

Type:

bpy_prop_collection[FileBrowserFSMenuEntry]

system_bookmarks_active

Index of active system bookmark (-1 if none) (in [-32768, 32767], default 0)

Type:

int

system_folders

System’s folders (usually root, available hard drives, etc) (default None, readonly)

Type:

bpy_prop_collection[FileBrowserFSMenuEntry]

system_folders_active

Index of active system folder (-1 if none) (in [-32768, 32767], default 0)

Type:

int

activate_asset_by_id(id_to_activate, *, deferred=False)

Activate and select the asset entry that represents the given ID

Parameters:

  • id_to_activate (ID) – id_to_activate

  • deferred (bool) – Whether to activate the ID immediately (false) or after the file browser refreshes (true) (optional)

activate_file_by_relative_path(*, relative_path='')

Set active file and add to selection based on relative path to current File Browser directory

Parameters:

relative_path (str) – relative_path, (optional, never None)

deselect_all()

Deselect all files

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

classmethod draw_handler_add(callback, args, region_type, draw_type)

Add a new draw handler to this space type. It will be called every time the specified region in the space type will be drawn. Note: All arguments are positional only for now.

Parameters:

  • callback (Callable[..., Any]) – A function that will be called when the region is drawn. It gets the specified arguments as input, it’s return value is ignored.

  • args (tuple[Any, ...]) – Arguments that will be passed to the callback.

  • region_type (str) – The region type the callback draws in; usually WINDOW. (bpy.types.Region.type)

  • draw_type (str) – Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.

Returns:

Handler that can be removed later on.

Return type:

object

classmethod draw_handler_remove(handler, region_type)

Remove a draw handler that was added previously.

Parameters:

  • handler (object) – The draw handler that should be removed.

  • region_type (str) – Region type the callback was added to.

Inherited Properties

Inherited Functions