vcs.maemo.org Git - hildon/blob - doc/tmpl/hildon-calendar-popup.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 HildonCalendarPopup
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 #HildonCalendarPopup is a dialog which contains a GtkCalendar.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #HildonCalendarPopup is a dialog which contains a GtkCalendar.
  10 It also contains arrow buttons for changing month/year. The
  11 earliest possible date is 1/1/1980 and the latest date 31/12/2100.
  12 If navigating with keyboard to a date that is not in the current
  13 month the calendar moves to the corresponding month. If the new
  14 date would be unallowed then an information banner will be shown.
  15
  16 The usage of CalendarPopup is shown in the following code. This function
  17 should be connect to eg. button-press-event.
  18 <informalexample>
  19 <programlisting>
  20 ...
  21   gint y, m, d;
  22   GtkWidget *parent, *popup;
  23
  24   /* get current date
  25      into &amp;y, &amp;m, &amp;d... */
  26
  27   gtk_widget_get_ancestor(GTK_WIDGET(data), GTK_TYPE_WINDOW);
  28   popup = hildon_calendar_popup_new(GTK_WINDOW (parent), y, m, d);
  29
  30   result = gtk_dialog_run(GTK_DIALOG(popup));
  31   switch(result)
  32   {
  33     case GTK_RESPONSE_OK:
  34     case GTK_RESPONSE_ACCEPT:
  35
  36     hildon_calendar_popup_get_date(HILDON_CALENDAR_POPUP(popup), &amp;y, &amp;m, &amp;d);
  37
  38     /* here set the new date*/
  39   }
  40   gtk_widget_destroy(popup);
  41 ...
  42 </programlisting>
  43 </informalexample>
  44 </para>
  45
  46 <!-- ##### SECTION See_Also ##### -->
  47 <para>
  48 #GtkCalendar
  49 </para>
  50
  51 <!-- ##### MACRO HILDON_CALENDAR_POPUP_TYPE ##### -->
  52 <para>
  53
  54 </para>
  55
  56
  57
  58 <!-- ##### FUNCTION hildon_calendar_popup_new ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @parent:
  64 @year:
  65 @month:
  66 @day:
  67 @Returns:
  68
  69
  70 <!-- ##### FUNCTION hildon_calendar_popup_set_date ##### -->
  71 <para>
  72
  73 </para>
  74
  75 @cal:
  76 @year:
  77 @month:
  78 @day:
  79
  80
  81 <!-- ##### FUNCTION hildon_calendar_popup_get_date ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @cal:
  87 @year:
  88 @month:
  89 @day:
  90
  91
  92 <!-- ##### ARG HildonCalendarPopup:day ##### -->
  93 <para>
  94
  95 </para>
  96
  97 <!-- ##### ARG HildonCalendarPopup:max-year ##### -->
  98 <para>
  99
 100 </para>
 101
 102 <!-- ##### ARG HildonCalendarPopup:min-year ##### -->
 103 <para>
 104
 105 </para>
 106
 107 <!-- ##### ARG HildonCalendarPopup:month ##### -->
 108 <para>
 109
 110 </para>
 111
 112 <!-- ##### ARG HildonCalendarPopup:year ##### -->
 113 <para>
 114
 115 </para>
 116