Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkcalendar.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkCalendar
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Displays a calendar and allows the user to select a date
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #GtkCalendar is a widget that displays a calendar, one month at a time.
  10 It can be created with gtk_calendar_new().
  11 </para>
  12 <para>
  13 The month and year currently displayed can be altered with
  14 gtk_calendar_select_month(). The exact day can be selected from the displayed
  15 month using gtk_calendar_select_day().
  16 </para>
  17 <para>
  18 To place a visual marker on a particular day, use gtk_calendar_mark_day()
  19 and to remove the marker, gtk_calendar_unmark_day().
  20 Alternative, all marks can be cleared with gtk_calendar_clear_marks().
  21 </para>
  22 <para>
  23 The way in which the calendar itself is displayed can be altered using
  24 gtk_calendar_set_display_options().
  25 </para>
  26 <para>
  27 The selected date can be retrieved from a #GtkCalendar using
  28 gtk_calendar_get_date().
  29 </para>
  30
  31 <!-- ##### SECTION See_Also ##### -->
  32 <para>
  33
  34 </para>
  35
  36 <!-- ##### SECTION Stability_Level ##### -->
  37
  38
  39 <!-- ##### SECTION Image ##### -->
  40
  41
  42 <!-- ##### STRUCT GtkCalendar ##### -->
  43 <para>
  44 <structfield>num_marked_dates</structfield> is an integer containing the
  45 number of days that have a mark over them.
  46 </para>
  47 <para>
  48 <structfield>marked_date</structfield> is an array containing the day numbers
  49 that currently have a mark over them.
  50 </para>
  51 <para>
  52 <structfield>month</structfield>, <structfield>year</structfield>, and
  53 <structfield>selected_day</structfield> contain the currently visible month,
  54 year, and selected day respectively.
  55 </para>
  56 <para>
  57 All of these fields should be considered read only, and everything in this
  58 struct should only be modified using the functions provided below.
  59 </para>
  60 <note>
  61 <para>
  62 Note that <structfield>month</structfield> is zero-based (i.e it allowed values
  63 are 0-11) while <structfield>selected_day</structfield> is one-based
  64 (i.e. allowed values are 1-31).
  65 </para>
  66 </note>
  67
  68
  69 <!-- ##### SIGNAL GtkCalendar::day-selected ##### -->
  70 <para>
  71 Emitted when the user selects a day.
  72 </para>
  73
  74 @calendar: the object which received the signal.
  75
  76 <!-- ##### SIGNAL GtkCalendar::day-selected-double-click ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @calendar: the object which received the signal.
  82
  83 <!-- ##### SIGNAL GtkCalendar::month-changed ##### -->
  84 <para>
  85 Emitted when the user clicks a button to change the selected month on a
  86 calendar.
  87 </para>
  88
  89 @calendar: the object which received the signal.
  90
  91 <!-- ##### SIGNAL GtkCalendar::next-month ##### -->
  92 <para>
  93
  94 </para>
  95
  96 @calendar: the object which received the signal.
  97
  98 <!-- ##### SIGNAL GtkCalendar::next-year ##### -->
  99 <para>
 100
 101 </para>
 102
 103 @calendar: the object which received the signal.
 104
 105 <!-- ##### SIGNAL GtkCalendar::prev-month ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @calendar: the object which received the signal.
 111
 112 <!-- ##### SIGNAL GtkCalendar::prev-year ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @calendar: the object which received the signal.
 118
 119 <!-- ##### ARG GtkCalendar:day ##### -->
 120 <para>
 121
 122 </para>
 123
 124 <!-- ##### ARG GtkCalendar:detail-height-rows ##### -->
 125 <para>
 126
 127 </para>
 128
 129 <!-- ##### ARG GtkCalendar:detail-width-chars ##### -->
 130 <para>
 131
 132 </para>
 133
 134 <!-- ##### ARG GtkCalendar:month ##### -->
 135 <para>
 136
 137 </para>
 138
 139 <!-- ##### ARG GtkCalendar:no-month-change ##### -->
 140 <para>
 141
 142 </para>
 143
 144 <!-- ##### ARG GtkCalendar:show-day-names ##### -->
 145 <para>
 146
 147 </para>
 148
 149 <!-- ##### ARG GtkCalendar:show-details ##### -->
 150 <para>
 151
 152 </para>
 153
 154 <!-- ##### ARG GtkCalendar:show-heading ##### -->
 155 <para>
 156
 157 </para>
 158
 159 <!-- ##### ARG GtkCalendar:show-week-numbers ##### -->
 160 <para>
 161
 162 </para>
 163
 164 <!-- ##### ARG GtkCalendar:year ##### -->
 165 <para>
 166
 167 </para>
 168
 169 <!-- ##### USER_FUNCTION GtkCalendarDetailFunc ##### -->
 170 <para>
 171
 172 </para>
 173
 174 @calendar:
 175 @year:
 176 @month:
 177 @day:
 178 @user_data:
 179 @Returns:
 180
 181
 182 <!-- ##### ENUM GtkCalendarDisplayOptions ##### -->
 183 <para>
 184 </para>
 185
 186 @GTK_CALENDAR_SHOW_HEADING:
 187 @GTK_CALENDAR_SHOW_DAY_NAMES:
 188 @GTK_CALENDAR_NO_MONTH_CHANGE:
 189 @GTK_CALENDAR_SHOW_WEEK_NUMBERS:
 190 @GTK_CALENDAR_WEEK_START_MONDAY:
 191 @GTK_CALENDAR_SHOW_DETAILS:
 192
 193 <!-- ##### FUNCTION gtk_calendar_new ##### -->
 194 <para>
 195 </para>
 196
 197 @void:
 198 @Returns:
 199
 200
 201 <!-- ##### FUNCTION gtk_calendar_select_month ##### -->
 202 <para>
 203 </para>
 204
 205 @calendar:
 206 @month:
 207 @year:
 208 @Returns:
 209
 210
 211 <!-- ##### FUNCTION gtk_calendar_select_day ##### -->
 212 <para>
 213 </para>
 214
 215 @calendar:
 216 @day:
 217
 218
 219 <!-- ##### FUNCTION gtk_calendar_mark_day ##### -->
 220 <para>
 221 </para>
 222
 223 @calendar:
 224 @day:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION gtk_calendar_unmark_day ##### -->
 229 <para>
 230 </para>
 231
 232 @calendar:
 233 @day:
 234 @Returns:
 235
 236
 237 <!-- ##### FUNCTION gtk_calendar_clear_marks ##### -->
 238 <para>
 239 </para>
 240
 241 @calendar:
 242
 243
 244 <!-- ##### FUNCTION gtk_calendar_get_display_options ##### -->
 245 <para>
 246
 247 </para>
 248
 249 @calendar:
 250 @Returns:
 251
 252
 253 <!-- ##### FUNCTION gtk_calendar_set_display_options ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @calendar:
 259 @flags:
 260
 261
 262 <!-- ##### FUNCTION gtk_calendar_get_date ##### -->
 263 <para>
 264 </para>
 265
 266 @calendar:
 267 @year:
 268 @month:
 269 @day:
 270
 271
 272 <!-- ##### FUNCTION gtk_calendar_set_detail_func ##### -->
 273 <para>
 274
 275 </para>
 276
 277 @calendar:
 278 @func:
 279 @data:
 280 @destroy:
 281
 282
 283 <!-- ##### FUNCTION gtk_calendar_get_detail_width_chars ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @calendar:
 289 @Returns:
 290
 291
 292 <!-- ##### FUNCTION gtk_calendar_set_detail_width_chars ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @calendar:
 298 @chars:
 299
 300
 301 <!-- ##### FUNCTION gtk_calendar_get_detail_height_rows ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @calendar:
 307 @Returns:
 308
 309
 310 <!-- ##### FUNCTION gtk_calendar_set_detail_height_rows ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @calendar:
 316 @rows:
 317
 318