SpaceFileBrowser(Space)

base classes — bpy_struct, Space

class bpy.types.SpaceFileBrowser(Space)

File browser space data

active_operator
Type:Operator, (readonly)
bookmarks

User’s bookmarks

Type:bpy_prop_collection of FileBrowserFSMenuEntry, (readonly)
bookmarks_active

Index of active bookmark (-1 if none)

Type:int in [-32768, 32767], default -1
operator
Type:Operator, (readonly)
params

Parameters and Settings for the Filebrowser

Type:FileSelectParams, (readonly)
recent_folders
Type:bpy_prop_collection of FileBrowserFSMenuEntry, (readonly)
recent_folders_active

Index of active recent folder (-1 if none)

Type:int in [-32768, 32767], default -1
show_region_toolbar
Type:boolean, default False
show_region_ui
Type:boolean, default False
system_bookmarks

System’s bookmarks

Type:bpy_prop_collection of FileBrowserFSMenuEntry, (readonly)
system_bookmarks_active

Index of active system bookmark (-1 if none)

Type:int in [-32768, 32767], default -1
system_folders

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

Type:bpy_prop_collection of FileBrowserFSMenuEntry, (readonly)
system_folders_active

Index of active system folder (-1 if none)

Type:int in [-32768, 32767], default -1
classmethod bl_rna_get_subclass(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The RNA type or default when not found.
Return type:bpy.types.Struct subclass
classmethod bl_rna_get_subclass_py(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The class or default when not found.
Return type:type
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 (function) – A function that will be called when the region is drawn. It gets the specified arguments as input.
  • args (tuple) – 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
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