Blender  V2.93
Classes | Macros | Typedefs | Enumerations | Functions
ED_fileselect.h File Reference

Go to the source code of this file.

Classes

struct  FileAttributeColumn
 
struct  FileLayout
 
struct  FileSelection
 
struct  FSMenuEntry
 

Macros

#define FILE_LAYOUT_HOR   1
 
#define FILE_LAYOUT_VER   2
 

Typedefs

typedef enum FileAttributeColumnType FileAttributeColumnType
 
typedef struct FileAttributeColumn FileAttributeColumn
 
typedef struct FileLayout FileLayout
 
typedef struct FileSelection FileSelection
 
typedef struct FSMenuEntry FSMenuEntry
 
typedef enum FSMenuCategory FSMenuCategory
 
typedef enum FSMenuInsert FSMenuInsert
 

Enumerations

enum  FileAttributeColumnType {
  COLUMN_NONE = -1 , COLUMN_NAME = 0 , COLUMN_DATETIME , COLUMN_SIZE ,
  ATTRIBUTE_COLUMN_MAX
}
 
enum  FSMenuCategory {
  FS_CATEGORY_SYSTEM , FS_CATEGORY_SYSTEM_BOOKMARKS , FS_CATEGORY_BOOKMARKS , FS_CATEGORY_RECENT ,
  FS_CATEGORY_OTHER
}
 
enum  FSMenuInsert { FS_INSERT_SORTED = (1 << 0) , FS_INSERT_SAVE = (1 << 1) , FS_INSERT_FIRST = (1 << 2) , FS_INSERT_LAST = (1 << 3) }
 

Functions

struct FileSelectParams * ED_fileselect_ensure_active_params (struct SpaceFile *sfile)
 
struct FileSelectParams * ED_fileselect_get_active_params (const struct SpaceFile *sfile)
 
struct FileSelectParams * ED_fileselect_get_file_params (const struct SpaceFile *sfile)
 
struct FileAssetSelectParams * ED_fileselect_get_asset_params (const struct SpaceFile *sfile)
 
void ED_fileselect_set_params_from_userdef (struct SpaceFile *sfile)
 
void ED_fileselect_params_to_userdef (struct SpaceFile *sfile, const int temp_win_size[], const bool is_maximized)
 
void ED_fileselect_init_layout (struct SpaceFile *sfile, struct ARegion *region)
 
FileLayout * ED_fileselect_get_layout (struct SpaceFile *sfile, struct ARegion *region)
 
int ED_fileselect_layout_numfiles (FileLayout *layout, struct ARegion *region)
 
int ED_fileselect_layout_offset (FileLayout *layout, int x, int y)
 
FileSelection ED_fileselect_layout_offset_rect (FileLayout *layout, const struct rcti *rect)
 
void ED_fileselect_layout_maskrect (const FileLayout *layout, const struct View2D *v2d, struct rcti *r_rect)
 
bool ED_fileselect_layout_is_inside_pt (const FileLayout *layout, const struct View2D *v2d, int x, int y)
 
bool ED_fileselect_layout_isect_rect (const FileLayout *layout, const struct View2D *v2d, const struct rcti *rect, struct rcti *r_dst)
 
void ED_fileselect_layout_tilepos (FileLayout *layout, int tile, int *x, int *y)
 
void ED_operatormacros_file (void)
 
void ED_fileselect_clear (struct wmWindowManager *wm, struct Scene *owner_scene, struct SpaceFile *sfile)
 
void ED_fileselect_exit (struct wmWindowManager *wm, struct Scene *owner_scene, struct SpaceFile *sfile)
 
bool ED_fileselect_is_asset_browser (const struct SpaceFile *sfile)
 
struct ID * ED_fileselect_active_asset_get (const struct SpaceFile *sfile)
 
void ED_fileselect_activate_by_id (struct SpaceFile *sfile, struct ID *asset_id, const bool deferred)
 
void ED_fileselect_window_params_get (const struct wmWindow *win, int win_size[2], bool *is_maximized)
 
struct ScrArea * ED_fileselect_handler_area_find (const struct wmWindow *win, const struct wmOperator *file_operator)
 
int ED_path_extension_type (const char *path)
 
int ED_file_extension_icon (const char *path)
 
int ED_file_icon (const struct FileDirEntry *file)
 
void ED_file_read_bookmarks (void)
 
void ED_file_change_dir_ex (struct bContext *C, struct bScreen *screen, struct ScrArea *area)
 
void ED_file_change_dir (struct bContext *C)
 
void ED_file_path_button (struct bScreen *screen, const struct SpaceFile *sfile, struct FileSelectParams *params, struct uiBlock *block)
 
struct FSMenu * ED_fsmenu_get (void)
 
struct FSMenuEntry * ED_fsmenu_get_category (struct FSMenu *fsmenu, FSMenuCategory category)
 
void ED_fsmenu_set_category (struct FSMenu *fsmenu, FSMenuCategory category, struct FSMenuEntry *fsm_head)
 
