summaryrefslogtreecommitdiffstats
path: root/doc/html/classQextScintillaCommandSet.html
blob: fc9fff46643087000697145911718bfe4b9889bf (plain)
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
<!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: QextScintillaCommandSet 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&nbsp;Page</span></a></li>
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<h1>QextScintillaCommandSet Class Reference</h1><!-- doxytag: class="QextScintillaCommandSet" -->The <a class="el" href="classQextScintillaCommandSet.html">QextScintillaCommandSet</a> class represents the set of all internal editor commands that may have keys bound.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;qextscintillacommandset.h&gt;</code>
<p>
<a href="classQextScintillaCommandSet-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li>bool <a class="el" href="classQextScintillaCommandSet.html#a6e09aabf6126617ecec01c35fb32e53">readSettings</a> (QSettings &amp;qs, const char *prefix=&quot;/Scintilla&quot;)
<li>bool <a class="el" href="classQextScintillaCommandSet.html#3a4981c26ab30164efbf27d15a4828ee">writeSettings</a> (QSettings &amp;qs, const char *prefix=&quot;/Scintilla&quot;)
<li>QPtrList&lt; <a class="el" href="classQextScintillaCommand.html">QextScintillaCommand</a> &gt; &amp; <a class="el" href="classQextScintillaCommandSet.html#3d5be67e3bbd4cf614c4baa6f8aacc37">commands</a> ()
<li>void <a class="el" href="classQextScintillaCommandSet.html#473747a515d9b554748aa4c25b371cc2">clearKeys</a> ()
<li>void <a class="el" href="classQextScintillaCommandSet.html#497658e87e32bb8d6e9f3859a70e1107">clearAlternateKeys</a> ()
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classQextScintillaCommandSet.html">QextScintillaCommandSet</a> class represents the set of all internal editor commands that may have keys bound. 
<p>
Methods are provided to access the individual commands and to read and write the current bindings from and to settings files. 
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a6e09aabf6126617ecec01c35fb32e53"></a><!-- doxytag: member="QextScintillaCommandSet::readSettings" ref="a6e09aabf6126617ecec01c35fb32e53" args="(QSettings &amp;qs, const char *prefix=&quot;/Scintilla&quot;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool QextScintillaCommandSet::readSettings           </td>
          <td>(</td>
          <td class="paramtype">QSettings &amp;&nbsp;</td>
          <td class="paramname"> <em>qs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>prefix</em> = <code>&quot;/Scintilla&quot;</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The key bindings for each command in the set are read from the settings <em>qs</em>. <em>prefix</em> is prepended to the key of each entry. TRUE is returned if there was no error.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaCommandSet.html#3a4981c26ab30164efbf27d15a4828ee">writeSettings()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="3a4981c26ab30164efbf27d15a4828ee"></a><!-- doxytag: member="QextScintillaCommandSet::writeSettings" ref="3a4981c26ab30164efbf27d15a4828ee" args="(QSettings &amp;qs, const char *prefix=&quot;/Scintilla&quot;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool QextScintillaCommandSet::writeSettings           </td>
          <td>(</td>
          <td class="paramtype">QSettings &amp;&nbsp;</td>
          <td class="paramname"> <em>qs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>prefix</em> = <code>&quot;/Scintilla&quot;</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The key bindings for each command in the set are written to the settings <em>qs</em>. <em>prefix</em> is prepended to the key of each entry. TRUE is returned if there was no error.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaCommandSet.html#a6e09aabf6126617ecec01c35fb32e53">readSettings()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="3d5be67e3bbd4cf614c4baa6f8aacc37"></a><!-- doxytag: member="QextScintillaCommandSet::commands" ref="3d5be67e3bbd4cf614c4baa6f8aacc37" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QPtrList&lt;<a class="el" href="classQextScintillaCommand.html">QextScintillaCommand</a>&gt;&amp; QextScintillaCommandSet::commands           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The commands in the set are returned as a list. 
<p>

</div>
</div><p>
<a class="anchor" name="473747a515d9b554748aa4c25b371cc2"></a><!-- doxytag: member="QextScintillaCommandSet::clearKeys" ref="473747a515d9b554748aa4c25b371cc2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QextScintillaCommandSet::clearKeys           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The primary keys bindings for all commands are removed. 
<p>

</div>
</div><p>
<a class="anchor" name="497658e87e32bb8d6e9f3859a70e1107"></a><!-- doxytag: member="QextScintillaCommandSet::clearAlternateKeys" ref="497658e87e32bb8d6e9f3859a70e1107" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QextScintillaCommandSet::clearAlternateKeys           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The alternate keys bindings for all commands are removed. 
<p>

</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Thu Nov 30 09:32:31 2006 for QScintilla by&nbsp;
<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>