git.maemo.org Git - hildon/blob - doc/tmpl/hildon-weekday-picker.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 HildonWeekdayPicker
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A widget for selecting weekday(s)
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 Weekday picker supports non-mutually exclusive selection of days of the week. Selected days of the week are shown with a pushed-in effect.
  10 </para>
  11
  12 <para>
  13 Weekday picker is used where users are required to pick days on which a certain event should take place, for example, which days a Calendar event should be repeated on. It is used in Calendar in the Repeat dialog, in Tasks in the Repeat dialog and in the Email set-up wizard.
  14 </para>
  15
  16 <para>
  17 <informalexample>
  18 Example function calls:
  19 <programlisting>
  20         gint i;
  21         HildonWeekdayPicker *picker = hildon_weekday_picker_new();
  22
  23         hildon_weekday_picker_set_day( picker, i );
  24         hildon_weekday_picker_unset_day( picker, i );
  25         hildon_weekday_picker_toggle_day( picker, i );
  26         hildon_weekday_picker_set_all( picker );
  27   hildon_weekday_picker_unset_all( picker );
  28 </programlisting>
  29 </informalexample>
  30 </para>
  31
  32 <!-- ##### SECTION See_Also ##### -->
  33 <para>
  34
  35 </para>
  36
  37 <!-- ##### MACRO HILDON_WEEKDAY_PICKER_TYPE ##### -->
  38 <para>
  39
  40 </para>
  41
  42
  43
  44 <!-- ##### STRUCT HildonWeekdayPicker ##### -->
  45 <para>
  46
  47 </para>
  48
  49
  50 <!-- ##### FUNCTION hildon_weekday_picker_new ##### -->
  51 <para>
  52 </para>
  53
  54 @Returns:
  55
  56
  57 <!-- ##### FUNCTION hildon_weekday_picker_set_day ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @picker:
  63 @day:
  64
  65
  66 <!-- ##### FUNCTION hildon_weekday_picker_unset_day ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @picker:
  72 @day:
  73
  74
  75 <!-- ##### FUNCTION hildon_weekday_picker_toggle_day ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @picker:
  81 @day:
  82
  83
  84 <!-- ##### FUNCTION hildon_weekday_picker_set_all ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @picker:
  90
  91
  92 <!-- ##### FUNCTION hildon_weekday_picker_unset_all ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @picker:
  98
  99
 100 <!-- ##### FUNCTION hildon_weekday_picker_isset_day ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @picker:
 106 @day:
 107 @Returns:
 108
 109
 110 <!-- ##### SIGNAL HildonWeekdayPicker::selection-changed ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @hildonweekdaypicker: the object which received the signal.
 116 @arg1:
 117