Blender  V2.93
Typedefs | Enumerations | Functions
filelist.h File Reference

Go to the source code of this file.

Typedefs

typedef enum FileSelType FileSelType
 
typedef enum FileCheckType FileCheckType
 

Enumerations

enum  FileSelType { FILE_SEL_REMOVE = 0 , FILE_SEL_ADD = 1 , FILE_SEL_TOGGLE = 2 }
 
enum  FileCheckType { CHECK_DIRS = 1 , CHECK_FILES = 2 , CHECK_ALL = 3 }
 

Functions

void folderlist_free (struct ListBase *folderlist)
 
void folderlist_popdir (struct ListBase *folderlist, char *dir)
 
void folderlist_pushdir (struct ListBase *folderlist, const char *dir)
 
const char * folderlist_peeklastdir (struct ListBase *folderlist)
 
int folderlist_clear_next (struct SpaceFile *sfile)
 
void folder_history_list_ensure_for_active_browse_mode (struct SpaceFile *sfile)
 
void folder_history_list_free (struct SpaceFile *sfile)
 
struct ListBase folder_history_list_duplicate (struct ListBase *listbase)
 
void filelist_setsorting (struct FileList *filelist, const short sort, bool invert_sort)
 
void filelist_sort (struct FileList *filelist)
 
void filelist_setfilter_options (struct FileList *filelist, const bool do_filter, const bool hide_dot, const bool hide_parent, const uint64_t filter, const uint64_t filter_id, const bool filter_assets_only, const char *filter_glob, const char *filter_search)
 
void filelist_filter (struct FileList *filelist)
 
void filelist_setlibrary (struct FileList *filelist, const struct FileSelectAssetLibraryUID *asset_library)
 
void filelist_init_icons (void)
 
void filelist_free_icons (void)
 
struct ImBuffilelist_getimage (struct FileList *filelist, const int index)
 
struct ImBuffilelist_file_getimage (const FileDirEntry *file)
 
struct ImBuffilelist_geticon_image (struct FileList *filelist, const int index)
 
int filelist_geticon (struct FileList *filelist, const int index, const bool is_main)
 
struct FileListfilelist_new (short type)
 
void filelist_settype (struct FileList *filelist, short type)
 
void filelist_clear (struct FileList *filelist)
 
void filelist_clear_ex (struct FileList *filelist, const bool do_cache, const bool do_selection)
 
void filelist_free (struct FileList *filelist)
 
const char * filelist_dir (struct FileList *filelist)
 
bool filelist_is_dir (struct FileList *filelist, const char *path)
 
void filelist_setdir (struct FileList *filelist, char *r_dir)
 
int filelist_files_ensure (struct FileList *filelist)
 
int filelist_needs_reading (struct FileList *filelist)
 
FileDirEntryfilelist_file (struct FileList *filelist, int index)
 
FileDirEntryfilelist_file_ex (struct FileList *filelist, int index, bool use_request)
 
int filelist_file_findpath (struct FileList *filelist, const char *file)
 
struct IDfilelist_file_get_id (const struct FileDirEntry *file)
 
FileDirEntryfilelist_entry_find_uuid (struct FileList *filelist, const int uuid[4])
 
void filelist_file_cache_slidingwindow_set (struct FileList *filelist, size_t window_size)
 
bool filelist_file_cache_block (struct FileList *filelist, const int index)
 
bool filelist_needs_force_reset (struct FileList *filelist)
 
void filelist_tag_force_reset (struct FileList *filelist)
 
bool filelist_pending (struct FileList *filelist)
 
bool filelist_needs_reset_on_main_changes (const struct FileList *filelist)
 
bool filelist_is_ready (struct FileList *filelist)
 
unsigned int filelist_entry_select_set (const struct FileList *filelist, const struct FileDirEntry *entry, FileSelType select, unsigned int flag, FileCheckType check)
 
void filelist_entry_select_index_set (struct FileList *filelist, const int index, FileSelType select, unsigned int flag, FileCheckType check)
 
