src/lib/elm_dayselector.h

   1 /**
   2  * @internal
   3  * @defgroup Dayselector Dayselector
   4  * @ingroup Elementary
   5  *
   6  * @image html dayselector_inheritance_tree.png
   7  * @image latex dayselector_inheritance_tree.eps
   8  *
   9  *
  10  * @brief <b>Dayselector widget:</b>
  11  *
  12  *"elm_dayselector" is a day selection widget. It displays all seven days of
  13  * the week and allows the user to select multiple days.
  14  *
  15  * The selection can be toggle by just clicking on the day.
  16  *
  17  * Dayselector also provides the functionality to check whether a day is
  18  * selected or not.
  19  *
  20  * First day of the week is taken from config settings by default. It can be
  21  * altered by using the API elm_dayselector_week_start_set() API.
  22  *
  23  * APIs are provided for setting the duration of weekend
  24  * elm_dayselector_weekend_start_set() and elm_dayselector_weekend_length_set()
  25  * does this job.
  26  *
  27  * Two styles of weekdays and weekends are supported in Dayselector.
  28  * Application can emit signals on individual check objects for setting the
  29  * weekday, weekend styles.
  30  *
  31  * Once the weekend start day or weekend length changes, all the weekday &
  32  * weekend styles will be reset to default style. It's the application's
  33  * responsibility to set the styles again by sending corresponding signals.
  34  *
  35  * Supported elm_object_item common APIs.
  36  *
  37  * @li @ref elm_object_part_text_set,
  38  * @li @ref elm_object_part_text_get,
  39  * @li @ref elm_object_part_content_set,
  40  * @li @ref elm_object_part_content_get,
  41  * @li @ref elm_object_part_content_unset
  42  *
  43  * @li "day0" indicates Sunday, "day1" indicates Monday etc. continues and so,
  44  * "day6" indicates the Saturday part name.
  45  *
  46  * Application can change individual day display string by using the API
  47  * elm_object_part_text_set().
  48  *
  49  * elm_object_part_content_set() API sets the individual day object only if
  50  * the passed one is a Check widget.
  51  *
  52  * Check object representing a day can be set/get by the application by using
  53  * the elm_object_part_content_set/get APIs thus providing a way to handle
  54  * the different check styles for individual days.
  55  *
  56  * This widget inherits from the @ref Layout one, so that all the
  57  * functions acting on it also work for dayselector objects.
  58  *
  59  * This widget emits the following signals, besides the ones sent from
  60  * @ref Layout:
  61  * @li @c "dayselector,changed" - when the user changes the state of a day.
  62  * @li @c "language,changed" - the program's language changed
  63  *
  64  * Available styles for dayselector are:
  65  * @li default
  66  *
  67  */
  68
  69 /**
  70  * @internal
  71  * @addtogroup Dayselector
  72  * @{
  73  */
  74
  75 #include "elm_dayselector_common.h"
  76 #ifdef EFL_EO_API_SUPPORT
  77 #include "elm_dayselector_eo.h"
  78 #endif
  79 #ifndef EFL_NOLEGACY_API_SUPPORT
  80 #include "elm_dayselector_legacy.h"
  81 #endif
  82 /**
  83  * @}
  84  */