Blender V5.0
FileList Struct Reference

#include <filelist_intern.hh>

Public Attributes

FileDirEntryArr filelist
eFileSelectType type
AssetLibraryReferenceasset_library_ref
blender::asset_system::AssetLibraryasset_library
short flags
short sort
FileListFilter filter_data
const FileIndexerTypeindexer
FileListIntern filelist_intern
FileListEntryCachefilelist_cache
GHashselection_state
short max_recursion
short recursion_level
BlendHandle * libfiledata
bool(* check_dir_fn )(const FileList *filelist, char dirpath[FILE_MAX_LIBEXTRA], const bool do_change)
void(* read_job_fn )(FileListReadJob *job_params, bool *stop, bool *do_update, float *progress)
bool(* filter_fn )(FileListInternEntry *file, const char *root, FileListFilter *filter)
void(* prepare_filter_fn )(const FileList *filelist, FileListFilter *filter)
short tags

Detailed Description

Definition at line 195 of file filelist_intern.hh.

Member Data Documentation

◆ asset_library

◆ asset_library_ref

◆ check_dir_fn

bool(* FileList::check_dir_fn) (const FileList *filelist, char dirpath[FILE_MAX_LIBEXTRA], const bool do_change)

Set given path as root directory.

Parameters
do_changeWhen true, the callback may change given string in place to a valid value.
Returns
True when dirpath is valid.

Definition at line 241 of file filelist_intern.hh.

Referenced by filelist_is_dir(), filelist_setdir(), and filelist_settype().

◆ filelist

◆ filelist_cache

◆ filelist_intern

◆ filter_data

◆ filter_fn

bool(* FileList::filter_fn) (FileListInternEntry *file, const char *root, FileListFilter *filter)

Filter an entry of current filelist.

Definition at line 249 of file filelist_intern.hh.

Referenced by filelist_filter(), and filelist_settype().

◆ flags

◆ indexer

const FileIndexerType* FileList::indexer

File indexer to use. Attribute is always set.

Definition at line 212 of file filelist_intern.hh.

Referenced by filelist_readjob_recursive_dir_add_items(), filelist_setindexer(), and filelist_settype().

◆ libfiledata

BlendHandle* FileList::libfiledata

Definition at line 233 of file filelist_intern.hh.

Referenced by filelist_freelib(), filelist_lib(), and filelist_readjob_startjob().

◆ max_recursion

short FileList::max_recursion

◆ prepare_filter_fn

void(* FileList::prepare_filter_fn) (const FileList *filelist, FileListFilter *filter)

Executed before filtering individual items, to set up additional filter data.

Definition at line 251 of file filelist_intern.hh.

Referenced by filelist_filter(), and filelist_settype().

◆ read_job_fn

void(* FileList::read_job_fn) (FileListReadJob *job_params, bool *stop, bool *do_update, float *progress)

Fill filelist (to be called by read job).

Definition at line 246 of file filelist_intern.hh.

Referenced by filelist_readjob_startjob(), and filelist_settype().

◆ recursion_level

short FileList::recursion_level

Definition at line 231 of file filelist_intern.hh.

◆ selection_state

GHash* FileList::selection_state

We need to keep those info outside of actual file-list items, because those are no more persistent (only generated on demand, and freed as soon as possible). Persistent part (mere list of paths + stat info) is kept as small as possible, and file-browser agnostic.

Definition at line 228 of file filelist_intern.hh.

Referenced by filelist_clear_ex(), filelist_clear_main_files(), filelist_entry_is_selected(), filelist_entry_select_get(), filelist_entry_select_set(), filelist_free(), filelist_new(), and filelist_readjob_startjob().

◆ sort

short FileList::sort

Definition at line 205 of file filelist_intern.hh.

Referenced by filelist_setsorting(), and filelist_sort().

◆ tags

◆ type

eFileSelectType FileList::type

Definition at line 198 of file filelist_intern.hh.

Referenced by filelist_settype().


The documentation for this struct was generated from the following file: