← Back to branch summary

~ubuntu-branches/ubuntu/precise/gtk+2.0/precise-updates

« back to all changes in this revision

Viewing changes to docs/reference/gtk/tmpl/gtkcalendar.sgml

  • Committer: Package Import Robot
  • Author(s): Ken VanDine
  • Date: 2011-12-01 11:40:06 UTC
  • mfrom: (1.14.11)
  • Revision ID: package-import@ubuntu.com-20111201114006-nrmf6qu3pg512veo
Tags: 2.24.8-0ubuntu1
https://launchpad.net/bugs/189494
https://launchpad.net/bugs/889019
* New upstream release 
  - gtkfilechooser should be more robust to malformed URIs
    in .gtk-bookmarks (LP: #189494)
* debian/patches/010_make_bg_changes_queue_repaint.patch
  - dropped it introduces performance regressions in some gtk2 
    apps (LP: #889019)
* 101_filechooser.patch, 000git_file_chooser.patch: dropped, upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
<!-- ##### ARG GtkCalendar:horizontal-separation ##### -->
170
 
<para>
171
 
 
172
 
</para>
173
 
 
174
 
<!-- ##### ARG GtkCalendar:inner-border ##### -->
175
 
<para>
176
 
 
177
 
</para>
178
 
 
179
 
<!-- ##### ARG GtkCalendar:vertical-separation ##### -->
180
 
<para>
181
 
 
182
 
</para>
183
 
 
184
 
<!-- ##### USER_FUNCTION GtkCalendarDetailFunc ##### -->
185
 
<para>
186
 
 
187
 
</para>
188
 
 
189
 
@calendar: 
190
 
@year: 
191
 
@month: 
192
 
@day: 
193
 
@user_data: 
194
 
@Returns: 
195
 
 
196
 
 
197
 
<!-- ##### ENUM GtkCalendarDisplayOptions ##### -->
198
 
<para>
199
 
</para>
200
 
 
201
 
@GTK_CALENDAR_SHOW_HEADING: 
202
 
@GTK_CALENDAR_SHOW_DAY_NAMES: 
203
 
@GTK_CALENDAR_NO_MONTH_CHANGE: 
204
 
@GTK_CALENDAR_SHOW_WEEK_NUMBERS: 
205
 
@GTK_CALENDAR_WEEK_START_MONDAY: 
206
 
@GTK_CALENDAR_SHOW_DETAILS: 
207
 
 
208
 
<!-- ##### FUNCTION gtk_calendar_new ##### -->
209
 
<para>
210
 
</para>
211
 
 
212
 
@void: 
213
 
@Returns: 
214
 
 
215
 
 
216
 
<!-- ##### FUNCTION gtk_calendar_select_month ##### -->
217
 
<para>
218
 
</para>
219
 
 
220
 
@calendar: 
221
 
@month: 
222
 
@year: 
223
 
@Returns: 
224
 
 
225
 
 
226
 
<!-- ##### FUNCTION gtk_calendar_select_day ##### -->
227
 
<para>
228
 
</para>
229
 
 
230
 
@calendar: 
231
 
@day: 
232
 
 
233
 
 
234
 
<!-- ##### FUNCTION gtk_calendar_mark_day ##### -->
235
 
<para>
236
 
</para>
237
 
 
238
 
@calendar: 
239
 
@day: 
240
 
@Returns: 
241
 
 
242
 
 
243
 
<!-- ##### FUNCTION gtk_calendar_unmark_day ##### -->
244
 
<para>
245
 
</para>
246
 
 
247
 
@calendar: 
248
 
@day: 
249
 
@Returns: 
250
 
 
251
 
 
252
 
<!-- ##### FUNCTION gtk_calendar_clear_marks ##### -->
253
 
<para>
254
 
</para>
255
 
 
256
 
@calendar: 
257
 
 
258
 
 
259
 
<!-- ##### FUNCTION gtk_calendar_get_display_options ##### -->
260
 
<para>
261
 
 
262
 
</para>
263
 
 
264
 
@calendar: 
265
 
@Returns: 
266
 
 
267
 
 
268
 
<!-- ##### FUNCTION gtk_calendar_set_display_options ##### -->
269
 
<para>
270
 
 
271
 
</para>
272
 
 
273
 
@calendar: 
274
 
@flags: 
275
 
 
276
 
 
277
 
<!-- ##### FUNCTION gtk_calendar_get_date ##### -->
278
 
<para>
279
 
</para>
280
 
 
281
 
@calendar: 
282
 
@year: 
283
 
@month: 
284
 
@day: 
285
 
 
286
 
 
287
 
<!-- ##### FUNCTION gtk_calendar_set_detail_func ##### -->
288
 
<para>
289
 
 
290
 
</para>
291
 
 
292
 
@calendar: 
293
 
@func: 
294
 
@data: 
295
 
@destroy: 
296
 
 
297
 
 
298
 
<!-- ##### FUNCTION gtk_calendar_get_detail_width_chars ##### -->
299
 
<para>
300
 
 
301
 
</para>
302
 
 
303
 
@calendar: 
304
 
@Returns: 
305
 
 
306
 
 
307
 
<!-- ##### FUNCTION gtk_calendar_set_detail_width_chars ##### -->
308
 
<para>
309
 
 
310
 
</para>
311
 
 
312
 
@calendar: 
313
 
@chars: 
314
 
 
315
 
 
316
 
<!-- ##### FUNCTION gtk_calendar_get_detail_height_rows ##### -->
317
 
<para>
318
 
 
319
 
</para>
320
 
 
321
 
@calendar: 
322
 
@Returns: 
323
 
 
324
 
 
325
 
<!-- ##### FUNCTION gtk_calendar_set_detail_height_rows ##### -->
326
 
<para>
327
 
 
328
 
</para>
329
 
 
330
 
@calendar: 
331
 
@rows: 
332
 
 
333
 
 
334
 
<!-- ##### FUNCTION gtk_calendar_display_options ##### -->
335
 
<para>
336
 
</para>
337
 
 
338
 
@calendar: 
339
 
@flags: 
340
 
 
341
 
 
342
 
<!-- ##### FUNCTION gtk_calendar_freeze ##### -->
343
 
<para>
344
 
</para>
345
 
 
346
 
@calendar: 
347
 
 
348
 
 
349
 
<!-- ##### FUNCTION gtk_calendar_thaw ##### -->
350
 
<para>
351
 
</para>
352
 
 
353
 
@calendar: 
354
 
 
355