FileSelectParams(bpy_struct)

base class — bpy_struct

class bpy.types.FileSelectParams(bpy_struct)

File Select Parameters

directory

Directory displayed in the file browser

Type:string, default “”, (never None)
display_size

Change the size of the display (width of columns or thumbnails size)

Type:enum in [‘TINY’, ‘SMALL’, ‘NORMAL’, ‘LARGE’], default ‘TINY’
display_type

Display mode for the file list

  • LIST_SHORT Short List, Display files as short list.
  • LIST_LONG Long List, Display files as a detailed list.
  • THUMBNAIL Thumbnails, Display files as thumbnails.
Type:enum in [‘LIST_SHORT’, ‘LIST_LONG’, ‘THUMBNAIL’], default ‘LIST_SHORT’
filename

Active file in the file browser

Type:string, default “”, (never None)
filter_glob

UNIX shell-like filename patterns matching, supports wildcards (‘*’) and list of patterns separated by ‘;’

Type:string, default “”, (never None)
filter_id

Which ID types to show/hide, when browsing a library

  • ACTION Actions, Show/hide Action data-blocks.
  • ARMATURE Armatures, Show/hide Armature data-blocks.
  • BRUSH Brushes, Show/hide Brushes data-blocks.
  • CAMERA Cameras, Show/hide Camera data-blocks.
  • CACHEFILE Cache Files, Show/hide Cache File data-blocks.
  • CURVE Curves, Show/hide Curve data-blocks.
  • GREASE_PENCIL Grease Pencil, Show/hide Grease pencil data-blocks.
  • GROUP Collections, Show/hide Collection data-blocks.
  • IMAGE Images, Show/hide Image data-blocks.
  • LIGHT Lights, Show/hide Light data-blocks.
  • LINESTYLE Freestyle Linestyles, Show/hide Freestyle’s Line Style data-blocks.
  • LATTICE Lattices, Show/hide Lattice data-blocks.
  • MATERIAL Materials, Show/hide Material data-blocks.
  • METABALL Metaballs, Show/hide Metaball data-blocks.
  • MOVIE_CLIP Movie Clips, Show/hide Movie Clip data-blocks.
  • MESH Meshes, Show/hide Mesh data-blocks.
  • MASK Masks, Show/hide Mask data-blocks.
  • NODE_TREE Node Trees, Show/hide Node Tree data-blocks.
  • OBJECT Objects, Show/hide Object data-blocks.
  • PARTICLE_SETTINGS Particles Settings, Show/hide Particle Settings data-blocks.
  • PALETTE Palettes, Show/hide Palette data-blocks.
  • PAINT_CURVE Paint Curves, Show/hide Paint Curve data-blocks.
  • LIGHT_PROBE Light Probes, Show/hide Light Probe data-blocks.
  • SCENE Scenes, Show/hide Scene data-blocks.
  • SPEAKER Speakers, Show/hide Speaker data-blocks.
  • SOUND Sounds, Show/hide Sound data-blocks.
  • TEXTURE Textures, Show/hide Texture data-blocks.
  • TEXT Texts, Show/hide Text data-blocks.
  • FONT Fonts, Show/hide Font data-blocks.
  • WORLD Worlds, Show/hide World data-blocks.
  • WORK_SPACE Workspaces, Show/hide workspace data-blocks.
Type:enum set in {‘ACTION’, ‘ARMATURE’, ‘BRUSH’, ‘CAMERA’, ‘CACHEFILE’, ‘CURVE’, ‘GREASE_PENCIL’, ‘GROUP’, ‘IMAGE’, ‘LIGHT’, ‘LINESTYLE’, ‘LATTICE’, ‘MATERIAL’, ‘METABALL’, ‘MOVIE_CLIP’, ‘MESH’, ‘MASK’, ‘NODE_TREE’, ‘OBJECT’, ‘PARTICLE_SETTINGS’, ‘PALETTE’, ‘PAINT_CURVE’, ‘LIGHT_PROBE’, ‘SCENE’, ‘SPEAKER’, ‘SOUND’, ‘TEXTURE’, ‘TEXT’, ‘FONT’, ‘WORLD’, ‘WORK_SPACE’}, default {‘ACTION’}
filter_id_category

Which ID categories to show/hide, when browsing a library

  • SCENE Scenes, Show/hide scenes.
  • ANIMATION Animations, Show/hide animation data.
  • OBJECT Objects & Collections, Show/hide objects and groups.
  • GEOMETRY Geometry, Show/hide meshes, curves, lattice, armatures and metaballs data.
  • SHADING Shading, Show/hide materials, nodetrees, textures and Freestyle’s linestyles.
  • IMAGE Images & Sounds, Show/hide images, movie clips, sounds and masks.
  • ENVIRONMENT Environment, Show/hide worlds, lights, cameras and speakers.
  • MISC Miscellaneous, Show/hide other data types.
Type:enum set in {‘SCENE’, ‘ANIMATION’, ‘OBJECT’, ‘GEOMETRY’, ‘SHADING’, ‘IMAGE’, ‘ENVIRONMENT’, ‘MISC’}, default {‘SCENE’}

Filter by name, supports ‘*’ wildcard

Type:string, default “”, (never None)
recursion_level

Numbers of dirtree levels to show simultaneously

  • NONE None, Only list current directory’s content, with no recursion.
  • BLEND Blend File, List .blend files’ content.
  • ALL_1 One Level, List all sub-directories’ content, one level of recursion.
  • ALL_2 Two Levels, List all sub-directories’ content, two levels of recursion.
  • ALL_3 Three Levels, List all sub-directories’ content, three levels of recursion.
Type:enum in [‘NONE’, ‘BLEND’, ‘ALL_1’, ‘ALL_2’, ‘ALL_3’], default ‘NONE’
show_hidden

Show hidden dot files

Type:boolean, default False
sort_method
  • FILE_SORT_ALPHA Sort alphabetically, Sort the file list alphabetically.
  • FILE_SORT_EXTENSION Sort by extension, Sort the file list by extension/type.
  • FILE_SORT_TIME Sort by time, Sort files by modification time.
  • FILE_SORT_SIZE Sort by size, Sort files by size.
Type:enum in [‘FILE_SORT_ALPHA’, ‘FILE_SORT_EXTENSION’, ‘FILE_SORT_TIME’, ‘FILE_SORT_SIZE’], default ‘FILE_SORT_ALPHA’
title

Title for the file browser

Type:string, default “”, (readonly, never None)
use_filter

Enable filtering of files

Type:boolean, default False
use_filter_backup

Show .blend1, .blend2, etc. files

Type:boolean, default False
use_filter_blender

Show .blend files

Type:boolean, default False
use_filter_blendid

Show .blend files items (objects, materials, etc.)

Type:boolean, default False
use_filter_folder

Show folders

Type:boolean, default False
use_filter_font

Show font files

Type:boolean, default False
use_filter_image

Show image files

Type:boolean, default False
use_filter_movie

Show movie files

Type:boolean, default False
use_filter_script

Show script files

Type:boolean, default False
use_filter_sound

Show sound files

Type:boolean, default False
use_filter_text

Show text files

Type:boolean, default False
use_library_browsing

Whether we may browse blender files’ content or not

Type:boolean, default False, (readonly)
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

Inherited Properties

Inherited Functions

References