Documentation/Source/eric5.QScintilla.Shell.html

changeset 1833
f7cd855680f1
parent 1518
e6e21910210d
child 2367
78f6c8193d37
equal deleted inserted replaced
1831:2dd263d670ca 1833:f7cd855680f1
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#Shell">Shell</a></td> 34 <td><a href="#Shell">Shell</a></td>
35 <td>Class implementing a graphical Python shell.</td> 35 <td>Class implementing a graphical Python shell.</td>
36 </tr><tr>
37 <td><a href="#ShellAssembly">ShellAssembly</a></td>
38 <td>Class implementing the containing widget for the shell.</td>
36 </tr> 39 </tr>
37 </table> 40 </table>
38 <h3>Functions</h3> 41 <h3>Functions</h3>
39 <table> 42 <table>
40 <tr><td>None</td></tr> 43 <tr><td>None</td></tr>
45 <p> 48 <p>
46 Class implementing a graphical Python shell. 49 Class implementing a graphical Python shell.
47 </p><p> 50 </p><p>
48 A user can enter commands that are executed in the remote 51 A user can enter commands that are executed in the remote
49 Python interpreter. 52 Python interpreter.
50 </p> 53 </p><h3>Signals</h3>
54 <dl>
55 <dt>searchStringFound(found)</dt>
56 <dd>
57 emitted to indicate the search result (boolean)
58 </dd>
59 </dl>
51 <h3>Derived from</h3> 60 <h3>Derived from</h3>
52 QsciScintillaCompat 61 QsciScintillaCompat
53 <h3>Class Attributes</h3> 62 <h3>Class Attributes</h3>
54 <table> 63 <table>
55 <tr><td>None</td></tr> 64 <tr><td>None</td></tr>
158 <td>Private method to open the configuration dialog.</td> 167 <td>Private method to open the configuration dialog.</td>
159 </tr><tr> 168 </tr><tr>
160 <td><a href="#Shell.__executeCommand">__executeCommand</a></td> 169 <td><a href="#Shell.__executeCommand">__executeCommand</a></td>
161 <td>Private slot to execute a command.</td> 170 <td>Private slot to execute a command.</td>
162 </tr><tr> 171 </tr><tr>
172 <td><a href="#Shell.__find">__find</a></td>
173 <td>Private slot to show the find widget.</td>
174 </tr><tr>
163 <td><a href="#Shell.__getBanner">__getBanner</a></td> 175 <td><a href="#Shell.__getBanner">__getBanner</a></td>
164 <td>Private method to get the banner for the remote interpreter.</td> 176 <td>Private method to get the banner for the remote interpreter.</td>
165 </tr><tr> 177 </tr><tr>
166 <td><a href="#Shell.__getEndPos">__getEndPos</a></td> 178 <td><a href="#Shell.__getEndPos">__getEndPos</a></td>
167 <td>Private method to return the line and column of the last character.</td> 179 <td>Private method to return the line and column of the last character.</td>
200 <td>Private method used to reverse search the history.</td> 212 <td>Private method used to reverse search the history.</td>
201 </tr><tr> 213 </tr><tr>
202 <td><a href="#Shell.__searchHistory">__searchHistory</a></td> 214 <td><a href="#Shell.__searchHistory">__searchHistory</a></td>
203 <td>Private method used to search the history.</td> 215 <td>Private method used to search the history.</td>
204 </tr><tr> 216 </tr><tr>
217 <td><a href="#Shell.__searchNext">__searchNext</a></td>
218 <td>Private method to search for the next occurrence.</td>
219 </tr><tr>
220 <td><a href="#Shell.__searchPrev">__searchPrev</a></td>
221 <td>Private method to search for the next occurrence.</td>
222 </tr><tr>
205 <td><a href="#Shell.__selectHistory">__selectHistory</a></td> 223 <td><a href="#Shell.__selectHistory">__selectHistory</a></td>
206 <td>Private slot to select a history entry to execute.</td> 224 <td>Private slot to select a history entry to execute.</td>
207 </tr><tr> 225 </tr><tr>
208 <td><a href="#Shell.__setAutoCompletion">__setAutoCompletion</a></td> 226 <td><a href="#Shell.__setAutoCompletion">__setAutoCompletion</a></td>
209 <td>Private method to configure the autocompletion function.</td> 227 <td>Private method to configure the autocompletion function.</td>
316 <td><a href="#Shell.reloadHistory">reloadHistory</a></td> 334 <td><a href="#Shell.reloadHistory">reloadHistory</a></td>
317 <td>Public method to reload the history of the currently selected client type.</td> 335 <td>Public method to reload the history of the currently selected client type.</td>
318 </tr><tr> 336 </tr><tr>
319 <td><a href="#Shell.saveHistory">saveHistory</a></td> 337 <td><a href="#Shell.saveHistory">saveHistory</a></td>
320 <td>Public method to save the history for the given client type.</td> 338 <td>Public method to save the history for the given client type.</td>
339 </tr><tr>
340 <td><a href="#Shell.searchNext">searchNext</a></td>
341 <td>Public method to search the next occurrence of the given text.</td>
342 </tr><tr>
343 <td><a href="#Shell.searchPrev">searchPrev</a></td>
344 <td>Public method to search the previous occurrence of the given text.</td>
321 </tr><tr> 345 </tr><tr>
322 <td><a href="#Shell.setDebuggerUI">setDebuggerUI</a></td> 346 <td><a href="#Shell.setDebuggerUI">setDebuggerUI</a></td>
323 <td>Public method to set the debugger UI.</td> 347 <td>Public method to set the debugger UI.</td>
324 </tr><tr> 348 </tr><tr>
325 <td><a href="#Shell.wheelEvent">wheelEvent</a></td> 349 <td><a href="#Shell.wheelEvent">wheelEvent</a></td>
589 </p><dl> 613 </p><dl>
590 <dt><i>cmd</i></dt> 614 <dt><i>cmd</i></dt>
591 <dd> 615 <dd>
592 command to be executed by debug client (string) 616 command to be executed by debug client (string)
593 </dd> 617 </dd>
594 </dl><a NAME="Shell.__getBanner" ID="Shell.__getBanner"></a> 618 </dl><a NAME="Shell.__find" ID="Shell.__find"></a>
619 <h4>Shell.__find</h4>
620 <b>__find</b>(<i></i>)
621 <p>
622 Private slot to show the find widget.
623 </p><a NAME="Shell.__getBanner" ID="Shell.__getBanner"></a>
595 <h4>Shell.__getBanner</h4> 624 <h4>Shell.__getBanner</h4>
596 <b>__getBanner</b>(<i></i>) 625 <b>__getBanner</b>(<i></i>)
597 <p> 626 <p>
598 Private method to get the banner for the remote interpreter. 627 Private method to get the banner for the remote interpreter.
599 </p><p> 628 </p><p>
721 </dl><dl> 750 </dl><dl>
722 <dt>Returns:</dt> 751 <dt>Returns:</dt>
723 <dd> 752 <dd>
724 index of found entry (integer) 753 index of found entry (integer)
725 </dd> 754 </dd>
726 </dl><a NAME="Shell.__selectHistory" ID="Shell.__selectHistory"></a> 755 </dl><a NAME="Shell.__searchNext" ID="Shell.__searchNext"></a>
756 <h4>Shell.__searchNext</h4>
757 <b>__searchNext</b>(<i></i>)
758 <p>
759 Private method to search for the next occurrence.
760 </p><a NAME="Shell.__searchPrev" ID="Shell.__searchPrev"></a>
761 <h4>Shell.__searchPrev</h4>
762 <b>__searchPrev</b>(<i></i>)
763 <p>
764 Private method to search for the next occurrence.
765 </p><a NAME="Shell.__selectHistory" ID="Shell.__selectHistory"></a>
727 <h4>Shell.__selectHistory</h4> 766 <h4>Shell.__selectHistory</h4>
728 <b>__selectHistory</b>(<i></i>) 767 <b>__selectHistory</b>(<i></i>)
729 <p> 768 <p>
730 Private slot to select a history entry to execute. 769 Private slot to select a history entry to execute.
731 </p><a NAME="Shell.__setAutoCompletion" ID="Shell.__setAutoCompletion"></a> 770 </p><a NAME="Shell.__setAutoCompletion" ID="Shell.__setAutoCompletion"></a>
1087 </p><dl> 1126 </p><dl>
1088 <dt><i>clientType</i></dt> 1127 <dt><i>clientType</i></dt>
1089 <dd> 1128 <dd>
1090 type of the debug client (string) 1129 type of the debug client (string)
1091 </dd> 1130 </dd>
1131 </dl><a NAME="Shell.searchNext" ID="Shell.searchNext"></a>
1132 <h4>Shell.searchNext</h4>
1133 <b>searchNext</b>(<i>txt, caseSensitive, wholeWord</i>)
1134 <p>
1135 Public method to search the next occurrence of the given text.
1136 </p><dl>
1137 <dt><i>txt</i></dt>
1138 <dd>
1139 text to search for (string)
1140 </dd><dt><i>caseSensitive</i></dt>
1141 <dd>
1142 flag indicating to perform a case sensitive
1143 search (boolean)
1144 </dd><dt><i>wholeWord</i></dt>
1145 <dd>
1146 flag indicating to search for whole words
1147 only (boolean)
1148 </dd>
1149 </dl><a NAME="Shell.searchPrev" ID="Shell.searchPrev"></a>
1150 <h4>Shell.searchPrev</h4>
1151 <b>searchPrev</b>(<i>txt, caseSensitive, wholeWord</i>)
1152 <p>
1153 Public method to search the previous occurrence of the given text.
1154 </p><dl>
1155 <dt><i>txt</i></dt>
1156 <dd>
1157 text to search for (string)
1158 </dd><dt><i>caseSensitive</i></dt>
1159 <dd>
1160 flag indicating to perform a case sensitive
1161 search (boolean)
1162 </dd><dt><i>wholeWord</i></dt>
1163 <dd>
1164 flag indicating to search for whole words
1165 only (boolean)
1166 </dd>
1092 </dl><a NAME="Shell.setDebuggerUI" ID="Shell.setDebuggerUI"></a> 1167 </dl><a NAME="Shell.setDebuggerUI" ID="Shell.setDebuggerUI"></a>
1093 <h4>Shell.setDebuggerUI</h4> 1168 <h4>Shell.setDebuggerUI</h4>
1094 <b>setDebuggerUI</b>(<i>ui</i>) 1169 <b>setDebuggerUI</b>(<i>ui</i>)
1095 <p> 1170 <p>
1096 Public method to set the debugger UI. 1171 Public method to set the debugger UI.
1106 Protected method to handle wheel events. 1181 Protected method to handle wheel events.
1107 </p><dl> 1182 </p><dl>
1108 <dt><i>evt</i></dt> 1183 <dt><i>evt</i></dt>
1109 <dd> 1184 <dd>
1110 reference to the wheel event (QWheelEvent) 1185 reference to the wheel event (QWheelEvent)
1186 </dd>
1187 </dl>
1188 <div align="right"><a href="#top">Up</a></div>
1189 <hr /><hr />
1190 <a NAME="ShellAssembly" ID="ShellAssembly"></a>
1191 <h2>ShellAssembly</h2>
1192 <p>
1193 Class implementing the containing widget for the shell.
1194 </p>
1195 <h3>Derived from</h3>
1196 QWidget
1197 <h3>Class Attributes</h3>
1198 <table>
1199 <tr><td>None</td></tr>
1200 </table>
1201 <h3>Class Methods</h3>
1202 <table>
1203 <tr><td>None</td></tr>
1204 </table>
1205 <h3>Methods</h3>
1206 <table>
1207 <tr>
1208 <td><a href="#ShellAssembly.__init__">ShellAssembly</a></td>
1209 <td>Constructor</td>
1210 </tr><tr>
1211 <td><a href="#ShellAssembly.shell">shell</a></td>
1212 <td>Public method to get a reference to the terminal widget.</td>
1213 </tr><tr>
1214 <td><a href="#ShellAssembly.showFind">showFind</a></td>
1215 <td>Public method to display the search widget.</td>
1216 </tr>
1217 </table>
1218 <h3>Static Methods</h3>
1219 <table>
1220 <tr><td>None</td></tr>
1221 </table>
1222 <a NAME="ShellAssembly.__init__" ID="ShellAssembly.__init__"></a>
1223 <h4>ShellAssembly (Constructor)</h4>
1224 <b>ShellAssembly</b>(<i>dbs, vm, horizontal=True, parent=None</i>)
1225 <p>
1226 Constructor
1227 </p><dl>
1228 <dt><i>dbs</i></dt>
1229 <dd>
1230 reference to the debug server object
1231 </dd><dt><i>vm</i></dt>
1232 <dd>
1233 reference to the viewmanager object
1234 </dd><dt><i>horizontal</i></dt>
1235 <dd>
1236 flag indicating a horizontal layout (boolean)
1237 </dd><dt><i>parent</i></dt>
1238 <dd>
1239 parent widget (QWidget)
1240 </dd>
1241 </dl><a NAME="ShellAssembly.shell" ID="ShellAssembly.shell"></a>
1242 <h4>ShellAssembly.shell</h4>
1243 <b>shell</b>(<i></i>)
1244 <p>
1245 Public method to get a reference to the terminal widget.
1246 </p><dl>
1247 <dt>Returns:</dt>
1248 <dd>
1249 reference to the terminal widget (Terminal)
1250 </dd>
1251 </dl><a NAME="ShellAssembly.showFind" ID="ShellAssembly.showFind"></a>
1252 <h4>ShellAssembly.showFind</h4>
1253 <b>showFind</b>(<i>txt=""</i>)
1254 <p>
1255 Public method to display the search widget.
1256 </p><dl>
1257 <dt><i>txt</i></dt>
1258 <dd>
1259 text to be shown in the combo (string)
1111 </dd> 1260 </dd>
1112 </dl> 1261 </dl>
1113 <div align="right"><a href="#top">Up</a></div> 1262 <div align="right"><a href="#top">Up</a></div>
1114 <hr /> 1263 <hr />
1115 </body></html> 1264 </body></html>

eric ide

mercurial