Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.QScintilla.Terminal.html

Documentation/Source/eric5.QScintilla.Terminal.html

changeset 1830
f2fccb8c2ab4
parent 1518
e6e21910210d
child 1833
f7cd855680f1
equal deleted inserted replaced
1829:fa72a573967f 1830:f2fccb8c2ab4
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#Terminal">Terminal</a></td> 34 <td><a href="#Terminal">Terminal</a></td>
35 <td>Class implementing a simple terminal based on QScintilla.</td> 35 <td>Class implementing a simple terminal based on QScintilla.</td>
36 </tr><tr>
37 <td><a href="#TerminalAssembly">TerminalAssembly</a></td>
38 <td>Class implementing the containing widget for the terminal.</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>
44 <h2>Terminal</h2> 47 <h2>Terminal</h2>
45 <p> 48 <p>
46 Class implementing a simple terminal based on QScintilla. 49 Class implementing a simple terminal based on QScintilla.
47 </p><p> 50 </p><p>
48 A user can enter commands that are executed by a shell process. 51 A user can enter commands that are executed by a shell process.
49 </p> 52 </p><h3>Signals</h3>
53 <dl>
54 <dt>searchStringFound(found)</dt>
55 <dd>
56 emitted to indicate the search result (boolean)
57 </dd>
58 </dl>
50 <h3>Derived from</h3> 59 <h3>Derived from</h3>
51 QsciScintillaCompat 60 QsciScintillaCompat
52 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
53 <table> 62 <table>
54 <tr><td>None</td></tr> 63 <tr><td>None</td></tr>
139 <td>Private method to open the configuration dialog.</td> 148 <td>Private method to open the configuration dialog.</td>
140 </tr><tr> 149 </tr><tr>
141 <td><a href="#Terminal.__executeCommand">__executeCommand</a></td> 150 <td><a href="#Terminal.__executeCommand">__executeCommand</a></td>
142 <td>Private slot to execute a command.</td> 151 <td>Private slot to execute a command.</td>
143 </tr><tr> 152 </tr><tr>
153 <td><a href="#Terminal.__find">__find</a></td>
154 <td>Private slot to show the find widget.</td>
155 </tr><tr>
144 <td><a href="#Terminal.__finished">__finished</a></td> 156 <td><a href="#Terminal.__finished">__finished</a></td>
145 <td>Private method called, when the shell process has finished.</td> 157 <td>Private method called, when the shell process has finished.</td>
146 </tr><tr> 158 </tr><tr>
147 <td><a href="#Terminal.__getEndPos">__getEndPos</a></td> 159 <td><a href="#Terminal.__getEndPos">__getEndPos</a></td>
148 <td>Private method to return the line and column of the last character.</td> 160 <td>Private method to return the line and column of the last character.</td>
169 <td>Private method used to reverse search the history.</td> 181 <td>Private method used to reverse search the history.</td>
170 </tr><tr> 182 </tr><tr>
171 <td><a href="#Terminal.__searchHistory">__searchHistory</a></td> 183 <td><a href="#Terminal.__searchHistory">__searchHistory</a></td>
172 <td>Private method used to search the history.</td> 184 <td>Private method used to search the history.</td>
173 </tr><tr> 185 </tr><tr>
186 <td><a href="#Terminal.__searchNext">__searchNext</a></td>
187 <td>Private method to search for the next occurrence.</td>
188 </tr><tr>
189 <td><a href="#Terminal.__searchPrev">__searchPrev</a></td>
190 <td>Private method to search for the next occurrence.</td>
191 </tr><tr>
174 <td><a href="#Terminal.__selectHistory">__selectHistory</a></td> 192 <td><a href="#Terminal.__selectHistory">__selectHistory</a></td>
175 <td>Private slot to select a history entry to execute.</td> 193 <td>Private slot to select a history entry to execute.</td>
176 </tr><tr> 194 </tr><tr>
177 <td><a href="#Terminal.__send">__send</a></td> 195 <td><a href="#Terminal.__send">__send</a></td>
178 <td>Private method to send data to the shell process.</td> 196 <td>Private method to send data to the shell process.</td>
252 <td><a href="#Terminal.reloadHistory">reloadHistory</a></td> 270 <td><a href="#Terminal.reloadHistory">reloadHistory</a></td>
253 <td>Public method to reload the history.</td> 271 <td>Public method to reload the history.</td>
254 </tr><tr> 272 </tr><tr>
255 <td><a href="#Terminal.saveHistory">saveHistory</a></td> 273 <td><a href="#Terminal.saveHistory">saveHistory</a></td>
256 <td>Public method to save the history.</td> 274 <td>Public method to save the history.</td>
275 </tr><tr>
276 <td><a href="#Terminal.searchNext">searchNext</a></td>
277 <td>Public method to search the next occurrence of the given text.</td>
278 </tr><tr>
279 <td><a href="#Terminal.searchPrev">searchPrev</a></td>
280 <td>Public method to search the previous occurrence of the given text.</td>
257 </tr><tr> 281 </tr><tr>
258 <td><a href="#Terminal.wheelEvent">wheelEvent</a></td> 282 <td><a href="#Terminal.wheelEvent">wheelEvent</a></td>
259 <td>Protected method to handle wheel events.</td> 283 <td>Protected method to handle wheel events.</td>
260 </tr> 284 </tr>
261 </table> 285 </table>
449 </p><dl> 473 </p><dl>
450 <dt><i>cmd</i></dt> 474 <dt><i>cmd</i></dt>
451 <dd> 475 <dd>
452 command to be executed by debug client (string) 476 command to be executed by debug client (string)
453 </dd> 477 </dd>
454 </dl><a NAME="Terminal.__finished" ID="Terminal.__finished"></a> 478 </dl><a NAME="Terminal.__find" ID="Terminal.__find"></a>
479 <h4>Terminal.__find</h4>
480 <b>__find</b>(<i></i>)
481 <p>
482 Private slot to show the find widget.
483 </p><a NAME="Terminal.__finished" ID="Terminal.__finished"></a>
455 <h4>Terminal.__finished</h4> 484 <h4>Terminal.__finished</h4>
456 <b>__finished</b>(<i></i>) 485 <b>__finished</b>(<i></i>)
457 <p> 486 <p>
458 Private method called, when the shell process has finished. 487 Private method called, when the shell process has finished.
459 </p><a NAME="Terminal.__getEndPos" ID="Terminal.__getEndPos"></a> 488 </p><a NAME="Terminal.__getEndPos" ID="Terminal.__getEndPos"></a>
545 </dl><dl> 574 </dl><dl>
546 <dt>Returns:</dt> 575 <dt>Returns:</dt>
547 <dd> 576 <dd>
548 index of found entry (integer) 577 index of found entry (integer)
549 </dd> 578 </dd>
550 </dl><a NAME="Terminal.__selectHistory" ID="Terminal.__selectHistory"></a> 579 </dl><a NAME="Terminal.__searchNext" ID="Terminal.__searchNext"></a>
580 <h4>Terminal.__searchNext</h4>
581 <b>__searchNext</b>(<i></i>)
582 <p>
583 Private method to search for the next occurrence.
584 </p><a NAME="Terminal.__searchPrev" ID="Terminal.__searchPrev"></a>
585 <h4>Terminal.__searchPrev</h4>
586 <b>__searchPrev</b>(<i></i>)
587 <p>
588 Private method to search for the next occurrence.
589 </p><a NAME="Terminal.__selectHistory" ID="Terminal.__selectHistory"></a>
551 <h4>Terminal.__selectHistory</h4> 590 <h4>Terminal.__selectHistory</h4>
552 <b>__selectHistory</b>(<i></i>) 591 <b>__selectHistory</b>(<i></i>)
553 <p> 592 <p>
554 Private slot to select a history entry to execute. 593 Private slot to select a history entry to execute.
555 </p><a NAME="Terminal.__send" ID="Terminal.__send"></a> 594 </p><a NAME="Terminal.__send" ID="Terminal.__send"></a>
762 </p><a NAME="Terminal.saveHistory" ID="Terminal.saveHistory"></a> 801 </p><a NAME="Terminal.saveHistory" ID="Terminal.saveHistory"></a>
763 <h4>Terminal.saveHistory</h4> 802 <h4>Terminal.saveHistory</h4>
764 <b>saveHistory</b>(<i></i>) 803 <b>saveHistory</b>(<i></i>)
765 <p> 804 <p>
766 Public method to save the history. 805 Public method to save the history.
806 </p><a NAME="Terminal.searchNext" ID="Terminal.searchNext"></a>
807 <h4>Terminal.searchNext</h4>
808 <b>searchNext</b>(<i>txt, caseSensitive, wholeWord</i>)
809 <p>
810 Public method to search the next occurrence of the given text.
811 </p><a NAME="Terminal.searchPrev" ID="Terminal.searchPrev"></a>
812 <h4>Terminal.searchPrev</h4>
813 <b>searchPrev</b>(<i>txt, caseSensitive, wholeWord</i>)
814 <p>
815 Public method to search the previous occurrence of the given text.
767 </p><a NAME="Terminal.wheelEvent" ID="Terminal.wheelEvent"></a> 816 </p><a NAME="Terminal.wheelEvent" ID="Terminal.wheelEvent"></a>
768 <h4>Terminal.wheelEvent</h4> 817 <h4>Terminal.wheelEvent</h4>
769 <b>wheelEvent</b>(<i>evt</i>) 818 <b>wheelEvent</b>(<i>evt</i>)
770 <p> 819 <p>
771 Protected method to handle wheel events. 820 Protected method to handle wheel events.
772 </p><dl> 821 </p><dl>
773 <dt><i>evt</i></dt> 822 <dt><i>evt</i></dt>
774 <dd> 823 <dd>
775 reference to the wheel event (QWheelEvent) 824 reference to the wheel event (QWheelEvent)
825 </dd>
826 </dl>
827 <div align="right"><a href="#top">Up</a></div>
828 <hr /><hr />
829 <a NAME="TerminalAssembly" ID="TerminalAssembly"></a>
830 <h2>TerminalAssembly</h2>
831 <p>
832 Class implementing the containing widget for the terminal.
833 </p>
834 <h3>Derived from</h3>
835 QWidget
836 <h3>Class Attributes</h3>
837 <table>
838 <tr><td>None</td></tr>
839 </table>
840 <h3>Class Methods</h3>
841 <table>
842 <tr><td>None</td></tr>
843 </table>
844 <h3>Methods</h3>
845 <table>
846 <tr>
847 <td><a href="#TerminalAssembly.__init__">TerminalAssembly</a></td>
848 <td>Constructor</td>
849 </tr><tr>
850 <td><a href="#TerminalAssembly.showFind">showFind</a></td>
851 <td>Public method to display the search widget.</td>
852 </tr><tr>
853 <td><a href="#TerminalAssembly.terminal">terminal</a></td>
854 <td>Public method to get a reference to the terminal widget.</td>
855 </tr>
856 </table>
857 <h3>Static Methods</h3>
858 <table>
859 <tr><td>None</td></tr>
860 </table>
861 <a NAME="TerminalAssembly.__init__" ID="TerminalAssembly.__init__"></a>
862 <h4>TerminalAssembly (Constructor)</h4>
863 <b>TerminalAssembly</b>(<i>vm, parent=None</i>)
864 <p>
865 Constructor
866 </p><dl>
867 <dt><i>vm</i></dt>
868 <dd>
869 reference to the viewmanager object
870 </dd><dt><i>parent</i></dt>
871 <dd>
872 reference to the parent widget (QWidget)
873 </dd>
874 </dl><a NAME="TerminalAssembly.showFind" ID="TerminalAssembly.showFind"></a>
875 <h4>TerminalAssembly.showFind</h4>
876 <b>showFind</b>(<i>txt=""</i>)
877 <p>
878 Public method to display the search widget.
879 </p><dl>
880 <dt><i>txt</i></dt>
881 <dd>
882 text to be shown in the combo (string)
883 </dd>
884 </dl><a NAME="TerminalAssembly.terminal" ID="TerminalAssembly.terminal"></a>
885 <h4>TerminalAssembly.terminal</h4>
886 <b>terminal</b>(<i></i>)
887 <p>
888 Public method to get a reference to the terminal widget.
889 </p><dl>
890 <dt>Returns:</dt>
891 <dd>
892 reference to the terminal widget (Terminal)
776 </dd> 893 </dd>
777 </dl> 894 </dl>
778 <div align="right"><a href="#top">Up</a></div> 895 <div align="right"><a href="#top">Up</a></div>
779 <hr /> 896 <hr />
780 </body></html> 897 </body></html>

Mercurial Repository: eric

eric ide

mercurial