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

« back to all changes in this revision

Viewing changes to man/cdk_selection.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_selection.3,v 1.18 2005/04/24 22:21:24 tom Exp $"
 
2
.\" $Id: cdk_selection.3,v 1.22 2005/12/28 21:52:07 tom Exp $"
 
3
.de XX
 
4
..
3
5
.TH cdk_selection 3
4
6
.SH NAME
5
 
activateCDKSelection,
6
 
destroyCDKSelection,
7
 
drawCDKSelection,
8
 
eraseCDKSelection,
9
 
getCDKSelectionBox,
10
 
getCDKSelectionChoice,
11
 
getCDKSelectionChoices,
12
 
getCDKSelectionCurrent,
13
 
getCDKSelectionHighlight,
14
 
getCDKSelectionMode,
15
 
getCDKSelectionModes,
16
 
injectCDKSelection,
17
 
moveCDKSelection,
18
 
newCDKSelection,
19
 
positionCDKSelection,
20
 
setCDKSelection,
21
 
setCDKSelectionBackgroundAttrib,
22
 
setCDKSelectionBackgroundColor,
23
 
setCDKSelectionBox,
24
 
setCDKSelectionBoxAttribute,
25
 
setCDKSelectionChoice,
26
 
setCDKSelectionChoices,
27
 
setCDKSelectionCurrent,
28
 
setCDKSelectionHighlight,
29
 
setCDKSelectionHorizontalChar,
30
 
setCDKSelectionLLChar,
31
 
setCDKSelectionLRChar,
32
 
setCDKSelectionMode,
33
 
setCDKSelectionModes,
34
 
setCDKSelectionPostProcess,
35
 
setCDKSelectionPreProcess,
36
 
setCDKSelectionULChar,
37
 
setCDKSelectionURChar,
38
 
setCDKSelectionVerticalChar \- curses selection list widget.
 
7
.XX activateCDKSelection
 
8
.XX destroyCDKSelection
 
9
.XX drawCDKSelection
 
10
.XX eraseCDKSelection
 
11
.XX getCDKSelectionBox
 
12
.XX getCDKSelectionChoice
 
13
.XX getCDKSelectionChoices
 
14
.XX getCDKSelectionCurrent
 
15
.XX getCDKSelectionHighlight
 
16
.XX getCDKSelectionItems
 
17
.XX getCDKSelectionMode
 
18
.XX getCDKSelectionModes
 
19
.XX getCDKSelectionTitle
 
20
.XX injectCDKSelection
 
21
.XX moveCDKSelection
 
22
.XX newCDKSelection
 
23
.XX positionCDKSelection
 
24
.XX setCDKSelection
 
25
.XX setCDKSelectionBackgroundAttrib
 
26
.XX setCDKSelectionBackgroundColor
 
27
.XX setCDKSelectionBox
 
28
.XX setCDKSelectionBoxAttribute
 
29
.XX setCDKSelectionChoice
 
30
.XX setCDKSelectionChoices
 
31
.XX setCDKSelectionCurrent
 
32
.XX setCDKSelectionHighlight
 
33
.XX setCDKSelectionHorizontalChar
 
34
.XX setCDKSelectionItems
 
35
.XX setCDKSelectionLLChar
 
36
.XX setCDKSelectionLRChar
 
37
.XX setCDKSelectionMode
 
38
.XX setCDKSelectionModes
 
39
.XX setCDKSelectionPostProcess
 
40
.XX setCDKSelectionPreProcess
 
41
.XX setCDKSelectionTitle
 
42
.XX setCDKSelectionULChar
 
43
.XX setCDKSelectionURChar
 
44
.XX setCDKSelectionVerticalChar
 
45
cdk_selection \- curses selection list widget.
39
46
.SH SYNOPSIS
40
47
.LP
41
48
.B cc
76
83
.B "chtype getCDKSelectionHighlight ("
77
84
.BI "CDKSELECTION *" "selection");
78
85
.TP 15
 
86
.B "int getCDKSelectionItems ("
 
87
.BI "CDKSELECTION *" "selection",
 
88
.BI "char **" "list");
 
89
.TP 15
79
90
.B "int getCDKSelectionMode ("
80
91
.BI "CDKSELECTION *" "selection",
81
92
.BI "int " "index");
83
94
.B "int *getCDKSelectionModes ("
84
95
.BI "CDKSELECTION *" "selection");
85
96
.TP 15
 
