~ubuntu-branches/ubuntu/trusty/libcdk5/trusty

« back to all changes in this revision

Viewing changes to man/cdk_calendar.3

  • Committer: Bazaar Package Importer
  • Author(s): John Goerzen
  • Date: 2007-06-06 03:54:31 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20070606035431-ba4gdvw0h6ybffsu
Tags: 5.0.20060507-1
* New upstream release.
* Fixed header patching.  Patch from Robert Schiele.
  Closes: #402978, #416336.
* Update widget count in description.  Closes: #294709.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
'\" t
2
 
.\" $Id: cdk_calendar.3,v 1.19 2005/04/15 23:30:32 tom Exp $"
 
2
.\" $Id: cdk_calendar.3,v 1.22 2005/12/28 18:35:31 tom Exp $"
 
3
.de XX
 
4
..
3
5
.TH cdk_calendar 3
4
6
.SH NAME
5
 
activateCDKCalendar,
6
 
destroyCDKCalendar,
7
 
drawCDKCalendar,
8
 
eraseCDKCalendar,
9
 
getCDKCalendarBox,
10
 
getCDKCalendarDate,
11
 
getCDKCalendarDayAttribute,
12
 
getCDKCalendarHighlight,
13
 
getCDKCalendarMarker,
14
 
getCDKCalendarMonthAttribute,
15
 
getCDKCalendarYearAttribute,
16
 
injectCDKCalendar,
17
 
moveCDKCalendar,
18
 
newCDKCalendar,
19
 
positionCDKCalendar,
20
 
removeCDKCalendarMarker,
21
 
setCDKCalendar,
22
 
setCDKCalendarBackgroundAttrib,
23
 
setCDKCalendarBackgroundColor,
24
 
setCDKCalendarBox,
25
 
setCDKCalendarDate,
26
 
setCDKCalendarDayAttribute,
27
 
setCDKCalendarDaysNames,
28
 
setCDKCalendarHighlight,
29
 
setCDKCalendarMarker,
30
 
setCDKCalendarMonthAttribute,
31
 
setCDKCalendarMonthsNames,
32
 
setCDKCalendarPostProcess,
33
 
setCDKCalendarPreProcess,
34
 
setCDKCalendarYearAttribute \- curses calendar widget.
 
7
.XX activateCDKCalendar
 
8
.XX destroyCDKCalendar
 
9
.XX drawCDKCalendar
 
10
.XX eraseCDKCalendar
 
11
.XX getCDKCalendarBox
 
12
.XX getCDKCalendarDate
 
13
.XX getCDKCalendarDayAttribute
 
14
.XX getCDKCalendarHighlight
 
15
.XX getCDKCalendarMarker
 
16
.XX getCDKCalendarMonthAttribute
 
17
.XX getCDKCalendarYearAttribute
 
18
.XX injectCDKCalendar
 
19
.XX moveCDKCalendar
 
20
.XX newCDKCalendar
 
21
.XX positionCDKCalendar
 
22
.XX removeCDKCalendarMarker
 
23
.XX setCDKCalendar
 
24
.XX setCDKCalendarBackgroundAttrib
 
25
.XX setCDKCalendarBackgroundColor
 
26
.XX setCDKCalendarBox
 
27
.XX setCDKCalendarBoxAttribute
 
28
.XX setCDKCalendarDate
 
29
.XX setCDKCalendarDayAttribute
 
30
.XX setCDKCalendarDaysNames
 
31
.XX setCDKCalendarHighlight
 
32
.XX setCDKCalendarHorizontalChar
 
33
.XX setCDKCalendarLLChar
 
34
.XX setCDKCalendarLRChar
 
35
.XX setCDKCalendarMarker
 
36
.XX setCDKCalendarMonthAttribute
 
37
.XX setCDKCalendarMonthsNames
 
38
.XX setCDKCalendarPostProcess
 
39
.XX setCDKCalendarPreProcess
 
40
.XX setCDKCalendarULChar
 
41
.XX setCDKCalendarURChar
 
42
.XX setCDKCalendarVerticalChar
 
43
.XX setCDKCalendarYearAttribute
 
44
cdk_calendar \- curses calendar widget.
35
45
.SH SYNOPSIS
36
46
.LP
37
47
.B cc
137
147
.BI "CDKCALENDAR *" "calendar",
138
148
.BI "boolean " "box");
139
149
.TP 15
 
