eric6/Documentation/Source/eric6.QScintilla.ShellHistoryDialog.html

<!DOCTYPE html>
<html><head>
<title>eric6.QScintilla.ShellHistoryDialog</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric6.QScintilla.ShellHistoryDialog</h1>

<p>
Module implementing the shell history dialog.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#ShellHistoryDialog">ShellHistoryDialog</a></td>
<td>Class implementing the shell history dialog.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="ShellHistoryDialog" ID="ShellHistoryDialog"></a>
<h2>ShellHistoryDialog</h2>

<p>
    Class implementing the shell history dialog.
</p>
<h3>Derived from</h3>
QDialog, Ui_ShellHistoryDialog
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#ShellHistoryDialog.__init__">ShellHistoryDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#ShellHistoryDialog.getHistory">getHistory</a></td>
<td>Public method to retrieve the history from the dialog.</td>
</tr>
<tr>
<td><a href="#ShellHistoryDialog.on_copyButton_clicked">on_copyButton_clicked</a></td>
<td>Private slot to copy the selected entries to the current editor.</td>
</tr>
<tr>
<td><a href="#ShellHistoryDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
<td>Private slot to delete the selected entries from the history.</td>
</tr>
<tr>
<td><a href="#ShellHistoryDialog.on_executeButton_clicked">on_executeButton_clicked</a></td>
<td>Private slot to execute the selected entries in the shell.</td>
</tr>
<tr>
<td><a href="#ShellHistoryDialog.on_historyList_itemDoubleClicked">on_historyList_itemDoubleClicked</a></td>
<td>Private slot to handle a double click of an item.</td>
</tr>
<tr>
<td><a href="#ShellHistoryDialog.on_historyList_itemSelectionChanged">on_historyList_itemSelectionChanged</a></td>
<td>Private slot to handle a change of the selection.</td>
</tr>
<tr>
<td><a href="#ShellHistoryDialog.on_reloadButton_clicked">on_reloadButton_clicked</a></td>
<td>Private slot to reload the history.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="ShellHistoryDialog.__init__" ID="ShellHistoryDialog.__init__"></a>
<h4>ShellHistoryDialog (Constructor)</h4>
<b>ShellHistoryDialog</b>(<i>history, vm, shell</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>history</i> (list of str)</dt>
<dd>
reference to the current shell history
</dd>
<dt><i>vm</i> (ViewManager)</dt>
<dd>
reference to the viewmanager object
</dd>
<dt><i>shell</i> (Shell)</dt>
<dd>
reference to the shell object
</dd>
</dl>
<a NAME="ShellHistoryDialog.getHistory" ID="ShellHistoryDialog.getHistory"></a>
<h4>ShellHistoryDialog.getHistory</h4>
<b>getHistory</b>(<i></i>)

<p>
        Public method to retrieve the history from the dialog.
</p>
<dl>
<dt>Returns:</dt>
<dd>
tuple containing the list of history entries and the
            current row
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (list of str, int)
</dd>
</dl>
<a NAME="ShellHistoryDialog.on_copyButton_clicked" ID="ShellHistoryDialog.on_copyButton_clicked"></a>
<h4>ShellHistoryDialog.on_copyButton_clicked</h4>
<b>on_copyButton_clicked</b>(<i></i>)

<p>
        Private slot to copy the selected entries to the current editor.
</p>
<a NAME="ShellHistoryDialog.on_deleteButton_clicked" ID="ShellHistoryDialog.on_deleteButton_clicked"></a>
<h4>ShellHistoryDialog.on_deleteButton_clicked</h4>
<b>on_deleteButton_clicked</b>(<i></i>)

<p>
        Private slot to delete the selected entries from the history.
</p>
<a NAME="ShellHistoryDialog.on_executeButton_clicked" ID="ShellHistoryDialog.on_executeButton_clicked"></a>
<h4>ShellHistoryDialog.on_executeButton_clicked</h4>
<b>on_executeButton_clicked</b>(<i></i>)

<p>
        Private slot to execute the selected entries in the shell.
</p>
<a NAME="ShellHistoryDialog.on_historyList_itemDoubleClicked" ID="ShellHistoryDialog.on_historyList_itemDoubleClicked"></a>
<h4>ShellHistoryDialog.on_historyList_itemDoubleClicked</h4>
<b>on_historyList_itemDoubleClicked</b>(<i>item</i>)

<p>
        Private slot to handle a double click of an item.
</p>
<dl>

<dt><i>item</i></dt>
<dd>
reference to the item that was double clicked
            (QListWidgetItem)
</dd>
</dl>
<a NAME="ShellHistoryDialog.on_historyList_itemSelectionChanged" ID="ShellHistoryDialog.on_historyList_itemSelectionChanged"></a>
<h4>ShellHistoryDialog.on_historyList_itemSelectionChanged</h4>
<b>on_historyList_itemSelectionChanged</b>(<i></i>)

<p>
        Private slot to handle a change of the selection.
</p>
<a NAME="ShellHistoryDialog.on_reloadButton_clicked" ID="ShellHistoryDialog.on_reloadButton_clicked"></a>
<h4>ShellHistoryDialog.on_reloadButton_clicked</h4>
<b>on_reloadButton_clicked</b>(<i></i>)

<p>
        Private slot to reload the history.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>