int ED_fsmenu_get_nentries (struct FSMenu *fsmenu, FSMenuCategory category)
 
struct FSMenuEntry * ED_fsmenu_get_entry (struct FSMenu *fsmenu, FSMenuCategory category, int idx)
 
char * ED_fsmenu_entry_get_path (struct FSMenuEntry *fsentry)
 
void ED_fsmenu_entry_set_path (struct FSMenuEntry *fsentry, const char *path)
 
char * ED_fsmenu_entry_get_name (struct FSMenuEntry *fsentry)
 
void ED_fsmenu_entry_set_name (struct FSMenuEntry *fsentry, const char *name)
 
int ED_fsmenu_entry_get_icon (struct FSMenuEntry *fsentry)
 
void ED_fsmenu_entry_set_icon (struct FSMenuEntry *fsentry, const int icon)
 

Macro Definition Documentation

◆ FILE_LAYOUT_HOR

#define FILE_LAYOUT_HOR   1

Definition at line 44 of file ED_fileselect.h.

◆ FILE_LAYOUT_VER

#define FILE_LAYOUT_VER   2

Definition at line 45 of file ED_fileselect.h.

Typedef Documentation

◆ FileAttributeColumn

◆ FileAttributeColumnType

◆ FileLayout

typedef struct FileLayout FileLayout

◆ FileSelection

typedef struct FileSelection FileSelection

◆ FSMenuCategory

◆ FSMenuEntry

typedef struct FSMenuEntry FSMenuEntry

◆ FSMenuInsert

typedef enum FSMenuInsert FSMenuInsert

Enumeration Type Documentation

◆ FileAttributeColumnType

Enumerator
COLUMN_NONE 
COLUMN_NAME 
COLUMN_DATETIME 
COLUMN_SIZE 
ATTRIBUTE_COLUMN_MAX 

Definition at line 47 of file ED_fileselect.h.

◆ FSMenuCategory

Enumerator
FS_CATEGORY_SYSTEM 
FS_CATEGORY_SYSTEM_BOOKMARKS 
FS_CATEGORY_BOOKMARKS 
FS_CATEGORY_RECENT 
FS_CATEGORY_OTHER 

Definition at line 190 of file ED_fileselect.h.

◆ FSMenuInsert

Enumerator
FS_INSERT_SORTED 
FS_INSERT_SAVE 
FS_INSERT_FIRST 

moves the item to the front of the list when its not already there

FS_INSERT_LAST 

just append to preserve delivered order

Definition at line 199 of file ED_fileselect.h.

Function Documentation

◆ ED_file_change_dir()

void ED_file_change_dir ( struct bContext *  C)

◆ ED_file_change_dir_ex()

void ED_file_change_dir_ex ( bContext *  C,
bScreen *  screen,
ScrArea *  area 
)

◆ ED_file_extension_icon()

int ED_file_extension_icon ( const char *  path)

◆ ED_file_icon()

int ED_file_icon ( const struct FileDirEntry *  file)

◆ ED_file_path_button()

void ED_file_path_button ( struct bScreen *  screen,
const struct SpaceFile *  sfile,
struct FileSelectParams *  params,
struct uiBlock *  block 
)

◆ ED_file_read_bookmarks()

void ED_file_read_bookmarks ( void  )

◆ ED_fileselect_activate_by_id()

void ED_fileselect_activate_by_id ( struct SpaceFile *  sfile,
struct ID *  asset_id,
const bool  deferred 
)

◆ ED_fileselect_active_asset_get()

struct ID* ED_fileselect_active_asset_get ( const struct SpaceFile *  sfile)

◆ ED_fileselect_clear()

void ED_fileselect_clear ( struct wmWindowManager *  wm,
struct Scene *  owner_scene,
struct SpaceFile *  sfile 
)

◆ ED_fileselect_ensure_active_params()

struct FileSelectParams* ED_fileselect_ensure_active_params ( SpaceFile *  sfile)

◆ ED_fileselect_exit()

void ED_fileselect_exit ( struct wmWindowManager *  wm,
struct Scene *  owner_scene,
struct SpaceFile *  sfile 
)

◆ ED_fileselect_get_active_params()

struct FileSelectParams* ED_fileselect_get_active_params ( const struct SpaceFile *  sfile)

◆ ED_fileselect_get_asset_params()

struct FileAssetSelectParams* ED_fileselect_get_asset_params ( const struct SpaceFile *  sfile)

◆ ED_fileselect_get_file_params()

struct FileSelectParams* ED_fileselect_get_file_params ( const struct SpaceFile *  sfile)

◆ ED_fileselect_get_layout()

FileLayout* ED_fileselect_get_layout ( struct SpaceFile *  sfile,
struct ARegion *  region 
)

◆ ED_fileselect_handler_area_find()

struct ScrArea* ED_fileselect_handler_area_find ( const struct wmWindow *  win,
const struct wmOperator *  file_operator 
)