150
.B setCDKCalendarBoxAttribute ("
 
151
.BI "CDKCALENDAR *" "calendar",
 
152
.BI "chtype " "ch");
 
153
.TP 15
140
154
.B "void setCDKCalendarDate ("
141
155
.BI "CDKCALENDAR *" "calendar",
142
156
.BI "int " "day",
155
169
.BI "CDKCALENDAR *" "calendar",
156
170
.BI "chtype " "attribute");
157
171
.TP 15
 
172
.B "void setCDKCalendarHorizontalChar ("
 
173
.BI "CDKCALENDAR *" "calendar",
 
174
.BI "chtype " "ch");
 
175
.TP 15
 
176
.B "void setCDKCalendarLLChar ("
 
177
.BI "CDKCALENDAR *" "calendar",
 
178
.BI "chtype " "ch");
 
179
.TP 15
 
180
.B "void setCDKCalendarLRChar ("
 
181
.BI "CDKCALENDAR *" "calendar",
 
182
.BI "chtype " "ch");
 
183
.TP 15
158
184
.B "void setCDKCalendarMarker ("
159
185
.BI "CDKCALENDAR *" "calendar",
160
186
.BI "int " "day",
180
206
.BI "PROCESSFN " "callback",
181
207
.BI "void * " "data");
182
208
.TP 15
 
209
.B setCDKCalendarULChar ("
 
210
.BI "CDKCALENDAR *" "calendar",
 
211
.BI "chtype " "ch");
 
212
.TP 15
 
213
.B setCDKCalendarURChar ("
 
214
.BI "CDKCALENDAR *" "calendar",
 
215
.BI "chtype " "ch");
 
216
.TP 15
 
217
.B setCDKCalendarVerticalChar ("
 
218
.BI "CDKCALENDAR *" "calendar",
 
219
.BI "chtype " "ch");
 
220
.TP 15
183
221
.B "void setCDKCalendarYearAttribute ("
184
222
.BI "CDKCALENDAR *" "calendar",
185
223
.BI "chtype " "attribute");
347
385
calendar widget.
348
386
The \fBcalendar\fR parameter represents an existing calendar pointer.
349
387
The other parameter names correspond to the same parameter names listed
350
 
in the \fInewCDKCalendar\fR function.
 
388
in the \fBnewCDKCalendar\fR function.
351
389
.TP 5
352
390
.B setCDKCalendarBackgroundAttrib
353
391
sets the background attribute of the widget.
362
400
.B setCDKCalendarBox
363
401
sets whether the widget will be drawn with a box around it.
364
402
.TP 5
 
403
.B setCDKCalendarBoxAttribute
 
404
sets the attribute of the box.
 
405
.TP 5
365
406
.B setCDKCalendarDate
366
407
sets the calendar to the given date.
367
408
If the value of the \fBday\fR,
384
425
sets the attribute of the highlight bar of the scrolling
385
426
list portion of the widget.
386
427
.TP 5
 
428
.B setCDKCalendarHorizontalChar
 
429
sets the horizontal drawing character for the box to
 
430
the given character.
 
431
.TP 5
 
432
.B setCDKCalendarLLChar
 
433
sets the lower left hand corner of the widget's box to
 
434
the given character.
 
435
.TP 5
 
436
.B setCDKCalendarLRChar
 
437
sets the lower right hand corner of the widget's box to
 
438
the given character.
 
439
.TP 5
387
440
.B setCDKCalendarMarker
388
441
allows the user to set a marker which will be displayed when the month is drawn.
389
442
The \fBmarker\fR parameter is the attribute to use when drawing the marker.
412
465
The parameter \fBdata\fR points to data passed to the callback function.
413
466
To learn more about pre-processing see \fIcdk_process (3)\fR.
414
467
.TP 5
 
468
.B setCDKCalendarULChar
 
469
sets the upper left hand corner of the widget's box to
 
470
the given character.
 
471
.TP 5
 
472
.B setCDKCalendarURChar
 
473
sets the upper right hand corner of the widget's box to
 
474
the given character.
 
475
.TP 5
 
476
.B setCDKCalendarVerticalChar
 
477
sets the vertical drawing character for the box to
 
478
the given character.
 
479
.TP 5
415
480
.B setCDKCalendarYearAttribute
416
481
sets the attribute of the year in the calendar.
417
482
.SH KEY BINDINGS