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