void filelist_entries_select_index_range_set (struct FileList *filelist, FileSelection *sel, FileSelType select, unsigned int flag, FileCheckType check)
 
unsigned int filelist_entry_select_get (struct FileList *filelist, struct FileDirEntry *entry, FileCheckType check)
 
unsigned int filelist_entry_select_index_get (struct FileList *filelist, const int index, FileCheckType check)
 
bool filelist_entry_is_selected (struct FileList *filelist, const int index)
 
void filelist_entry_parent_select_set (struct FileList *filelist, FileSelType select, unsigned int flag, FileCheckType check)
 
void filelist_setrecursion (struct FileList *filelist, const int recursion_level)
 
struct BlendHandlefilelist_lib (struct FileList *filelist)
 
bool filelist_islibrary (struct FileList *filelist, char *dir, char **r_group)
 
void filelist_freelib (struct FileList *filelist)
 
void filelist_readjob_start (struct FileList *filelist, const struct bContext *C)
 
void filelist_readjob_stop (struct wmWindowManager *wm, struct Scene *owner_scene)
 
int filelist_readjob_running (struct wmWindowManager *wm, struct Scene *owner_scene)
 
bool filelist_cache_previews_update (struct FileList *filelist)
 
void filelist_cache_previews_set (struct FileList *filelist, const bool use_previews)
 
bool filelist_cache_previews_running (struct FileList *filelist)
 

Typedef Documentation

◆ FileCheckType

◆ FileSelType

typedef enum FileSelType FileSelType

Enumeration Type Documentation

◆ FileCheckType

Enumerator
CHECK_DIRS 
CHECK_FILES 
CHECK_ALL 

Definition at line 44 of file filelist.h.

◆ FileSelType

Enumerator
FILE_SEL_REMOVE 
FILE_SEL_ADD 
FILE_SEL_TOGGLE 

Definition at line 38 of file filelist.h.

Function Documentation

◆ filelist_cache_previews_running()

bool filelist_cache_previews_running ( struct FileList filelist)

Definition at line 2461 of file filelist.c.

References FileList::filelist_cache, NULL, and FileListEntryCache::previews_pool.

Referenced by file_draw_list().

◆ filelist_cache_previews_set()

void filelist_cache_previews_set ( struct FileList filelist,
const bool  use_previews 
)

◆ filelist_cache_previews_update()

bool filelist_cache_previews_update ( struct FileList filelist)

◆ filelist_clear()

void filelist_clear ( struct FileList filelist)

Definition at line 1791 of file filelist.c.

References filelist_clear_ex().

Referenced by ED_fileselect_clear(), and file_refresh().

◆ filelist_clear_ex()

void filelist_clear_ex ( struct FileList filelist,
const bool  do_cache,
const bool  do_selection 
)

◆ filelist_dir()

const char* filelist_dir ( struct FileList filelist)

Definition at line 1863 of file filelist.c.

References FileList::filelist, and FileDirEntryArr::root.

Referenced by ED_file_change_dir_ex(), and file_draw_list().

◆ filelist_entries_select_index_range_set()

void filelist_entries_select_index_range_set ( struct FileList filelist,
FileSelection sel,
FileSelType  select,
unsigned int  flag,
FileCheckType  check 
)

◆ filelist_entry_find_uuid()

FileDirEntry* filelist_entry_find_uuid ( struct FileList filelist,
const int  uuid[4] 
)

◆ filelist_entry_is_selected()

bool filelist_entry_is_selected ( struct FileList filelist,
const int  index 
)

◆ filelist_entry_parent_select_set()

void filelist_entry_parent_select_set ( FileList filelist,
FileSelType  select,
uint  flag,
FileCheckType  check 
)

Set selection of the '..' parent entry, but only if it's actually visible.

Definition at line 2720 of file filelist.c.

References filelist_entry_select_index_set(), FileList::filter_data, FileListFilter::flags, FLF_HIDE_PARENT, and select().

Referenced by file_box_select_exec(), file_select_invoke(), and file_walk_select_selection_set().

◆ filelist_entry_select_get()

