|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.QScintilla.ShellHistoryDialog</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.QScintilla.ShellHistoryDialog</h1> |
|
23 <p> |
|
24 Module implementing the shell history dialog. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#ShellHistoryDialog">ShellHistoryDialog</a></td> |
|
34 <td>Class implementing the shell history dialog.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="ShellHistoryDialog" ID="ShellHistoryDialog"></a> |
|
43 <h2>ShellHistoryDialog</h2> |
|
44 <p> |
|
45 Class implementing the shell history dialog. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QDialog, Ui_ShellHistoryDialog |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#ShellHistoryDialog.__init__">ShellHistoryDialog</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#ShellHistoryDialog.getHistory">getHistory</a></td> |
|
64 <td>Public method to retrieve the history from the dialog.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#ShellHistoryDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> |
|
67 <td>Private slot to copy the selected entries to the current editor.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#ShellHistoryDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> |
|
70 <td>Private slot to delete the selected entries from the history.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#ShellHistoryDialog.on_executeButton_clicked">on_executeButton_clicked</a></td> |
|
73 <td>Private slot to execute the selected entries in the shell.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#ShellHistoryDialog.on_historyList_itemDoubleClicked">on_historyList_itemDoubleClicked</a></td> |
|
76 <td>Private slot to handle a double click of an item.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#ShellHistoryDialog.on_historyList_itemSelectionChanged">on_historyList_itemSelectionChanged</a></td> |
|
79 <td>Private slot to handle a change of the selection.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#ShellHistoryDialog.on_reloadButton_clicked">on_reloadButton_clicked</a></td> |
|
82 <td>Private slot to reload the history.</td> |
|
83 </tr> |
|
84 </table> |
|
85 <h3>Static Methods</h3> |
|
86 <table> |
|
87 <tr><td>None</td></tr> |
|
88 </table> |
|
89 <a NAME="ShellHistoryDialog.__init__" ID="ShellHistoryDialog.__init__"></a> |
|
90 <h4>ShellHistoryDialog (Constructor)</h4> |
|
91 <b>ShellHistoryDialog</b>(<i>history, vm, shell</i>) |
|
92 <p> |
|
93 Constructor |
|
94 </p><dl> |
|
95 <dt><i>history</i> (list of str)</dt> |
|
96 <dd> |
|
97 reference to the current shell history |
|
98 </dd><dt><i>vm</i> (ViewManager)</dt> |
|
99 <dd> |
|
100 reference to the viewmanager object |
|
101 </dd><dt><i>shell</i> (Shell)</dt> |
|
102 <dd> |
|
103 reference to the shell object |
|
104 </dd> |
|
105 </dl><a NAME="ShellHistoryDialog.getHistory" ID="ShellHistoryDialog.getHistory"></a> |
|
106 <h4>ShellHistoryDialog.getHistory</h4> |
|
107 <b>getHistory</b>(<i></i>) |
|
108 <p> |
|
109 Public method to retrieve the history from the dialog. |
|
110 </p><dl> |
|
111 <dt>Returns:</dt> |
|
112 <dd> |
|
113 tuple containing the list of history entries and the |
|
114 current row |
|
115 </dd> |
|
116 </dl><dl> |
|
117 <dt>Return Type:</dt> |
|
118 <dd> |
|
119 tuple of (list of str, int) |
|
120 </dd> |
|
121 </dl><a NAME="ShellHistoryDialog.on_copyButton_clicked" ID="ShellHistoryDialog.on_copyButton_clicked"></a> |
|
122 <h4>ShellHistoryDialog.on_copyButton_clicked</h4> |
|
123 <b>on_copyButton_clicked</b>(<i></i>) |
|
124 <p> |
|
125 Private slot to copy the selected entries to the current editor. |
|
126 </p><a NAME="ShellHistoryDialog.on_deleteButton_clicked" ID="ShellHistoryDialog.on_deleteButton_clicked"></a> |
|
127 <h4>ShellHistoryDialog.on_deleteButton_clicked</h4> |
|
128 <b>on_deleteButton_clicked</b>(<i></i>) |
|
129 <p> |
|
130 Private slot to delete the selected entries from the history. |
|
131 </p><a NAME="ShellHistoryDialog.on_executeButton_clicked" ID="ShellHistoryDialog.on_executeButton_clicked"></a> |
|
132 <h4>ShellHistoryDialog.on_executeButton_clicked</h4> |
|
133 <b>on_executeButton_clicked</b>(<i></i>) |
|
134 <p> |
|
135 Private slot to execute the selected entries in the shell. |
|
136 </p><a NAME="ShellHistoryDialog.on_historyList_itemDoubleClicked" ID="ShellHistoryDialog.on_historyList_itemDoubleClicked"></a> |
|
137 <h4>ShellHistoryDialog.on_historyList_itemDoubleClicked</h4> |
|
138 <b>on_historyList_itemDoubleClicked</b>(<i>item</i>) |
|
139 <p> |
|
140 Private slot to handle a double click of an item. |
|
141 </p><dl> |
|
142 <dt><i>item</i></dt> |
|
143 <dd> |
|
144 reference to the item that was double clicked |
|
145 (QListWidgetItem) |
|
146 </dd> |
|
147 </dl><a NAME="ShellHistoryDialog.on_historyList_itemSelectionChanged" ID="ShellHistoryDialog.on_historyList_itemSelectionChanged"></a> |
|
148 <h4>ShellHistoryDialog.on_historyList_itemSelectionChanged</h4> |
|
149 <b>on_historyList_itemSelectionChanged</b>(<i></i>) |
|
150 <p> |
|
151 Private slot to handle a change of the selection. |
|
152 </p><a NAME="ShellHistoryDialog.on_reloadButton_clicked" ID="ShellHistoryDialog.on_reloadButton_clicked"></a> |
|
153 <h4>ShellHistoryDialog.on_reloadButton_clicked</h4> |
|
154 <b>on_reloadButton_clicked</b>(<i></i>) |
|
155 <p> |
|
156 Private slot to reload the history. |
|
157 </p> |
|
158 <div align="right"><a href="#top">Up</a></div> |
|
159 <hr /> |
|
160 </body></html> |