97
.B "char *getCDKSelectionTitle ("
 
98
.BI "CDKSELECTION *" "selection");
 
99
.TP 15
86
100
.B "int injectCDKSelection ("
87
101
.BI "CDKSELECTION *" "selection",
88
102
.BI "chtype " "input");
116
130
.B "void setCDKSelection ("
117
131
.BI "CDKSELECTION *" "selection",
118
132
.BI "chtype " "highlight",
119
 
.BI "int " "defChoices"[],
 
133
.BI "int *" "defChoices",
120
134
.BI "boolean " "box");
121
135
.TP 15
122
136
.B "void setCDKSelectionBackgroundAttrib ("
142
156
.TP 15
143
157
.B "void setCDKSelectionChoices ("
144
158
.BI "CDKSELECTION *" "selection",
145
 
.BI "int " "choices[]");
 
159
.BI "int *" "choices");
146
160
.TP 15
147
161
.B "void setCDKSelectionCurrent ("
148
162
.BI "CDKSELECTION *" "selection",
156
170
.BI "CDKSELECTION *" "selection",
157
171
.BI "chtype " "character");
158
172
.TP 15
 
173
.B "void setCDKSelectionItems ("
 
174
.BI "CDKSELECTION *" "selection",
 
175
.BI "char **" "list",
 
176
.BI "int " "listSize");
 
177
.TP 15
159
178
.B "void setCDKSelectionLLChar ("
160
179
.BI "CDKSELECTION *" "selection",
161
180
.BI "chtype " "character");
171
190
.TP 15
172
191
.B "void setCDKSelectionModes ("
173
192
.BI "CDKSELECTION *" "selection",
174
 
.BI "int " "modes[]");
 
193
.BI "int *" "modes");
175
194
.TP 15
176
195
.B "void setCDKSelectionPostProcess ("
177
196
.BI "CDKSELECTION *" "selection",
183
202
.BI "PROCESSFN " "callback",
184
203
.BI "void * " "data");
185
204
.TP 15
 
205
.B "void setCDKSelectionTitle ("
 
206
.BI "CDKSELECTION *" "selection",
 
207
.BI "char *" "title");
 
208
.TP 15
186
209
.B "void setCDKSelectionULChar ("
187
210
.BI "CDKSELECTION *" "selection",
188
211
.BI "chtype " "character");
241
264
.B getCDKSelectionHighlight
242
265
returns the attribute of the highlight bar.
243
266
.TP 5
 
267
.B getCDKSelectionItems
 
268
copies the selection-list items into the caller's array
 
269
and returns the number of items in the list.
 
270
.TP 5
244
271
.B getCDKSelectionMode
245
272
returns the selection mode at the given index.
246
273
.TP 5
247
274
.B getCDKSelectionModes
248
275
returns an array of the current modes for the widget.
249
276
.TP 5
 
277
.B getCDKSelectionTitle
 
278
returns the first line of the title of the selection widget.
 
279
The caller must free the returned value.
 
280
.TP 5
250
281
.B injectCDKSelection
251
282
injects a single character into the widget.
252
283
The parameter \fBselection\fR is a pointer to a non-NULL selection widget.
371
402
.B setCDKSelection
372
403
lets the programmer modify certain elements of an existing selection widget.
373
404
The parameter names correspond to the same
374
 
parameter names listed in the \fInewCDKSelection\fR function.
 
405
parameter names listed in the \fBnewCDKSelection\fR function.
375
406
.TP 5
376
407
.B setCDKSelectionBackgroundAttrib
377
408
sets the background attribute of the widget.
404
435
.B setCDKSelectionHorizontalChar
405
436
sets the horizontal drawing character for the box to the given character.
406
437
.TP 5
 
438
.B setCDKSelectionItems
 
439
sets the selection list items.
 
440
.TP 5
407
441
.B setCDKSelectionLLChar
408
442
sets the lower left hand corner of the widget's box to the given character.
409
443
.TP 5
433
467
\fIvoid\fR.
434
468
To learn more about pre-processing see \fIcdk_process (3)\fR.
435
469
.TP 5
 
470
.B setCDKSelectionTitle
 
471
set the selection list's title.
 
472
.TP 5
436
473
.B setCDKSelectionULChar
437
474
sets the upper left hand corner of the widget's box to the given character.
438
475
.TP 5