← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/cdk_binding.3

  • Committer: Bazaar Package Importer
  • Author(s): John Goerzen
  • Date: 2007-06-06 03:54:31 UTC
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20070606035431-1ac5o7r653u6qk8e
Tags: upstream-5.0.20060507
Import upstream version 5.0.20060507

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/cdk_binding.3
1
1
'\" t
2
 
.\" $Id: cdk_binding.3,v 1.19 2005/03/08 23:45:44 tom Exp $
 
2
.\" $Id: cdk_binding.3,v 1.22 2005/12/30 00:01:59 tom Exp $
 
3
.de XX
 
4
..
3
5
.TH cdk_binding 3
4
6
.SH NAME
5
 
bindCDKObject,
6
 
checkCDKObjectBind,
7
 
cleanCDKObjectBindings,
8
 
unbindCDKObject,
9
 
getcCDKObject - \fBCurses Development Kit\fR Character Binding Capabilities.
 
7
.XX bindCDKObject
 
8
.XX checkCDKObjectBind
 
9
.XX cleanCDKObjectBindings
 
10
.XX unbindCDKObject
 
11
.XX getcCDKObject
 
12
.XX getchCDKObject
 
13
cdk_binding - \fBCurses Development Kit\fR Character Binding Capabilities.
10
14
.LP
11
15
.SH SYNOPSIS
12
16
.LP
46
50
.TP 15
47
51
.B "int getcCDKObject ("
48
52
.BI "CDKOBJS *" "object");
 
53
.TP 15
 
54
.B "int getchCDKObject ("
 
55
.BI "CDKOBJS *" "object",
 
56
.BI "boolean *" "functionKey");
49
57
.fi
50
58
.SH DESCRIPTION
51
59
Cdk has the ability to create user definable key bindings.
128
136
.B unbindCDKObject
129
137
removes a specific binding to an object.
130
138
The parameter are
131
 
the same as for \fIbindCDKObject\fR.
 
139
the same as for \fBbindCDKObject\fR.
132
140
.TP 5
133
141
.B getcCDKObject
134
142
reads a keycode from the given widget.
 
143
This is depcrecated: use \fBgetchCDKObject\fP.
 
144
.TP 5
 
145
.B getchCDKObject
 
146
reads a keycode from the given widget.
 
147
It sets a flag to indicate if the result is a function key.
135
148
If the keycode has been bound to the special function \fBgetcCDKBind\fP,
136
149
then it will be translated to the value which was given for the binding data.
137
150
Otherwise, a few special cases are performed:
138
 
 
139
151
.TS
140
152
center tab(/) allbox;
141
153
l l
154
166
carriage return/KEY_ENTER
155
167
newline/KEY_ENTER
156
168
.TE
157
 
 
158
 
All of the widgets use \fBgetcCDKObject\fP internally for consistency.
 
169
.PP
 
170
All of the widgets use \fBgetchCDKObject\fP internally for consistency.
159
171
.SH EXAMPLE
160
172
To help demonstrate how to use the key bindings I will demonstrate a simple
161
173
dialog box widget with help for each button.