eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7370
5fb53279f2df
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,29 +18,37 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog</h1>
+
 <p>
 Module implementing a dialog to show a list of incoming or outgoing bookmarks.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
+
 <tr>
 <td><a href="#HgBookmarksInOutDialog">HgBookmarksInOutDialog</a></td>
 <td>Class implementing a dialog to show a list of incoming or outgoing bookmarks.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="HgBookmarksInOutDialog" ID="HgBookmarksInOutDialog"></a>
 <h2>HgBookmarksInOutDialog</h2>
+
 <p>
     Class implementing a dialog to show a list of incoming or outgoing
     bookmarks.
@@ -48,233 +56,318 @@
 <h3>Derived from</h3>
 QDialog, Ui_HgBookmarksInOutDialog
 <h3>Class Attributes</h3>
+
 <table>
 <tr><td>INCOMING</td></tr><tr><td>OUTGOING</td></tr>
 </table>
 <h3>Class Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+
 <table>
+
 <tr>
 <td><a href="#HgBookmarksInOutDialog.__init__">HgBookmarksInOutDialog</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.__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="#HgBookmarksInOutDialog.__generateItem">__generateItem</a></td>
 <td>Private method to generate a bookmark item in the bookmarks list.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.__procFinished">__procFinished</a></td>
 <td>Private slot connected to the finished signal.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.__processOutputLine">__processOutputLine</a></td>
 <td>Private method to process the lines of output.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.__readStderr">__readStderr</a></td>
 <td>Private slot to handle the readyReadStderr signal.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.__readStdout">__readStdout</a></td>
 <td>Private slot to handle the readyReadStdout signal.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.__resizeColumns">__resizeColumns</a></td>
 <td>Private method to resize the list columns.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.__resort">__resort</a></td>
 <td>Private method to resort the tree.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.__showError">__showError</a></td>
 <td>Private slot to show some error.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.closeEvent">closeEvent</a></td>
 <td>Protected slot implementing a close event handler.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.keyPressEvent">keyPressEvent</a></td>
 <td>Protected slot to handle a key press event.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.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="#HgBookmarksInOutDialog.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="#HgBookmarksInOutDialog.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="#HgBookmarksInOutDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
 <td>Private slot to send the input to the subversion process.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HgBookmarksInOutDialog.start">start</a></td>
 <td>Public slot to start the bookmarks command.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="HgBookmarksInOutDialog.__init__" ID="HgBookmarksInOutDialog.__init__"></a>
 <h4>HgBookmarksInOutDialog (Constructor)</h4>
 <b>HgBookmarksInOutDialog</b>(<i>vcs, mode, parent=None</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>vcs</i></dt>
 <dd>
 reference to the vcs object
-</dd><dt><i>mode</i></dt>
+</dd>
+<dt><i>mode</i></dt>
 <dd>
 mode of the dialog (HgBookmarksInOutDialog.INCOMING,
             HgBookmarksInOutDialog.OUTGOING)
-</dd><dt><i>parent</i></dt>
+</dd>
+<dt><i>parent</i></dt>
 <dd>
 reference to the parent widget (QWidget)
 </dd>
-</dl><dl>
+</dl>
+<dl>
+
 <dt>Raises <b>ValueError</b>:</dt>
 <dd>
 raised to indicate an invalid dialog mode
 </dd>
-</dl><a NAME="HgBookmarksInOutDialog.__finish" ID="HgBookmarksInOutDialog.__finish"></a>
+</dl>
+<a NAME="HgBookmarksInOutDialog.__finish" ID="HgBookmarksInOutDialog.__finish"></a>
 <h4>HgBookmarksInOutDialog.__finish</h4>
 <b>__finish</b>(<i></i>)
+
 <p>
         Private slot called when the process finished or the user pressed
         the button.
-</p><a NAME="HgBookmarksInOutDialog.__generateItem" ID="HgBookmarksInOutDialog.__generateItem"></a>
+</p>
+<a NAME="HgBookmarksInOutDialog.__generateItem" ID="HgBookmarksInOutDialog.__generateItem"></a>
 <h4>HgBookmarksInOutDialog.__generateItem</h4>
 <b>__generateItem</b>(<i>changeset, name</i>)
+
 <p>
         Private method to generate a bookmark item in the bookmarks list.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>changeset</i></dt>
 <dd>
 changeset of the bookmark (string)
-</dd><dt><i>name</i></dt>
+</dd>
+<dt><i>name</i></dt>
 <dd>
 name of the bookmark (string)
 </dd>
-</dl><a NAME="HgBookmarksInOutDialog.__procFinished" ID="HgBookmarksInOutDialog.__procFinished"></a>
+</dl>
+<a NAME="HgBookmarksInOutDialog.__procFinished" ID="HgBookmarksInOutDialog.__procFinished"></a>
 <h4>HgBookmarksInOutDialog.__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="HgBookmarksInOutDialog.__processOutputLine" ID="HgBookmarksInOutDialog.__processOutputLine"></a>
+</dl>
+<a NAME="HgBookmarksInOutDialog.__processOutputLine" ID="HgBookmarksInOutDialog.__processOutputLine"></a>
 <h4>HgBookmarksInOutDialog.__processOutputLine</h4>
 <b>__processOutputLine</b>(<i>line</i>)
+
 <p>
         Private method to process the lines of output.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>line</i></dt>
 <dd>
 output line to be processed (string)
 </dd>
-</dl><a NAME="HgBookmarksInOutDialog.__readStderr" ID="HgBookmarksInOutDialog.__readStderr"></a>
+</dl>
+<a NAME="HgBookmarksInOutDialog.__readStderr" ID="HgBookmarksInOutDialog.__readStderr"></a>
 <h4>HgBookmarksInOutDialog.__readStderr</h4>
 <b>__readStderr</b>(<i></i>)
+
 <p>
         Private slot to handle the readyReadStderr signal.
-</p><p>
+</p>
+<p>
         It reads the error output of the process and inserts it into the
         error pane.
-</p><a NAME="HgBookmarksInOutDialog.__readStdout" ID="HgBookmarksInOutDialog.__readStdout"></a>
+</p>
+<a NAME="HgBookmarksInOutDialog.__readStdout" ID="HgBookmarksInOutDialog.__readStdout"></a>
 <h4>HgBookmarksInOutDialog.__readStdout</h4>
 <b>__readStdout</b>(<i></i>)
+
 <p>
         Private slot to handle the readyReadStdout signal.
-</p><p>
+</p>
+<p>
         It reads the output of the process, formats it and inserts it into
         the contents pane.
-</p><a NAME="HgBookmarksInOutDialog.__resizeColumns" ID="HgBookmarksInOutDialog.__resizeColumns"></a>
+</p>
+<a NAME="HgBookmarksInOutDialog.__resizeColumns" ID="HgBookmarksInOutDialog.__resizeColumns"></a>
 <h4>HgBookmarksInOutDialog.__resizeColumns</h4>
 <b>__resizeColumns</b>(<i></i>)
+
 <p>
         Private method to resize the list columns.
-</p><a NAME="HgBookmarksInOutDialog.__resort" ID="HgBookmarksInOutDialog.__resort"></a>
+</p>
+<a NAME="HgBookmarksInOutDialog.__resort" ID="HgBookmarksInOutDialog.__resort"></a>
 <h4>HgBookmarksInOutDialog.__resort</h4>
 <b>__resort</b>(<i></i>)
+
 <p>
         Private method to resort the tree.
-</p><a NAME="HgBookmarksInOutDialog.__showError" ID="HgBookmarksInOutDialog.__showError"></a>
+</p>
+<a NAME="HgBookmarksInOutDialog.__showError" ID="HgBookmarksInOutDialog.__showError"></a>
 <h4>HgBookmarksInOutDialog.__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="HgBookmarksInOutDialog.closeEvent" ID="HgBookmarksInOutDialog.closeEvent"></a>
+</dl>
+<a NAME="HgBookmarksInOutDialog.closeEvent" ID="HgBookmarksInOutDialog.closeEvent"></a>
 <h4>HgBookmarksInOutDialog.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="HgBookmarksInOutDialog.keyPressEvent" ID="HgBookmarksInOutDialog.keyPressEvent"></a>
+</dl>
+<a NAME="HgBookmarksInOutDialog.keyPressEvent" ID="HgBookmarksInOutDialog.keyPressEvent"></a>
 <h4>HgBookmarksInOutDialog.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="HgBookmarksInOutDialog.on_buttonBox_clicked" ID="HgBookmarksInOutDialog.on_buttonBox_clicked"></a>
+</dl>
+<a NAME="HgBookmarksInOutDialog.on_buttonBox_clicked" ID="HgBookmarksInOutDialog.on_buttonBox_clicked"></a>
 <h4>HgBookmarksInOutDialog.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="HgBookmarksInOutDialog.on_input_returnPressed" ID="HgBookmarksInOutDialog.on_input_returnPressed"></a>
+</dl>
+<a NAME="HgBookmarksInOutDialog.on_input_returnPressed" ID="HgBookmarksInOutDialog.on_input_returnPressed"></a>
 <h4>HgBookmarksInOutDialog.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="HgBookmarksInOutDialog.on_passwordCheckBox_toggled" ID="HgBookmarksInOutDialog.on_passwordCheckBox_toggled"></a>
+</p>
+<a NAME="HgBookmarksInOutDialog.on_passwordCheckBox_toggled" ID="HgBookmarksInOutDialog.on_passwordCheckBox_toggled"></a>
 <h4>HgBookmarksInOutDialog.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="HgBookmarksInOutDialog.on_sendButton_clicked" ID="HgBookmarksInOutDialog.on_sendButton_clicked"></a>
+</dl>
+<a NAME="HgBookmarksInOutDialog.on_sendButton_clicked" ID="HgBookmarksInOutDialog.on_sendButton_clicked"></a>
 <h4>HgBookmarksInOutDialog.on_sendButton_clicked</h4>
 <b>on_sendButton_clicked</b>(<i></i>)
+
 <p>
         Private slot to send the input to the subversion process.
-</p><a NAME="HgBookmarksInOutDialog.start" ID="HgBookmarksInOutDialog.start"></a>
+</p>
+<a NAME="HgBookmarksInOutDialog.start" ID="HgBookmarksInOutDialog.start"></a>
 <h4>HgBookmarksInOutDialog.start</h4>
 <b>start</b>(<i>path</i>)
+
 <p>
         Public slot to start the bookmarks command.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>path</i></dt>
 <dd>
 name of directory to be listed (string)
 </dd>
-</dl><dl>
+</dl>
+<dl>
+
 <dt>Raises <b>ValueError</b>:</dt>
 <dd>
 raised to indicate an invalid dialog mode

eric ide

mercurial