eric7/Documentation/Source/eric7.QScintilla.ShellHistoryDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.QScintilla.ShellHistoryDialog</h1>
24
25 <p>
26 Module implementing the shell history dialog.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#ShellHistoryDialog">ShellHistoryDialog</a></td>
39 <td>Class implementing the shell history dialog.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="ShellHistoryDialog" ID="ShellHistoryDialog"></a>
50 <h2>ShellHistoryDialog</h2>
51
52 <p>
53 Class implementing the shell history dialog.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_ShellHistoryDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#ShellHistoryDialog.__init__">ShellHistoryDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#ShellHistoryDialog.getHistory">getHistory</a></td>
77 <td>Public method to retrieve the history from the dialog.</td>
78 </tr>
79 <tr>
80 <td><a href="#ShellHistoryDialog.on_copyButton_clicked">on_copyButton_clicked</a></td>
81 <td>Private slot to copy the selected entries to the current editor.</td>
82 </tr>
83 <tr>
84 <td><a href="#ShellHistoryDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
85 <td>Private slot to delete the selected entries from the history.</td>
86 </tr>
87 <tr>
88 <td><a href="#ShellHistoryDialog.on_executeButton_clicked">on_executeButton_clicked</a></td>
89 <td>Private slot to execute the selected entries in the shell.</td>
90 </tr>
91 <tr>
92 <td><a href="#ShellHistoryDialog.on_historyList_itemDoubleClicked">on_historyList_itemDoubleClicked</a></td>
93 <td>Private slot to handle a double click of an item.</td>
94 </tr>
95 <tr>
96 <td><a href="#ShellHistoryDialog.on_historyList_itemSelectionChanged">on_historyList_itemSelectionChanged</a></td>
97 <td>Private slot to handle a change of the selection.</td>
98 </tr>
99 <tr>
100 <td><a href="#ShellHistoryDialog.on_reloadButton_clicked">on_reloadButton_clicked</a></td>
101 <td>Private slot to reload the history.</td>
102 </tr>
103 </table>
104 <h3>Static Methods</h3>
105
106 <table>
107 <tr><td>None</td></tr>
108 </table>
109
110 <a NAME="ShellHistoryDialog.__init__" ID="ShellHistoryDialog.__init__"></a>
111 <h4>ShellHistoryDialog (Constructor)</h4>
112 <b>ShellHistoryDialog</b>(<i>history, vm, shell</i>)
113
114 <p>
115 Constructor
116 </p>
117 <dl>
118
119 <dt><i>history</i> (list of str)</dt>
120 <dd>
121 reference to the current shell history
122 </dd>
123 <dt><i>vm</i> (ViewManager)</dt>
124 <dd>
125 reference to the viewmanager object
126 </dd>
127 <dt><i>shell</i> (Shell)</dt>
128 <dd>
129 reference to the shell object
130 </dd>
131 </dl>
132 <a NAME="ShellHistoryDialog.getHistory" ID="ShellHistoryDialog.getHistory"></a>
133 <h4>ShellHistoryDialog.getHistory</h4>
134 <b>getHistory</b>(<i></i>)
135
136 <p>
137 Public method to retrieve the history from the dialog.
138 </p>
139 <dl>
140 <dt>Return:</dt>
141 <dd>
142 tuple containing the list of history entries and the
143 current row
144 </dd>
145 </dl>
146 <dl>
147 <dt>Return Type:</dt>
148 <dd>
149 tuple of (list of str, int)
150 </dd>
151 </dl>
152 <a NAME="ShellHistoryDialog.on_copyButton_clicked" ID="ShellHistoryDialog.on_copyButton_clicked"></a>
153 <h4>ShellHistoryDialog.on_copyButton_clicked</h4>
154 <b>on_copyButton_clicked</b>(<i></i>)
155
156 <p>
157 Private slot to copy the selected entries to the current editor.
158 </p>
159 <a NAME="ShellHistoryDialog.on_deleteButton_clicked" ID="ShellHistoryDialog.on_deleteButton_clicked"></a>
160 <h4>ShellHistoryDialog.on_deleteButton_clicked</h4>
161 <b>on_deleteButton_clicked</b>(<i></i>)
162
163 <p>
164 Private slot to delete the selected entries from the history.
165 </p>
166 <a NAME="ShellHistoryDialog.on_executeButton_clicked" ID="ShellHistoryDialog.on_executeButton_clicked"></a>
167 <h4>ShellHistoryDialog.on_executeButton_clicked</h4>
168 <b>on_executeButton_clicked</b>(<i></i>)
169
170 <p>
171 Private slot to execute the selected entries in the shell.
172 </p>
173 <a NAME="ShellHistoryDialog.on_historyList_itemDoubleClicked" ID="ShellHistoryDialog.on_historyList_itemDoubleClicked"></a>
174 <h4>ShellHistoryDialog.on_historyList_itemDoubleClicked</h4>
175 <b>on_historyList_itemDoubleClicked</b>(<i>item</i>)
176
177 <p>
178 Private slot to handle a double click of an item.
179 </p>
180 <dl>
181
182 <dt><i>item</i></dt>
183 <dd>
184 reference to the item that was double clicked
185 (QListWidgetItem)
186 </dd>
187 </dl>
188 <a NAME="ShellHistoryDialog.on_historyList_itemSelectionChanged" ID="ShellHistoryDialog.on_historyList_itemSelectionChanged"></a>
189 <h4>ShellHistoryDialog.on_historyList_itemSelectionChanged</h4>
190 <b>on_historyList_itemSelectionChanged</b>(<i></i>)
191
192 <p>
193 Private slot to handle a change of the selection.
194 </p>
195 <a NAME="ShellHistoryDialog.on_reloadButton_clicked" ID="ShellHistoryDialog.on_reloadButton_clicked"></a>
196 <h4>ShellHistoryDialog.on_reloadButton_clicked</h4>
197 <b>on_reloadButton_clicked</b>(<i></i>)
198
199 <p>
200 Private slot to reload the history.
201 </p>
202 <div align="right"><a href="#top">Up</a></div>
203 <hr />
204 </body></html>

eric ide

mercurial