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

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

eric ide

mercurial