← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/cdk_fselect.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_fselect.3
1
1
'\" t
2
 
.\" $Id: cdk_fselect.3,v 1.19 2005/04/15 23:40:49 tom Exp $
 
2
.\" $Id: cdk_fselect.3,v 1.24 2006/05/07 01:00:01 tom Exp $
 
3
.de XX
 
4
..
3
5
.TH cdk_fselect 3
4
6
.SH NAME
5
 
activateCDKFselect,
6
 
destroyCDKFselect,
7
 
drawCDKFselect,
8
 
eraseCDKFselect,
9
 
getCDKFselectBox,
10
 
getCDKFselectDirAttribute,
11
 
getCDKFselectDirectory,
12
 
getCDKFselectFileAttribute,
13
 
getCDKFselectFillerChar,
14
 
getCDKFselectHighlight,
15
 
getCDKFselectLinkAttribute,
16
 
getCDKFselectSocketAttribute,
17
 
injectCDKFselect,
18
 
moveCDKFselect,
19
 
newCDKFselect,
20
 
positionCDKFselect,
21
 
setCDKFselect,
22
 
setCDKFselectBackgroundAttrib,
23
 
setCDKFselectBackgroundColor,
24
 
setCDKFselectBox,
25
 
setCDKFselectBoxAttribute,
26
 
setCDKFselectDirAttribute,
27
 
setCDKFselectDirectory,
28
 
setCDKFselectFileAttribute,
29
 
setCDKFselectFillerChar,
30
 
setCDKFselectHighlight,
31
 
setCDKFselectHorizontalChar,
32
 
setCDKFselectLLChar,
33
 
setCDKFselectLRChar,
34
 
setCDKFselectLinkAttribute,
35
 
setCDKFselectSocketAttribute,
36
 
setCDKFselectULChar,
37
 
setCDKFselectURChar,
38
 
setCDKFselectVerticalChar \- curses file selector widget.
 
7
.XX activateCDKFselect
 
8
.XX deleteFileCB
 
9
.XX destroyCDKFselect
 
10
.XX drawCDKFselect
 
11
.XX eraseCDKFselect
 
12
.XX getCDKFselectBox
 
13
.XX getCDKFselectContents
 
14
.XX getCDKFselectCurrentItem
 
15
.XX getCDKFselectDirAttribute
 
16
.XX getCDKFselectDirContents
 
17
.XX getCDKFselectDirectory
 
18
.XX getCDKFselectFileAttribute
 
19
.XX getCDKFselectFillerChar
 
20
.XX getCDKFselectHighlight
 
21
.XX getCDKFselectLinkAttribute
 
22
.XX getCDKFselectSocketAttribute
 
23
.XX injectCDKFselect
 
24
.XX moveCDKFselect
 
25
.XX newCDKFselect
 
26
.XX positionCDKFselect
 
27
.XX setCDKFselect
 
28
.XX setCDKFselectBackgroundAttrib
 
29
.XX setCDKFselectBackgroundColor
 
30
.XX setCDKFselectBox
 
31
.XX setCDKFselectBoxAttribute
 
32
.XX setCDKFselectContents
 
33
.XX setCDKFselectCurrentItem
 
34
.XX setCDKFselectDirAttribute
 
35
.XX setCDKFselectDirContents
 
36
.XX setCDKFselectDirectory
 
37
.XX setCDKFselectFileAttribute
 
38
.XX setCDKFselectFillerChar
 
39
.XX setCDKFselectHighlight
 
40
.XX setCDKFselectHorizontalChar
 
41
.XX setCDKFselectLLChar
 
42
.XX setCDKFselectLRChar
 
43
.XX setCDKFselectLinkAttribute
 
44
.XX setCDKFselectSocketAttribute
 
45
.XX setCDKFselectULChar
 
46
.XX setCDKFselectURChar
 
47
.XX setCDKFselectVerticalChar
 
48
cdk_fselect \- curses file selector widget.
39
49
.SH SYNOPSIS
40
50
.LP
41
51
.B cc
50
60
.BI "CDKFSELECT *" "fselect",
51
61
.BI "chtype *" "actions");
52
62
.TP 15
 
63
.B "void deleteFileCB ("
 
64
.BI "EObjectType " "objectType",
 
65
.BI "void *" "object",
 
66
.BI "void *" "clientData");
 
67
.TP 15
53
68
.B "void destroyCDKFselect ("
54
69
.BI "CDKFSELECT *" "fselect");
55
70
.TP 15
63
78
.B "boolean getCDKFselectBox ("
64
79
.BI "CDKFSELECT *" "fselect");
65
80
.TP 15
 
