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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>QScintilla: QsciCommand Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</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>
</div>
<div class="contents">
<h1>QsciCommand Class Reference</h1><!-- doxytag: class="QsciCommand" -->
<p>The <a class="el" href="classQsciCommand.html" title="The QsciCommand class represents an internal editor command that may have one or...">QsciCommand</a> class represents an internal editor command that may have one or two keys bound to it.
<a href="#_details">More...</a></p>
<p><code>#include <qscicommand.h></code></p>
<p><a href="classQsciCommand-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li>void <a class="el" href="classQsciCommand.html#a6488ddf82659fcf42d704f787b6cb522">setKey</a> (int key)
<li>void <a class="el" href="classQsciCommand.html#a8c00e5f08abe7ad05fe54653c0f040ae">setAlternateKey</a> (int altkey)
<li>int <a class="el" href="classQsciCommand.html#a6488d872e2ba1b8fbecbf68daf883d81">key</a> () const
<li>int <a class="el" href="classQsciCommand.html#a64fa59b1030c960221443586da3beb44">alternateKey</a> () const
<li><a class="anchor" id="aead61109fb74c74f117942caf3d81a32"></a><!-- doxytag: member="QsciCommand::description" ref="aead61109fb74c74f117942caf3d81a32" args="() const " -->
QString <a class="el" href="classQsciCommand.html#aead61109fb74c74f117942caf3d81a32">description</a> () const
</ul>
<h2>Static Public Member Functions</h2>
<ul>
<li><a class="anchor" id="aeb517d586cb9569d072fcd8a9658911b"></a><!-- doxytag: member="QsciCommand::validKey" ref="aeb517d586cb9569d072fcd8a9658911b" args="(int key)" -->
static bool <a class="el" href="classQsciCommand.html#aeb517d586cb9569d072fcd8a9658911b">validKey</a> (int key)
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classQsciCommand.html" title="The QsciCommand class represents an internal editor command that may have one or...">QsciCommand</a> class represents an internal editor command that may have one or two keys bound to it. </p>
<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" id="a6488ddf82659fcf42d704f787b6cb522"></a><!-- doxytag: member="QsciCommand::setKey" ref="a6488ddf82659fcf42d704f787b6cb522" args="(int key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QsciCommand::setKey </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>key</em></td>
<td> ) </td>
<td></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_PageUp</code>, <code>Key_PageDown</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 class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQsciCommand.html#a6488d872e2ba1b8fbecbf68daf883d81">key()</a>, <a class="el" href="classQsciCommand.html#a8c00e5f08abe7ad05fe54653c0f040ae">setAlternateKey()</a>, <a class="el" href="classQsciCommand.html#aeb517d586cb9569d072fcd8a9658911b" title="If the key key is valid then true is returned.">validKey()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a8c00e5f08abe7ad05fe54653c0f040ae"></a><!-- doxytag: member="QsciCommand::setAlternateKey" ref="a8c00e5f08abe7ad05fe54653c0f040ae" args="(int altkey)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QsciCommand::setAlternateKey </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>altkey</em></td>
<td> ) </td>
<td></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 class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQsciCommand.html#a64fa59b1030c960221443586da3beb44">alternateKey()</a>, <a class="el" href="classQsciCommand.html#a6488ddf82659fcf42d704f787b6cb522">setKey()</a>, <a class="el" href="classQsciCommand.html#aeb517d586cb9569d072fcd8a9658911b" title="If the key key is valid then true is returned.">validKey()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6488d872e2ba1b8fbecbf68daf883d81"></a><!-- doxytag: member="QsciCommand::key" ref="a6488d872e2ba1b8fbecbf68daf883d81" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int QsciCommand::key </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> 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 class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQsciCommand.html#a6488ddf82659fcf42d704f787b6cb522">setKey()</a>, <a class="el" href="classQsciCommand.html#a64fa59b1030c960221443586da3beb44">alternateKey()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a64fa59b1030c960221443586da3beb44"></a><!-- doxytag: member="QsciCommand::alternateKey" ref="a64fa59b1030c960221443586da3beb44" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int QsciCommand::alternateKey </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> 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 class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQsciCommand.html#a8c00e5f08abe7ad05fe54653c0f040ae">setAlternateKey()</a>, <a class="el" href="classQsciCommand.html#a6488d872e2ba1b8fbecbf68daf883d81">key()</a> </dd></dl>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Jan 20 19:56:10 2010 for QScintilla by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
