1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>QScintilla: QextScintillaCommand Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<h1>QextScintillaCommand Class Reference</h1><!-- doxytag: class="QextScintillaCommand" -->The <a class="el" href="classQextScintillaCommand.html">QextScintillaCommand</a> class represents an internal editor command that may have one or two keys bound to it.
<a href="#_details">More...</a>
<p>
<code>#include <qextscintillacommand.h></code>
<p>
<a href="classQextScintillaCommand-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li>void <a class="el" href="classQextScintillaCommand.html#5d8f8e66928022855f859f2ef62f98ce">setKey</a> (int key)
<li>void <a class="el" href="classQextScintillaCommand.html#2ceda942ff321060804d2373eecf7ddd">setAlternateKey</a> (int altkey)
<li>int <a class="el" href="classQextScintillaCommand.html#8adefa65b3b42a0e41fd2e440ccd277d">key</a> () const
<li>int <a class="el" href="classQextScintillaCommand.html#b42a52b6cc20d45fcce5838fd409f41d">alternateKey</a> () const
<li>QString <a class="el" href="classQextScintillaCommand.html#76940cf10cf05d99baf3d9b989109777">description</a> () const
</ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>static bool <a class="el" href="classQextScintillaCommand.html#d4d553cb5852576f68d55c5952a2c4d9">validKey</a> (int key)
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classQextScintillaCommand.html">QextScintillaCommand</a> class represents an internal editor command that may have one or two keys bound to it.
<p>
Methods are provided to change the keys bound to the command and to remove a key binding. Each command has a user friendly description of the command for use in key mapping dialogs.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5d8f8e66928022855f859f2ef62f98ce"></a><!-- doxytag: member="QextScintillaCommand::setKey" ref="5d8f8e66928022855f859f2ef62f98ce" args="(int key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QextScintillaCommand::setKey </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Binds the key <em>key</em> to the command. If <em>key</em> is 0 then the key binding is removed. If <em>key</em> is invalid then the key binding is unchanged. Valid keys are any visible or control character or any of <code>Key_Down</code>, <code>Key_Up</code>, <code>Key_Left</code>, <code>Key_Right</code>, <code>Key_Home</code>, <code>Key_End</code>, <code>Key_Prior</code>, <code>Key_Next</code>, <code>Key_Delete</code>, <code>Key_Insert</code>, <code>Key_Escape</code>, <code>Key_Backspace</code>, <code>Key_Tab</code> and <code>Key_Return</code>. Keys may be modified with any combination of <code>SHIFT</code>, <code>CTRL</code> and <code>ALT</code>.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaCommand.html#8adefa65b3b42a0e41fd2e440ccd277d">key()</a>, <a class="el" href="classQextScintillaCommand.html#2ceda942ff321060804d2373eecf7ddd">setAlternateKey()</a>, <a class="el" href="classQextScintillaCommand.html#d4d553cb5852576f68d55c5952a2c4d9">validKey()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="2ceda942ff321060804d2373eecf7ddd"></a><!-- doxytag: member="QextScintillaCommand::setAlternateKey" ref="2ceda942ff321060804d2373eecf7ddd" args="(int altkey)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QextScintillaCommand::setAlternateKey </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>altkey</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Binds the alternate key <em>altkey</em> to the command. If <em>key</em> is 0 then the alternate key binding is removed.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaCommand.html#b42a52b6cc20d45fcce5838fd409f41d">alternateKey()</a>, <a class="el" href="classQextScintillaCommand.html#5d8f8e66928022855f859f2ef62f98ce">setKey()</a>, <a class="el" href="classQextScintillaCommand.html#d4d553cb5852576f68d55c5952a2c4d9">validKey()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="8adefa65b3b42a0e41fd2e440ccd277d"></a><!-- doxytag: member="QextScintillaCommand::key" ref="8adefa65b3b42a0e41fd2e440ccd277d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int QextScintillaCommand::key </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The key that is currently bound to the command is returned.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaCommand.html#5d8f8e66928022855f859f2ef62f98ce">setKey()</a>, <a class="el" href="classQextScintillaCommand.html#b42a52b6cc20d45fcce5838fd409f41d">alternateKey()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="b42a52b6cc20d45fcce5838fd409f41d"></a><!-- doxytag: member="QextScintillaCommand::alternateKey" ref="b42a52b6cc20d45fcce5838fd409f41d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int QextScintillaCommand::alternateKey </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The alternate key that is currently bound to the command is returned.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaCommand.html#2ceda942ff321060804d2373eecf7ddd">setAlternateKey()</a>, <a class="el" href="classQextScintillaCommand.html#8adefa65b3b42a0e41fd2e440ccd277d">key()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="d4d553cb5852576f68d55c5952a2c4d9"></a><!-- doxytag: member="QextScintillaCommand::validKey" ref="d4d553cb5852576f68d55c5952a2c4d9" args="(int key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool QextScintillaCommand::validKey </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the key <em>key</em> is valid then TRUE is returned.
<p>
</div>
</div><p>
<a class="anchor" name="76940cf10cf05d99baf3d9b989109777"></a><!-- doxytag: member="QextScintillaCommand::description" ref="76940cf10cf05d99baf3d9b989109777" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString QextScintillaCommand::description </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The user friendly description of the command is returned.
<p>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Thu Nov 30 09:32:31 2006 for QScintilla by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
|