81
.B "char **getCDKFselectContents ("
 
82
.BI "CDKFSELECT *" "widget",
 
83
.BI "int *" "size");
 
84
.TP 15
 
85
.B "int getCDKFselectCurrentItem ("
 
86
.BI "CDKFSELECT *" "widget");
 
87
.TP 15
66
88
.B "char *getCDKFselectDirAttribute ("
67
89
.BI "CDKFSELECT *" "fselect");
68
90
.TP 15
 
91
.B "char **getCDKFselectDirContents ("
 
92
.BI "CDKFSELECT *"  "fselect",
 
93
.BI "int *" "count");
 
94
.TP 15
69
95
.B "char *getCDKFselectDirectory ("
70
96
.BI "CDKFSELECT *" "fselect");
71
97
.TP 15
144
170
.BI "CDKFSELECT *" "fselect",
145
171
.BI "chtype " "character");
146
172
.TP 15
 
173
.B "void setCDKFselectContents ("
 
174
.BI "CDKFSELECT *" "widget",
 
175
.BI "char **" "list",
 
176
.BI "int " "listSize");
 
177
.TP 15
 
178
.B "void setCDKFselectCurrentItem ("
 
179
.BI "CDKFSELECT *" "widget",
 
180
.BI "int " "item");
 
181
.TP 15
147
182
.B "void setCDKFselectDirAttribute ("
148
183
.BI "CDKFSELECT *" "fselect",
149
184
.BI "char *" "attribute");
150
185
.TP 15
 
186
.B "int setCDKFselectDirContents ("
 
187
.BI "CDKFSELECT *" "fselect");
 
188
.TP 15
151
189
.B "int setCDKFselectDirectory ("
152
190
.BI "CDKFSELECT *" "fselect",
153
191
.BI "char *" "directory");
218
256
If the character
219
257
entered was \fIESCAPE\fR then the function will return \fINULL\fR pointer and
220
258
the widget data \fIexitType\fR is set to \fIvESCAPE_HIT\fR.
 
259
void deleteFileCB (EObjectType objectType GCC_UNUSED, void *object, void *clientData)
 
260
.TP 5
 
261
.B deleteFileCB
 
262
Prompts the user to confirm,
 
263
and deletes the current item in the file-list.
221
264
.TP 5
222
265
.B destroyCDKFselect
223
266
removes the widget from the screen and frees memory the object used.
233
276
.B getCDKFselectBox
234
277
returns true if the widget will be drawn with a box around it.
235
278
.TP 5
 
279
.B getCDKFselectContents
 
280
returns the directory-contents (which are formatted),
 
281
and sets the number of entries via the \fIsize\fP parameter.
 
282
.TP 5
 
283
.B getCDKFselectCurrentItem
 
284
returns the current position in the scroll-widget.
 
285
.TP 5
236
286
.B getCDKFselectDirAttribute
237
287
returns the attribute that directories are drawn with in the
238
288
scrolling region of the widget.
 
289
.TP
 
290
.B getCDKFselectDirContents
 
291
returns the list of files and the corresponding count as a side-effect.
 
292
If no files are found, this function returns zero, otherwise one.
239
293
.TP 5
240
294
.B getCDKFselectDirectory
241
295
returns the current directory of the widget.
374
428
.B setCDKFselect
375
429
lets the programmer modify certain elements of an existing fselect widget.
376
430
The parameter names correspond to the same parameter
377
 
names listed in the \fInewCDKFselect\fR function.
 
431
names listed in the \fBnewCDKFselect\fR function.
378
432
.TP 5
379
433
.B setCDKFselectBackgroundAttrib
380
434
sets the background attribute of the widget.
392
446
.B setCDKFselectBoxAttribute
393
447
sets the attribute of the box.
394
448
.TP 5
 
449
.B setCDKFselectContents
 
450
sets the contents of the widget.
 
451
.TP 5
 
452
.B setCDKFselectCurrentItem
 
453
set the current position in the scroll-widget.
 
454
.TP 5
395
455
.B setCDKFselectDirAttribute
396
456
sets the attribute that directories will be drawn with in the scrolling
397
457
region of the widget.
 
458
.B
 
459
.B setCDKFselectDirContents
 
460
This creates a list of the files in the current directory.
 
461
See \fBgetCDKFselectDirContents\FP.
398
462
.TP 5
399
463
.B setCDKFselectDirectory
400
464
sets the current directory of the widget.