FileSelectParams(bpy_struct)

base class — bpy_struct

class bpy.types.FileSelectParams.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_VERTICAL Vertical List, Display files as a vertical list.

  • LIST_HORIZONTAL Horizontal List, Display files as a horizontal list.

  • THUMBNAIL Thumbnails, Display files as thumbnails.

Type

enum in [‘LIST_VERTICAL’, ‘LIST_HORIZONTAL’, ‘THUMBNAIL’], default ‘LIST_VERTICAL’

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

Type

FileSelectIDFilter, (readonly, never None)

filter_search

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_details_datetime

Draw a column listing the date and time of modification for each file

Type

boolean, default False

show_details_size

Draw a column listing the size of each file

Type

boolean, default False

show_hidden

Show hidden dot files

Type

boolean, default False

sort_method
  • FILE_SORT_ALPHA Name, Sort the file list alphabetically.

  • FILE_SORT_EXTENSION Extension, Sort the file list by extension/type.

  • FILE_SORT_TIME Modified Date, Sort files by modification time.

  • FILE_SORT_SIZE 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_filter_volume

Show 3D volume files

Type

boolean, default False

use_library_browsing

Whether we may browse blender files’ content or not

Type

boolean, default False, (readonly)

use_sort_invert

Sort items descending, from highest value to lowest

Type

boolean, default False

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

  • bpy_struct.id_data

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • bpy_struct.is_property_set

  • bpy_struct.items

  • bpy_struct.keyframe_delete

  • bpy_struct.keyframe_insert

  • bpy_struct.keys

  • bpy_struct.path_from_id

  • bpy_struct.path_resolve

  • bpy_struct.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

References

  • SpaceFileBrowser.params

  • UILayout.template_file_select_path