lv_file_explorer.h

API reference for lv_file_explorer.h

Summary

Functions

public/others/file_explorer/lv_file_explorer.h:89function

lv_file_explorer_set_quick_access_path

Set file_explorer

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

void lv_file_explorer_set_quick_access_path(lv_obj_t *obj, lv_file_explorer_dir_t dir, const char *path)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a label object
`dir`	`lv_file_explorer_dir_t`	the dir from 'lv_file_explorer_dir_t' enum.
`path`	`const char *`	path

public/others/file_explorer/lv_file_explorer.h:99function

lv_file_explorer_set_sort

Set file_explorer sort

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

void lv_file_explorer_set_sort(lv_obj_t *obj, lv_file_explorer_sort_t sort)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a file explorer object
`sort`	`lv_file_explorer_sort_t`	the sort from 'lv_file_explorer_sort_t' enum.

public/others/file_explorer/lv_file_explorer.h:121function

lv_file_explorer_get_selected_file_name

Get file explorer Selected file

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

const char * lv_file_explorer_get_selected_file_name(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to a file explorer object

Returns: const char * — pointer to the file explorer selected file name

public/others/file_explorer/lv_file_explorer.h:130function

lv_file_explorer_get_current_path

Get file explorer cur path

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

const char * lv_file_explorer_get_current_path(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to a file explorer object

Returns: const char * — pointer to the file explorer cur path

public/others/file_explorer/lv_file_explorer.h:139function

lv_file_explorer_get_file_table

Get file explorer file list obj(lv_table)

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

lv_obj_t * lv_file_explorer_get_file_table(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a file explorer object

Returns: lv_obj_t * — pointer to the file explorer file table obj(lv_table)

public/others/file_explorer/lv_file_explorer.h:148function

lv_file_explorer_get_header

Get file explorer head area obj

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

lv_obj_t * lv_file_explorer_get_header(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a file explorer object

Returns: lv_obj_t * — pointer to the file explorer head area obj(lv_obj)

public/others/file_explorer/lv_file_explorer.h:157function

lv_file_explorer_get_path_label

Get file explorer path obj(label)

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

lv_obj_t * lv_file_explorer_get_path_label(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a file explorer object

Returns: lv_obj_t * — pointer to the file explorer path obj(lv_label)

public/others/file_explorer/lv_file_explorer.h:167function

lv_file_explorer_get_quick_access_area

Get file explorer head area obj

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

lv_obj_t * lv_file_explorer_get_quick_access_area(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a file explorer object

Returns: lv_obj_t * — pointer to the file explorer quick access area obj(lv_obj)

public/others/file_explorer/lv_file_explorer.h:176function

lv_file_explorer_get_places_list

Get file explorer places list obj(lv_list)

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

lv_obj_t * lv_file_explorer_get_places_list(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a file explorer object

Returns: lv_obj_t * — pointer to the file explorer places list obj(lv_list)

public/others/file_explorer/lv_file_explorer.h:185function

lv_file_explorer_get_device_list

Get file explorer device list obj(lv_list)

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

lv_obj_t * lv_file_explorer_get_device_list(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a file explorer object

Returns: lv_obj_t * — pointer to the file explorer device list obj(lv_list)

public/others/file_explorer/lv_file_explorer.h:195function

lv_file_explorer_get_sort

Set file_explorer sort

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

lv_file_explorer_sort_t lv_file_explorer_get_sort(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to a file explorer object

Returns: lv_file_explorer_sort_t — the current mode from 'lv_file_explorer_sort_t'

public/others/file_explorer/lv_file_explorer.h:74function

lv_file_explorer_create

Create a file explorer object

> Deprecated: The lv_file_explorer widget is deprecated. Build a file browser from a table and the lv_fs API instead. See lv_example_table_file_browser.

lv_obj_t * lv_file_explorer_create(lv_obj_t *parent)

Name	Type	Description
`parent`	`lv_obj_t *`	pointer to a parent widget May be `NULL`.. When NULL, the widget is created as a screen on the default display.

Returns: lv_obj_t * — pointer to the created file explorer

public/others/file_explorer/lv_file_explorer.h:108function

lv_file_explorer_show_back_button

Set the visibility of the "< Back" button

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

void lv_file_explorer_show_back_button(lv_obj_t *obj, bool show)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a file explorer object
`show`	`bool`	bool true/false, enable or disable button

public/others/file_explorer/lv_file_explorer.h:208function

lv_file_explorer_open_dir

Open a specified path

> Deprecated: The lv_file_explorer widget is deprecated. See lv_example_table_file_browser.

void lv_file_explorer_open_dir(lv_obj_t *obj, const char *dir)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a file explorer object
`dir`	`const char *`	pointer to the path

Enums

public/others/file_explorer/lv_file_explorer.h:39enum

lv_file_explorer_sort_t

Name
`LV_EXPLORER_SORT_NONE`
`LV_EXPLORER_SORT_KIND`

Used by 1 function

lv_file_explorer_set_sort — param sort

public/others/file_explorer/lv_file_explorer.h:45enum

lv_file_explorer_dir_t

Name
`LV_EXPLORER_HOME_DIR`
`LV_EXPLORER_MUSIC_DIR`
`LV_EXPLORER_PICTURES_DIR`
`LV_EXPLORER_VIDEO_DIR`
`LV_EXPLORER_DOCS_DIR`
`LV_EXPLORER_FS_DIR`

Used by 1 function

lv_file_explorer_set_quick_access_path — param dir

Macros

public/others/file_explorer/lv_file_explorer.h:32macro

LV_FILE_EXPLORER_DEPRECATED_MSG

#define LV_FILE_EXPLORER_DEPRECATED_MSG "lv_file_explorer is deprecated; build a file browser from a table + lv_fs instead. See the lv_example_table_file_browser example."

> Deprecated: The lv_file_explorer widget is deprecated and kept only for backward compatibility. A file explorer is a path header plus a table of directory entries read with the lv_fs API, so build it directly instead. See the lv_example_table_file_browser example. All lv_file_explorer_* functions below are deprecated.

Variables

public/others/file_explorer/lv_file_explorer.h:55variable

lv_file_explorer_class

const lv_obj_class_t lv_file_explorer_class

lv_file_explorer.h

Functions

lv_file_explorer_set_quick_access_path

lv_file_explorer_set_sort

lv_file_explorer_get_selected_file_name

lv_file_explorer_get_current_path

lv_file_explorer_get_file_table

lv_file_explorer_get_header

lv_file_explorer_get_path_label

lv_file_explorer_get_quick_access_area

lv_file_explorer_get_places_list

lv_file_explorer_get_device_list

lv_file_explorer_get_sort

lv_file_explorer_create

lv_file_explorer_show_back_button

lv_file_explorer_open_dir

Enums

lv_file_explorer_sort_t

lv_file_explorer_dir_t

Macros

LV_FILE_EXPLORER_DEPRECATED_MSG

Variables

lv_file_explorer_class

Dependencies

On this page