← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/cdk_scroll.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
http://bugs.debian.org/402978
http://bugs.debian.org/416336
http://bugs.debian.org/294709
* 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:
man/cdk_scroll.3
1
1
'\" t
2
 
.\" $Id: cdk_scroll.3,v 1.23 2005/04/24 22:18:38 tom Exp $"
 
2
.\" $Id: cdk_scroll.3,v 1.26 2006/05/07 00:49:10 tom Exp $"
 
3
.de XX
 
4
..
3
5
.TH cdk_scroll 3
4
6
.SH NAME
5
 
activateCDKScroll,
6
 
addCDKScrollItem,
7
 
deleteCDKScrollItem,
8
 
destroyCDKScroll,
9
 
drawCDKScroll,
10
 
eraseCDKScroll,
11
 
getCDKScrollBox,
12
 
getCDKScrollCurrent,
13
 
getCDKScrollHighlight,
14
 
getCDKScrollItems,
15
 
injectCDKScroll,
16
 
insertCDKScrollItem,
17
 
moveCDKScroll,
18
 
newCDKScroll,
19
 
positionCDKScroll,
20
 
setCDKScroll,
21
 
setCDKScrollBackgroundAttrib,
22
 
setCDKScrollBackgroundColor,
23
 
setCDKScrollBox,
24
 
setCDKScrollBoxAttribute,
25
 
setCDKScrollCurrent,
26
 
setCDKScrollHighlight,
27
 
setCDKScrollHorizontalChar,
28
 
setCDKScrollItems,
29
 
setCDKScrollLLChar,
30
 
setCDKScrollLRChar,
31
 
setCDKScrollPosition,
32
 
setCDKScrollPostProcess,
33
 
setCDKScrollPreProcess,
34
 
setCDKScrollULChar,
35
 
setCDKScrollURChar,
36
 
setCDKScrollVerticalChar \- curses scrolling list widget.
 
7
.XX activateCDKScroll
 
8
.XX addCDKScrollItem
 
9
.XX deleteCDKScrollItem
 
10
.XX destroyCDKScroll
 
11
.XX drawCDKScroll
 
12
.XX eraseCDKScroll
 
13
.XX getCDKScrollBox
 
14
.XX getCDKScrollCurrent
 
15
.XX getCDKScrollCurrentItem
 
16
.XX getCDKScrollCurrentTop
 
17
.XX getCDKScrollHighlight
 
18
.XX getCDKScrollItems
 
19
.XX injectCDKScroll
 
20
.XX insertCDKScrollItem
 
21
.XX moveCDKScroll
 
22
.XX newCDKScroll
 
23
.XX positionCDKScroll
 
24
.XX setCDKScroll
 
25
.XX setCDKScrollBackgroundAttrib
 
26
.XX setCDKScrollBackgroundColor
 
27
.XX setCDKScrollBox
 
28
.XX setCDKScrollBoxAttribute
 
29
.XX setCDKScrollCurrent
 
30
.XX setCDKScrollCurrentItem
 
31
.XX setCDKScrollCurrentTop
 
32
.XX setCDKScrollHighlight
 
33
.XX setCDKScrollHorizontalChar
 
34
.XX setCDKScrollItems
 
35
.XX setCDKScrollLLChar
 
36
.XX setCDKScrollLRChar
 
37
.XX setCDKScrollPosition
 
38
.XX setCDKScrollPostProcess
 
39
.XX setCDKScrollPreProcess
 
40
.XX setCDKScrollULChar
 
41
.XX setCDKScrollURChar
 
42
.XX setCDKScrollVerticalChar
 
43
cdk_scroll \- curses scrolling list widget.
37
44
.SH SYNOPSIS
38
45
.LP
39
46
.B cc
72
79
.B "int getCDKScrollCurrent("
73
80
.BI "CDKSCROLL *" "scroll");
74
81
.TP 15
 
82
.B "int getCDKScrollCurrentItem ("
 
83
.BI "CDKSCROLL *" "widget");
 
84
.TP 15
75
85
.B "chtype getCDKScrollHighlight ("
76
86
.BI "CDKSCROLL *" "scroll",
77
87
.BI "chtype " "highlight");
78
88
.TP 15
 
89
.B "int getCDKScrollCurrentTop ("
 
90
.BI "CDKSCROLL *" "widget");
 
91
.TP 15
79
92
.B "int getCDKScrollItems ("
80
93
.BI "CDKSCROLL *" "scroll",
81
94
.BI "char **" "itemList");
141
154
.BI "CDKSCROLL *" "scroll",
142
155
.BI "int" "item");
143
156
.TP 15
 
157
.B "void setCDKScrollCurrentItem ("
 
158
.BI "CDKSCROLL *" "widget",
 
159
.BI "int" "item");
 
160
.TP 15
 
161
.B "int getCDKScrollCurrentTop ("
 
162
.BI "CDKSCROLL *" "widget");
 
163
.TP 15
144
164
.B "void setCDKScrollHighlight ("
145
165
.BI "CDKSCROLL *" "scroll",
146
166
.BI "chtype " "highlight");
242
262
.B getCDKScrollCurrent
243
263
returns the current item's index.
244
264
.TP 5
 
265
.B getCDKScrollCurrentItem
 
266
returns the current item number in the scroller.
 
267
.TP 5
245
268
.B getCDKScrollHighlight
246
269
returns the attribute of the highlight bar.
247
270
.TP 5
 
271
.B getCDKScrollCurrentTop
 
272
returns the top line of the scroller, counting from zero.
 
273
.TP 5
248
274
.B getCDKScrollItems
249
275
fills the parameter \fBitemList\fR with the contents of the scrolling list.
250
276
It returns the number of elements in the scrolling list.
381
407
lets the programmer modify certain elements of an existing
382
408
scroll widget.
383
409
The parameter names correspond to the same parameter names listed
384
 
in the \fInewCDKScroll\fR function.
 
410
in the \fBnewCDKScroll\fR function.
385
411
.TP 5
386
412
.B setCDKScrollBackgroundAttrib
387
413
sets the background attribute of the widget.
402
428
.B setCDKScrollCurrent
403
429
sets the index for the current item.
404
430
.TP 5
 
431
.B setCDKScrollCurrentItem
 
432
set the current item number in the scroller.
 
433
.TP 5
 
434
.B setCDKScrollCurrentTop
 
435
set the top line number of the scroller.
 
436
.TP 5
405
437
.B setCDKScrollHighlight
406
438
sets the attribute of the highlight bar.
407
439
.TP 5