unsigned int filelist_entry_select_get ( struct FileList filelist,
struct FileDirEntry entry,
FileCheckType  check 
)

◆ filelist_entry_select_index_get()

unsigned int filelist_entry_select_index_get ( struct FileList filelist,
const int  index,
FileCheckType  check 
)

◆ filelist_entry_select_index_set()

void filelist_entry_select_index_set ( struct FileList filelist,
const int  index,
FileSelType  select,
unsigned int  flag,
FileCheckType  check 
)

◆ filelist_entry_select_set()

unsigned int filelist_entry_select_set ( const struct FileList filelist,
const struct FileDirEntry entry,
FileSelType  select,
unsigned int  flag,
FileCheckType  check 
)

◆ filelist_file()

FileDirEntry* filelist_file ( struct FileList filelist,
int  index 
)

◆ filelist_file_cache_block()

bool filelist_file_cache_block ( struct FileList filelist,
const int  index 
)

◆ filelist_file_cache_slidingwindow_set()

void filelist_file_cache_slidingwindow_set ( struct FileList filelist,
size_t  window_size 
)

◆ filelist_file_ex()

FileDirEntry* filelist_file_ex ( struct FileList filelist,
int  index,
bool  use_request 
)

◆ filelist_file_findpath()

int filelist_file_findpath ( struct FileList filelist,
const char *  file 
)

◆ filelist_file_get_id()

struct ID* filelist_file_get_id ( const struct FileDirEntry file)

◆ filelist_file_getimage()

struct ImBuf* filelist_file_getimage ( const FileDirEntry file)

Definition at line 1152 of file filelist.c.

References BKE_icon_imbuf_get_buffer(), file, and NULL.

Referenced by file_draw_icon().

◆ filelist_files_ensure()

int filelist_files_ensure ( FileList filelist)

◆ filelist_filter()

void filelist_filter ( struct FileList filelist)

◆ filelist_free()

void filelist_free ( struct FileList filelist)

◆ filelist_free_icons()

void filelist_free_icons ( void  )

Definition at line 1128 of file filelist.c.

References BLI_assert, G, gSpecialFileImages, IMB_freeImBuf(), NULL, and SPECIAL_IMG_MAX.

Referenced by ED_file_exit().

◆ filelist_freelib()

void filelist_freelib ( struct FileList filelist)

◆ filelist_geticon()

int filelist_geticon ( struct FileList filelist,
const int  index,
const bool  is_main 
)

◆ filelist_geticon_image()

struct ImBuf* filelist_geticon_image ( struct FileList filelist,
const int  index 
)

Definition at line 1176 of file filelist.c.

References file, filelist_geticon_get_file(), and filelist_geticon_image_ex().

Referenced by file_draw_list().

◆ filelist_getimage()

struct ImBuf* filelist_getimage ( struct FileList filelist,
const int  index 
)

Definition at line 1145 of file filelist.c.

References BKE_icon_imbuf_get_buffer(), file, filelist_geticon_get_file(), and NULL.

Referenced by file_draw_list().

◆ filelist_init_icons()

void filelist_init_icons ( void  )

◆ filelist_is_dir()

bool filelist_is_dir ( struct FileList filelist,
const char *  path 
)

◆ filelist_is_ready()

bool filelist_is_ready ( struct FileList filelist)

Definition at line 1910 of file filelist.c.

References FL_IS_READY, and FileList::flags.

Referenced by file_params_renamefile_activate(), and file_smoothscroll_invoke().

◆ filelist_islibrary()

bool filelist_islibrary ( struct FileList filelist,
char *  dir,
char **  r_group 
)

◆ filelist_lib()

struct BlendHandle* filelist_lib ( struct FileList filelist)

Definition at line 1827 of file filelist.c.

References FileList::libfiledata.

Referenced by ED_file_path_button().

◆ filelist_needs_force_reset()

bool filelist_needs_force_reset ( struct FileList filelist)

Definition at line 1900 of file filelist.c.

References FL_FORCE_RESET, and FileList::flags.

