eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7370
5fb53279f2df
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,332 +18,450 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog</h1>
+
 <p>
 Module implementing Mercurial shelve browser dialog.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
+
 <tr>
 <td><a href="#HgShelveBrowserDialog">HgShelveBrowserDialog</a></td>
 <td>Class implementing Mercurial shelve browser dialog.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="HgShelveBrowserDialog" ID="HgShelveBrowserDialog"></a>
 <h2>HgShelveBrowserDialog</h2>
+
 <p>
     Class implementing Mercurial shelve browser dialog.
 </p>
 <h3>Derived from</h3>
 QWidget, Ui_HgShelveBrowserDialog
 <h3>Class Attributes</h3>
+
 <table>
 <tr><td>AgeColumn</td></tr><tr><td>MessageColumn</td></tr><tr><td>NameColumn</td></tr>
 </table>
 <h3>Class Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+
 <table>
+
 <tr>
 <td><a href="#HgShelveBrowserDialog.__init__">HgShelveBrowserDialog</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__cleanupShelves">__cleanupShelves</a></td>
 <td>Private slot to delete all shelves.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__deleteShelves">__deleteShelves</a></td>
 <td>Private slot to delete the selected shelves.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__finish">__finish</a></td>
 <td>Private slot called when the process finished or the user pressed the button.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__generateShelveEntry">__generateShelveEntry</a></td>
 <td>Private method to generate the shelve items.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__getShelveEntries">__getShelveEntries</a></td>
 <td>Private method to retrieve the list of shelves.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__procFinished">__procFinished</a></td>
 <td>Private slot connected to the finished signal.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__processBuffer">__processBuffer</a></td>
 <td>Private method to process the buffered output of the hg shelve command.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__readStderr">__readStderr</a></td>
 <td>Private slot to handle the readyReadStandardError signal.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__readStdout">__readStdout</a></td>
 <td>Private slot to handle the readyReadStandardOutput signal.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__resetUI">__resetUI</a></td>
 <td>Private method to reset the user interface.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__resizeColumnsShelves">__resizeColumnsShelves</a></td>
 <td>Private method to resize the shelve list columns.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__showError">__showError</a></td>
 <td>Private slot to show some error.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.__unshelve">__unshelve</a></td>
 <td>Private slot to restore the selected shelve of changes.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.closeEvent">closeEvent</a></td>
 <td>Protected slot implementing a close event handler.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.keyPressEvent">keyPressEvent</a></td>
 <td>Protected slot to handle a key press event.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
 <td>Private slot called by a button of the button box clicked.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.on_input_returnPressed">on_input_returnPressed</a></td>
 <td>Private slot to handle the press of the return key in the input field.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
 <td>Private slot to handle the password checkbox toggled.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
 <td>Private slot to refresh the list of shelves.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
 <td>Private slot to send the input to the mercurial process.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.on_shelveList_currentItemChanged">on_shelveList_currentItemChanged</a></td>
 <td>Private slot called, when the current item of the shelve list changes.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.on_shelveList_customContextMenuRequested">on_shelveList_customContextMenuRequested</a></td>
 <td>Private slot to show the context menu of the shelve list.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.show">show</a></td>
 <td>Public slot to show the dialog.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgShelveBrowserDialog.start">start</a></td>
 <td>Public slot to start the hg shelve command.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="HgShelveBrowserDialog.__init__" ID="HgShelveBrowserDialog.__init__"></a>
 <h4>HgShelveBrowserDialog (Constructor)</h4>
 <b>HgShelveBrowserDialog</b>(<i>vcs, parent=None</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>vcs</i></dt>
 <dd>
 reference to the vcs object
-</dd><dt><i>parent</i></dt>
+</dd>
+<dt><i>parent</i></dt>
 <dd>
 parent widget (QWidget)
 </dd>
-</dl><a NAME="HgShelveBrowserDialog.__cleanupShelves" ID="HgShelveBrowserDialog.__cleanupShelves"></a>
+</dl>
+<a NAME="HgShelveBrowserDialog.__cleanupShelves" ID="HgShelveBrowserDialog.__cleanupShelves"></a>
 <h4>HgShelveBrowserDialog.__cleanupShelves</h4>
 <b>__cleanupShelves</b>(<i></i>)
+
 <p>
         Private slot to delete all shelves.
-</p><a NAME="HgShelveBrowserDialog.__deleteShelves" ID="HgShelveBrowserDialog.__deleteShelves"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.__deleteShelves" ID="HgShelveBrowserDialog.__deleteShelves"></a>
 <h4>HgShelveBrowserDialog.__deleteShelves</h4>
 <b>__deleteShelves</b>(<i></i>)
+
 <p>
         Private slot to delete the selected shelves.
-</p><a NAME="HgShelveBrowserDialog.__finish" ID="HgShelveBrowserDialog.__finish"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.__finish" ID="HgShelveBrowserDialog.__finish"></a>
 <h4>HgShelveBrowserDialog.__finish</h4>
 <b>__finish</b>(<i></i>)
+
 <p>
         Private slot called when the process finished or the user pressed
         the button.
-</p><a NAME="HgShelveBrowserDialog.__generateShelveEntry" ID="HgShelveBrowserDialog.__generateShelveEntry"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.__generateShelveEntry" ID="HgShelveBrowserDialog.__generateShelveEntry"></a>
 <h4>HgShelveBrowserDialog.__generateShelveEntry</h4>
 <b>__generateShelveEntry</b>(<i>name, age, message, fileStatistics, totals</i>)
+
 <p>
         Private method to generate the shelve items.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>name</i></dt>
 <dd>
 name of the shelve (string)
-</dd><dt><i>age</i></dt>
+</dd>
+<dt><i>age</i></dt>
 <dd>
 age of the shelve (string)
-</dd><dt><i>message</i></dt>
+</dd>
+<dt><i>message</i></dt>
 <dd>
 shelve message (string)
-</dd><dt><i>fileStatistics</i></dt>
+</dd>
+<dt><i>fileStatistics</i></dt>
 <dd>
 per file change statistics (tuple of
             four strings with file name, number of changes, number of
             added lines and number of deleted lines)
-</dd><dt><i>totals</i></dt>
+</dd>
+<dt><i>totals</i></dt>
 <dd>
 overall statistics (tuple of three strings with
             number of changed files, number of added lines and number
             of deleted lines)
 </dd>
-</dl><a NAME="HgShelveBrowserDialog.__getShelveEntries" ID="HgShelveBrowserDialog.__getShelveEntries"></a>
+</dl>
+<a NAME="HgShelveBrowserDialog.__getShelveEntries" ID="HgShelveBrowserDialog.__getShelveEntries"></a>
 <h4>HgShelveBrowserDialog.__getShelveEntries</h4>
 <b>__getShelveEntries</b>(<i></i>)
+
 <p>
         Private method to retrieve the list of shelves.
-</p><a NAME="HgShelveBrowserDialog.__procFinished" ID="HgShelveBrowserDialog.__procFinished"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.__procFinished" ID="HgShelveBrowserDialog.__procFinished"></a>
 <h4>HgShelveBrowserDialog.__procFinished</h4>
 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
+
 <p>
         Private slot connected to the finished signal.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>exitCode</i></dt>
 <dd>
 exit code of the process (integer)
-</dd><dt><i>exitStatus</i></dt>
+</dd>
+<dt><i>exitStatus</i></dt>
 <dd>
 exit status of the process (QProcess.ExitStatus)
 </dd>
-</dl><a NAME="HgShelveBrowserDialog.__processBuffer" ID="HgShelveBrowserDialog.__processBuffer"></a>
+</dl>
+<a NAME="HgShelveBrowserDialog.__processBuffer" ID="HgShelveBrowserDialog.__processBuffer"></a>
 <h4>HgShelveBrowserDialog.__processBuffer</h4>
 <b>__processBuffer</b>(<i></i>)
+
 <p>
         Private method to process the buffered output of the hg shelve command.
-</p><a NAME="HgShelveBrowserDialog.__readStderr" ID="HgShelveBrowserDialog.__readStderr"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.__readStderr" ID="HgShelveBrowserDialog.__readStderr"></a>
 <h4>HgShelveBrowserDialog.__readStderr</h4>
 <b>__readStderr</b>(<i></i>)
+
 <p>
         Private slot to handle the readyReadStandardError signal.
-</p><p>
+</p>
+<p>
         It reads the error output of the process and inserts it into the
         error pane.
-</p><a NAME="HgShelveBrowserDialog.__readStdout" ID="HgShelveBrowserDialog.__readStdout"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.__readStdout" ID="HgShelveBrowserDialog.__readStdout"></a>
 <h4>HgShelveBrowserDialog.__readStdout</h4>
 <b>__readStdout</b>(<i></i>)
+
 <p>
         Private slot to handle the readyReadStandardOutput signal.
-</p><p>
+</p>
+<p>
         It reads the output of the process and inserts it into a buffer.
-</p><a NAME="HgShelveBrowserDialog.__resetUI" ID="HgShelveBrowserDialog.__resetUI"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.__resetUI" ID="HgShelveBrowserDialog.__resetUI"></a>
 <h4>HgShelveBrowserDialog.__resetUI</h4>
 <b>__resetUI</b>(<i></i>)
+
 <p>
         Private method to reset the user interface.
-</p><a NAME="HgShelveBrowserDialog.__resizeColumnsShelves" ID="HgShelveBrowserDialog.__resizeColumnsShelves"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.__resizeColumnsShelves" ID="HgShelveBrowserDialog.__resizeColumnsShelves"></a>
 <h4>HgShelveBrowserDialog.__resizeColumnsShelves</h4>
 <b>__resizeColumnsShelves</b>(<i></i>)
+
 <p>
         Private method to resize the shelve list columns.
-</p><a NAME="HgShelveBrowserDialog.__showError" ID="HgShelveBrowserDialog.__showError"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.__showError" ID="HgShelveBrowserDialog.__showError"></a>
 <h4>HgShelveBrowserDialog.__showError</h4>
 <b>__showError</b>(<i>out</i>)
+
 <p>
         Private slot to show some error.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>out</i></dt>
 <dd>
 error to be shown (string)
 </dd>
-</dl><a NAME="HgShelveBrowserDialog.__unshelve" ID="HgShelveBrowserDialog.__unshelve"></a>
+</dl>
+<a NAME="HgShelveBrowserDialog.__unshelve" ID="HgShelveBrowserDialog.__unshelve"></a>
 <h4>HgShelveBrowserDialog.__unshelve</h4>
 <b>__unshelve</b>(<i></i>)
+
 <p>
         Private slot to restore the selected shelve of changes.
-</p><a NAME="HgShelveBrowserDialog.closeEvent" ID="HgShelveBrowserDialog.closeEvent"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.closeEvent" ID="HgShelveBrowserDialog.closeEvent"></a>
 <h4>HgShelveBrowserDialog.closeEvent</h4>
 <b>closeEvent</b>(<i>e</i>)
+
 <p>
         Protected slot implementing a close event handler.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>e</i></dt>
 <dd>
 close event (QCloseEvent)
 </dd>
-</dl><a NAME="HgShelveBrowserDialog.keyPressEvent" ID="HgShelveBrowserDialog.keyPressEvent"></a>
+</dl>
+<a NAME="HgShelveBrowserDialog.keyPressEvent" ID="HgShelveBrowserDialog.keyPressEvent"></a>
 <h4>HgShelveBrowserDialog.keyPressEvent</h4>
 <b>keyPressEvent</b>(<i>evt</i>)
+
 <p>
         Protected slot to handle a key press event.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>evt</i></dt>
 <dd>
 the key press event (QKeyEvent)
 </dd>
-</dl><a NAME="HgShelveBrowserDialog.on_buttonBox_clicked" ID="HgShelveBrowserDialog.on_buttonBox_clicked"></a>
+</dl>
+<a NAME="HgShelveBrowserDialog.on_buttonBox_clicked" ID="HgShelveBrowserDialog.on_buttonBox_clicked"></a>
 <h4>HgShelveBrowserDialog.on_buttonBox_clicked</h4>
 <b>on_buttonBox_clicked</b>(<i>button</i>)
+
 <p>
         Private slot called by a button of the button box clicked.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>button</i></dt>
 <dd>
 button that was clicked (QAbstractButton)
 </dd>
-</dl><a NAME="HgShelveBrowserDialog.on_input_returnPressed" ID="HgShelveBrowserDialog.on_input_returnPressed"></a>
+</dl>
+<a NAME="HgShelveBrowserDialog.on_input_returnPressed" ID="HgShelveBrowserDialog.on_input_returnPressed"></a>
 <h4>HgShelveBrowserDialog.on_input_returnPressed</h4>
 <b>on_input_returnPressed</b>(<i></i>)
+
 <p>
         Private slot to handle the press of the return key in the input field.
-</p><a NAME="HgShelveBrowserDialog.on_passwordCheckBox_toggled" ID="HgShelveBrowserDialog.on_passwordCheckBox_toggled"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.on_passwordCheckBox_toggled" ID="HgShelveBrowserDialog.on_passwordCheckBox_toggled"></a>
 <h4>HgShelveBrowserDialog.on_passwordCheckBox_toggled</h4>
 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
+
 <p>
         Private slot to handle the password checkbox toggled.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>isOn</i></dt>
 <dd>
 flag indicating the status of the check box (boolean)
 </dd>
-</dl><a NAME="HgShelveBrowserDialog.on_refreshButton_clicked" ID="HgShelveBrowserDialog.on_refreshButton_clicked"></a>
+</dl>
+<a NAME="HgShelveBrowserDialog.on_refreshButton_clicked" ID="HgShelveBrowserDialog.on_refreshButton_clicked"></a>
 <h4>HgShelveBrowserDialog.on_refreshButton_clicked</h4>
 <b>on_refreshButton_clicked</b>(<i></i>)
+
 <p>
         Private slot to refresh the list of shelves.
-</p><a NAME="HgShelveBrowserDialog.on_sendButton_clicked" ID="HgShelveBrowserDialog.on_sendButton_clicked"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.on_sendButton_clicked" ID="HgShelveBrowserDialog.on_sendButton_clicked"></a>
 <h4>HgShelveBrowserDialog.on_sendButton_clicked</h4>
 <b>on_sendButton_clicked</b>(<i></i>)
+
 <p>
         Private slot to send the input to the mercurial process.
-</p><a NAME="HgShelveBrowserDialog.on_shelveList_currentItemChanged" ID="HgShelveBrowserDialog.on_shelveList_currentItemChanged"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.on_shelveList_currentItemChanged" ID="HgShelveBrowserDialog.on_shelveList_currentItemChanged"></a>
 <h4>HgShelveBrowserDialog.on_shelveList_currentItemChanged</h4>
 <b>on_shelveList_currentItemChanged</b>(<i>current, previous</i>)
+
 <p>
         Private slot called, when the current item of the shelve list changes.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>current</i></dt>
 <dd>
 reference to the new current item (QTreeWidgetItem)
-</dd><dt><i>previous</i></dt>
+</dd>
+<dt><i>previous</i></dt>
 <dd>
 reference to the old current item (QTreeWidgetItem)
 </dd>
-</dl><a NAME="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested" ID="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested"></a>
+</dl>
+<a NAME="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested" ID="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested"></a>
 <h4>HgShelveBrowserDialog.on_shelveList_customContextMenuRequested</h4>
 <b>on_shelveList_customContextMenuRequested</b>(<i>pos</i>)
+
 <p>
         Private slot to show the context menu of the shelve list.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>pos</i></dt>
 <dd>
 position of the mouse pointer (QPoint)
 </dd>
-</dl><a NAME="HgShelveBrowserDialog.show" ID="HgShelveBrowserDialog.show"></a>
+</dl>
+<a NAME="HgShelveBrowserDialog.show" ID="HgShelveBrowserDialog.show"></a>
 <h4>HgShelveBrowserDialog.show</h4>
 <b>show</b>(<i></i>)
+
 <p>
         Public slot to show the dialog.
-</p><a NAME="HgShelveBrowserDialog.start" ID="HgShelveBrowserDialog.start"></a>
+</p>
+<a NAME="HgShelveBrowserDialog.start" ID="HgShelveBrowserDialog.start"></a>
 <h4>HgShelveBrowserDialog.start</h4>
 <b>start</b>(<i>projectDir</i>)
+
 <p>
         Public slot to start the hg shelve command.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>projectDir</i></dt>
 <dd>
 name of the project directory (string)

eric ide

mercurial