# lv_calendar.h (/api/widgets/calendar/lv_calendar_h) Functions [#functions] lv_calendar_set_today_date [#lv_calendar_set_today_date] Set the today's year, month and day at once ```c title=" " lineNumbers=1 void lv_calendar_set_today_date(lv_obj_t *obj, uint32_t year, uint32_t month, uint32_t day) ``` Parameters | Name | Type | Description | | ------- | ------------------------------------------------ | ---------------------------- | | `obj` | | pointer to a calendar object | | `year` | | today's year | | `month` | | today's month \[1..12] | | `day` | | today's day \[1..31] | lv_calendar_set_today_year [#lv_calendar_set_today_year] Set the today's year ```c title=" " lineNumbers=1 void lv_calendar_set_today_year(lv_obj_t *obj, uint32_t year) ``` Parameters | Name | Type | Description | | ------ | ------------------------------------------------ | ---------------------------- | | `obj` | | pointer to a calendar object | | `year` | | today's year | lv_calendar_set_today_month [#lv_calendar_set_today_month] Set the today's year ```c title=" " lineNumbers=1 void lv_calendar_set_today_month(lv_obj_t *obj, uint32_t month) ``` Parameters | Name | Type | Description | | ------- | ------------------------------------------------ | ---------------------------- | | `obj` | | pointer to a calendar object | | `month` | | today's month \[1..12] | lv_calendar_set_today_day [#lv_calendar_set_today_day] Set the today's year ```c title=" " lineNumbers=1 void lv_calendar_set_today_day(lv_obj_t *obj, uint32_t day) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ---------------------------- | | `obj` | | pointer to a calendar object | | `day` | | today's day \[1..31] | lv_calendar_set_month_shown [#lv_calendar_set_month_shown] Set the currently shown year and month at once ```c title=" " lineNumbers=1 void lv_calendar_set_month_shown(lv_obj_t *obj, uint32_t year, uint32_t month) ``` Parameters | Name | Type | Description | | ------- | ------------------------------------------------ | ---------------------------- | | `obj` | | pointer to a calendar object | | `year` | | shown year | | `month` | | shown month \[1..12] | lv_calendar_set_shown_year [#lv_calendar_set_shown_year] Set the currently shown year ```c title=" " lineNumbers=1 void lv_calendar_set_shown_year(lv_obj_t *obj, uint32_t year) ``` Parameters | Name | Type | Description | | ------ | ------------------------------------------------ | ---------------------------- | | `obj` | | pointer to a calendar object | | `year` | | shown year | lv_calendar_set_shown_month [#lv_calendar_set_shown_month] Set the currently shown month ```c title=" " lineNumbers=1 void lv_calendar_set_shown_month(lv_obj_t *obj, uint32_t month) ``` Parameters | Name | Type | Description | | ------- | ------------------------------------------------ | ---------------------------- | | `obj` | | pointer to a calendar object | | `month` | | shown month \[1..12] | lv_calendar_set_highlighted_dates [#lv_calendar_set_highlighted_dates] Set the highlighted dates ```c title=" " lineNumbers=1 void lv_calendar_set_highlighted_dates(lv_obj_t *obj, lv_calendar_date_t highlighted[], size_t date_num) ``` Parameters | Name | Type | Description | | ------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `obj` | | pointer to a calendar object | | `highlighted` | | pointer to an array containing the dates. Only the pointer will be saved so this variable can't be local which will be destroyed later. | | `date_num` | | number of dates in the array | lv_calendar_set_day_names [#lv_calendar_set_day_names] Set the name of the days ```c title=" " lineNumbers=1 void lv_calendar_set_day_names(lv_obj_t *obj, const char **day_names) ``` Parameters | Name | Type | Description | | ----------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `obj` | | pointer to a calendar object | | `day_names` | `const char **` | pointer to an array with the names. E.g. `const char * days[7] = {"Sun", "Mon", ...}` Only the pointer will be saved so this variable can't be local which will be destroyed later. | lv_calendar_get_btnmatrix [#lv_calendar_get_btnmatrix] Get the button matrix object of the calendar. It shows the dates and day names. ```c title=" " lineNumbers=1 lv_obj_t * lv_calendar_get_btnmatrix(const lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------------ | ---------------------------- | | `obj` | | pointer to a calendar object | **Returns:** — pointer to a the button matrix lv_calendar_get_today_date [#lv_calendar_get_today_date] Get the today's date ```c title=" " lineNumbers=1 const lv_calendar_date_t * lv_calendar_get_today_date(const lv_obj_t *calendar) ``` Parameters | Name | Type | Description | | ---------- | ------------------------------------------------------ | ---------------------------- | | `calendar` | | pointer to a calendar object | **Returns:** — return pointer to an variable containing the date of today. lv_calendar_get_showed_date [#lv_calendar_get_showed_date] Get the currently showed ```c title=" " lineNumbers=1 const lv_calendar_date_t * lv_calendar_get_showed_date(const lv_obj_t *calendar) ``` Parameters | Name | Type | Description | | ---------- | ------------------------------------------------------ | ---------------------------- | | `calendar` | | pointer to a calendar object | **Returns:** — pointer to an variable containing the date is being shown. lv_calendar_get_highlighted_dates [#lv_calendar_get_highlighted_dates] Get the highlighted dates ```c title=" " lineNumbers=1 lv_calendar_date_t * lv_calendar_get_highlighted_dates(const lv_obj_t *calendar) ``` Parameters | Name | Type | Description | | ---------- | ------------------------------------------------------ | ---------------------------- | | `calendar` | | pointer to a calendar object | **Returns:** — pointer to an array containing the dates. lv_calendar_get_highlighted_dates_num [#lv_calendar_get_highlighted_dates_num] Get the number of the highlighted dates ```c title=" " lineNumbers=1 size_t lv_calendar_get_highlighted_dates_num(const lv_obj_t *calendar) ``` Parameters | Name | Type | Description | | ---------- | ------------------------------------------------------ | ---------------------------- | | `calendar` | | pointer to a calendar object | **Returns:** — number of highlighted days lv_calendar_get_pressed_date [#lv_calendar_get_pressed_date] Get the currently pressed day ```c title=" " lineNumbers=1 lv_result_t lv_calendar_get_pressed_date(const lv_obj_t *calendar, lv_calendar_date_t *date) ``` Parameters | Name | Type | Description | | ---------- | -------------------------------------------------------------------- | ---------------------------- | | `calendar` | | pointer to a calendar object | | `date` | | store the pressed date here | **Returns:** — LV\_RESULT\_OK: there is a valid pressed date LV\_RESULT\_INVALID: there is no pressed data lv_calendar_create [#lv_calendar_create] Create a calendar widget ```c title=" " lineNumbers=1 lv_obj_t * lv_calendar_create(lv_obj_t *parent) ``` Parameters | Name | Type | Description | | -------- | ------------------------------------------------ | --------------------------------------------------------------- | | `parent` | | pointer to an object, it will be the parent of the new calendar | **Returns:** — pointer the created calendar Structs [#structs] lv_calendar_date_t [#lv_calendar_date_t] Represents a date on the calendar object (platform-agnostic). | Member | Type | Description | | ------- | --------------------------- | ----------- | | `year` | | | | `month` | | 1..12 | | `day` | | 1..31 | * `lv_calendar_set_highlighted_dates` — param `highlighted` * `lv_calendar_get_pressed_date` — param `date` * `lv_calendar_get_day_name` — param `gregorian` * `lv_calendar_gregorian_to_chinese` — param `gregorian_time` Variables [#variables] lv_calendar_class [#lv_calendar_class] ```c title=" " lineNumbers=1 const lv_obj_class_t lv_calendar_class ``` Dependencies [#dependencies]