Referenced by ED_fileselect_activate_by_id(), file_refresh(), and filelist_files_ensure().

◆ filelist_needs_reading()

int filelist_needs_reading ( struct FileList filelist)

◆ filelist_needs_reset_on_main_changes()

bool filelist_needs_reset_on_main_changes ( const struct FileList filelist)

◆ filelist_new()

struct FileList* filelist_new ( short  type)

◆ filelist_pending()

bool filelist_pending ( struct FileList filelist)

Definition at line 1915 of file filelist.c.

References FL_IS_PENDING, and FileList::flags.

Referenced by ED_fileselect_activate_by_id(), and file_refresh().

◆ filelist_readjob_running()

int filelist_readjob_running ( struct wmWindowManager wm,
struct Scene owner_scene 
)

Definition at line 3505 of file filelist.c.

References WM_JOB_TYPE_FILESEL_READDIR, and WM_jobs_test().

◆ filelist_readjob_start()

void filelist_readjob_start ( struct FileList filelist,
const struct bContext C 
)

◆ filelist_readjob_stop()

void filelist_readjob_stop ( struct wmWindowManager wm,
struct Scene owner_scene 
)

Definition at line 3500 of file filelist.c.

References WM_JOB_TYPE_FILESEL_READDIR, and WM_jobs_kill_type().

Referenced by ED_fileselect_clear(), and file_refresh().

◆ filelist_setdir()

void filelist_setdir ( struct FileList filelist,
char *  r_dir 
)

◆ filelist_setfilter_options()

void filelist_setfilter_options ( struct FileList filelist,
const bool  do_filter,
const bool  hide_dot,
const bool  hide_parent,
const uint64_t  filter,
const uint64_t  filter_id,
const bool  filter_assets_only,
const char *  filter_glob,
const char *  filter_search 
)

◆ filelist_setlibrary()

void filelist_setlibrary ( struct FileList filelist,
const struct FileSelectAssetLibraryUID asset_library 
)

◆ filelist_setrecursion()

void filelist_setrecursion ( struct FileList filelist,
const int  recursion_level 
)

Definition at line 1892 of file filelist.c.

References FL_FORCE_RESET, FileList::flags, and FileList::max_recursion.

Referenced by file_parent_exec(), file_refresh(), and file_select_do().

◆ filelist_setsorting()

void filelist_setsorting ( struct FileList filelist,
const short  sort,
bool  invert_sort 
)

Definition at line 728 of file filelist.c.

References FL_NEED_SORTING, FL_SORT_INVERT, FileList::flags, sort(), and FileList::sort.

Referenced by file_refresh().

◆ filelist_settype()

void filelist_settype ( struct FileList filelist,
short  type 
)

◆ filelist_sort()

void filelist_sort ( struct FileList filelist)

◆ filelist_tag_force_reset()

void filelist_tag_force_reset ( struct FileList filelist)

Definition at line 1905 of file filelist.c.

References FL_FORCE_RESET, and FileList::flags.

Referenced by file_refresh(), and file_tag_reset_list().

◆ folder_history_list_duplicate()

struct ListBase folder_history_list_duplicate ( struct ListBase listbase)

◆ folder_history_list_ensure_for_active_browse_mode()

void folder_history_list_ensure_for_active_browse_mode ( struct SpaceFile sfile)

◆ folder_history_list_free()

void folder_history_list_free ( struct SpaceFile sfile)

◆ folderlist_clear_next()

int folderlist_clear_next ( struct SpaceFile sfile)

◆ folderlist_free()

void folderlist_free ( struct ListBase folderlist)

◆ folderlist_peeklastdir()

const char* folderlist_peeklastdir ( struct ListBase folderlist)

Definition at line 143 of file filelist.c.

References FolderList::foldername, ListBase::last, and NULL.

Referenced by file_directory_enter_handle().

◆ folderlist_popdir()

void folderlist_popdir ( struct ListBase folderlist,
char *  dir 
)

◆ folderlist_pushdir()

void folderlist_pushdir ( struct ListBase folderlist,
const char *  dir 
)