◆ ED_fileselect_init_layout()

void ED_fileselect_init_layout ( struct SpaceFile *  sfile,
struct ARegion *  region 
)

◆ ED_fileselect_is_asset_browser()

bool ED_fileselect_is_asset_browser ( const struct SpaceFile *  sfile)

◆ ED_fileselect_layout_is_inside_pt()

bool ED_fileselect_layout_is_inside_pt ( const FileLayout *  layout,
const struct View2D *  v2d,
int  x,
int  y 
)

◆ ED_fileselect_layout_isect_rect()

bool ED_fileselect_layout_isect_rect ( const FileLayout *  layout,
const struct View2D *  v2d,
const struct rcti *  rect,
struct rcti *  r_dst 
)

◆ ED_fileselect_layout_maskrect()

void ED_fileselect_layout_maskrect ( const FileLayout *  layout,
const struct View2D *  v2d,
struct rcti *  r_rect 
)

Referenced by file_main_region_draw().

◆ ED_fileselect_layout_numfiles()

int ED_fileselect_layout_numfiles ( FileLayout *  layout,
struct ARegion *  region 
)

◆ ED_fileselect_layout_offset()

int ED_fileselect_layout_offset ( FileLayout *  layout,
int  x,
int  y 
)

◆ ED_fileselect_layout_offset_rect()

FileSelection ED_fileselect_layout_offset_rect ( FileLayout *  layout,
const struct rcti *  rect 
)

Referenced by find_file_mouse_rect().

◆ ED_fileselect_layout_tilepos()

void ED_fileselect_layout_tilepos ( FileLayout *  layout,
int  tile,
int *  x,
int *  y 
)

◆ ED_fileselect_params_to_userdef()

void ED_fileselect_params_to_userdef ( struct SpaceFile *  sfile,
const int  temp_win_size[],
const bool  is_maximized 
)

◆ ED_fileselect_set_params_from_userdef()

void ED_fileselect_set_params_from_userdef ( struct SpaceFile *  sfile)

◆ ED_fileselect_window_params_get()

void ED_fileselect_window_params_get ( const struct wmWindow *  win,
int  win_size[2],
bool *  is_maximized 
)

◆ ED_fsmenu_entry_get_icon()

int ED_fsmenu_entry_get_icon ( struct FSMenuEntry *  fsentry)

Definition at line 280 of file fsmenu.c.

References FSMenuEntry::icon.

◆ ED_fsmenu_entry_get_name()

char* ED_fsmenu_entry_get_name ( struct FSMenuEntry *  fsentry)

Definition at line 307 of file fsmenu.c.

References fsmenu_entry_generate_name(), and FSMenuEntry::name.

◆ ED_fsmenu_entry_get_path()

char* ED_fsmenu_entry_get_path ( struct FSMenuEntry *  fsentry)

Definition at line 258 of file fsmenu.c.

References FSMenuEntry::path.

◆ ED_fsmenu_entry_set_icon()

void ED_fsmenu_entry_set_icon ( struct FSMenuEntry *  fsentry,
const int  icon 
)

Definition at line 285 of file fsmenu.c.

References FSMenuEntry::icon.

Referenced by fsmenu_insert_entry().

◆ ED_fsmenu_entry_set_name()

void ED_fsmenu_entry_set_name ( struct FSMenuEntry *  fsentry,
const char *  name 
)

◆ ED_fsmenu_entry_set_path()

void ED_fsmenu_entry_set_path ( struct FSMenuEntry *  fsentry,
const char *  path 
)

◆ ED_fsmenu_get()

struct FSMenu* ED_fsmenu_get ( void  )

◆ ED_fsmenu_get_category()

struct FSMenuEntry* ED_fsmenu_get_category ( struct FSMenu *  fsmenu,
FSMenuCategory  category 
)

◆ ED_fsmenu_get_entry()

struct FSMenuEntry* ED_fsmenu_get_entry ( struct FSMenu *  fsmenu,
FSMenuCategory  category,
int  idx 
)

Definition at line 246 of file fsmenu.c.

References ED_fsmenu_get_category(), and FSMenuEntry::next.

Referenced by reset_recent_exec().

◆ ED_fsmenu_get_nentries()

int ED_fsmenu_get_nentries ( struct FSMenu *  fsmenu,
FSMenuCategory  category 
)

Definition at line 234 of file fsmenu.c.

References count, ED_fsmenu_get_category(), and FSMenuEntry::next.

Referenced by bookmark_delete_exec(), and bookmark_move_exec().

◆ ED_fsmenu_set_category()

void ED_fsmenu_set_category ( struct FSMenu *  fsmenu,
FSMenuCategory  category,
struct FSMenuEntry *  fsm_head 
)

◆ ED_operatormacros_file()

void ED_operatormacros_file ( void  )

Definition at line 2910 of file file_ops.c.

Referenced by ED_spacemacros_init().

◆ ED_path_extension_type()

int ED_path_extension_type ( const char *  path)