efl/legacy/elementary/src/lib/elm_dayselector_legacy.h

165 lines
4.5 KiB
C

/**
* Add the dayselector.
*
* @param parent Parent object
* @return New dayselector object or @c NULL, if it cannot be created
*
* @ingroup Dayselector
*/
EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
/**
* Set the state of given Dayselector_Day.
*
* @param obj Dayselector object
* @param day Dayselector_Day that the user want to set state.
* @param selected state of the day. @c EINA_TRUE is selected.
*
* @see Elm_Dayselector_Day
* @see elm_dayselector_day_selected_get()
*
* @ingroup Dayselector
*/
EAPI void elm_dayselector_day_selected_set(Evas_Object *obj, Elm_Dayselector_Day day, Eina_Bool selected);
/**
* Get the state of given Dayselector_Day.
*
* @param obj Dayselector object
* @param day Dayselector_Day that the user want to know state.
* @return @c EINA_TRUE, if the Day is selected
*
* @see Elm_Dayselector_Day
* @see elm_dayselector_day_selected_set()
*
* @ingroup Dayselector
*/
EAPI Eina_Bool elm_dayselector_day_selected_get(const Evas_Object *obj, Elm_Dayselector_Day day);
/**
* Set the starting day of Dayselector.
*
* @param obj Dayselector object
* @param day Dayselector_Day the first day that the user wants to display.
*
* @see Elm_Dayselector_Day
* @see elm_dayselector_week_start_get()
*
* @ingroup Dayselector
*/
EAPI void elm_dayselector_week_start_set(Evas_Object *obj, Elm_Dayselector_Day day);
/**
* Get the starting day of Dayselector.
*
* @param obj Dayselector object
* @return Day from where Dayselector displays all the weekdays in order.
*
* @see Elm_Dayselector_Day
* @see elm_dayselector_week_start_set()
*
* @ingroup Dayselector
*/
EAPI Elm_Dayselector_Day elm_dayselector_week_start_get(const Evas_Object *obj);
/**
* Set the weekend starting day of Dayselector.
*
* @param obj Dayselector object
* @param day Dayselector_Day the first day from where weekend starts.
*
* @see Elm_Dayselector_Day
* @see elm_dayselector_weekend_start_get()
*
* @ingroup Dayselector
*/
EAPI void elm_dayselector_weekend_start_set(Evas_Object *obj, Elm_Dayselector_Day day);
/**
* Get the weekend starting day of Dayselector.
*
* @param obj Dayselector object
* @return Elm_Dayselector_Day Day from where weekend starts.
*
* @see Elm_Dayselector_Day
* @see elm_dayselector_weekend_start_set()
*
* @ingroup Dayselector
*/
EAPI Elm_Dayselector_Day elm_dayselector_weekend_start_get(const Evas_Object *obj);
/**
* Set the weekend length of Dayselector.
*
* @param obj Dayselector object
* @param length Weekend length, number of days as an integer.
*
* @see elm_dayselector_weekend_length_get()
*
* @ingroup Dayselector
*/
EAPI void elm_dayselector_weekend_length_set(Evas_Object *obj, unsigned int length);
/**
* Get the weekend length of Dayselector.
*
* @param obj Dayselector object
* @return Number of days marked as a weekend.
*
* @see Elm_Dayselector_Day
* @see elm_dayselector_weekend_length_set()
*
* @ingroup Dayselector
*/
EAPI unsigned int elm_dayselector_weekend_length_get(const Evas_Object *obj);
/**
* Set weekdays names to be displayed by the Dayselector.
*
* @param obj The Dayselector object.
* @param weekdays Array of seven strings to be used as weekday names.
* @warning It must have 7 elements, or it will access invalid memory.
* @warning The strings must be NULL terminated ('@\0').
*
* By default or if @a weekdays is @c NULL, weekdays abbreviations get from system are displayed:
* E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
*
* The first string should be related to Sunday, the second to Monday...
*
* The usage should be like this:
* @code
* const char *weekdays[] =
* {
* "Sunday", "Monday", "Tuesday", "Wednesday",
* "Thursday", "Friday", "Saturday"
* };
* elm_dayselector_wekdays_names_set(calendar, weekdays);
* @endcode
*
* @see elm_dayselector_weekdays_name_get()
* @see elm_dayselector_weekend_start_set()
*
* @since 1.8
*
* @ingroup Dayselector
*/
EAPI void elm_dayselector_weekdays_names_set(Evas_Object *obj, const char *weekdays[]);
/**
* Get weekdays names displayed by the calendar.
*
* @param obj The Dayselector object.
* @return A list of seven strings to be used as weekday names.
*
* By default, weekdays abbreviations get from system are displayed:
* E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
* The first string is related to Sunday, the second to Monday...
*
* @see elm_dayselector_weekdays_name_set()
*
* @since 1.8
*
* @ingroup Dayselector
*/
EAPI Eina_List *elm_dayselector_weekdays_names_get(const Evas_Object *obj);