ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html

changeset 133
8f183975895d
parent 54
71c83a661c83
child 144
5c3684ee818e
--- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html	Wed Jan 01 11:58:58 2020 +0100
+++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html	Thu Apr 09 18:16:19 2020 +0200
@@ -18,191 +18,256 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog</h1>
+
 <p>
 Module implementing a dialog showing the available routes.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
+
 <tr>
 <td><a href="#PyramidRoutesDialog">PyramidRoutesDialog</a></td>
 <td>Class implementing a dialog showing the available routes.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="PyramidRoutesDialog" ID="PyramidRoutesDialog"></a>
 <h2>PyramidRoutesDialog</h2>
+
 <p>
     Class implementing a dialog showing the available routes.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_PyramidRoutesDialog
 <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="#PyramidRoutesDialog.__init__">PyramidRoutesDialog</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PyramidRoutesDialog.__procFinished">__procFinished</a></td>
 <td>Private slot connected to the finished signal.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PyramidRoutesDialog.__processBuffer">__processBuffer</a></td>
 <td>Private slot to process the output buffer of the proutes command.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PyramidRoutesDialog.__readStderr">__readStderr</a></td>
 <td>Private slot to handle the readyReadStandardError signal.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PyramidRoutesDialog.__readStdout">__readStdout</a></td>
 <td>Private slot to handle the readyReadStandardOutput signal.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PyramidRoutesDialog.finish">finish</a></td>
 <td>Public slot called when the process finished or the user pressed the button.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PyramidRoutesDialog.keyPressEvent">keyPressEvent</a></td>
 <td>Protected slot to handle a key press event.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PyramidRoutesDialog.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="#PyramidRoutesDialog.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="#PyramidRoutesDialog.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="#PyramidRoutesDialog.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="#PyramidRoutesDialog.start">start</a></td>
 <td>Public slot used to start the process.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="PyramidRoutesDialog.__init__" ID="PyramidRoutesDialog.__init__"></a>
 <h4>PyramidRoutesDialog (Constructor)</h4>
 <b>PyramidRoutesDialog</b>(<i>project, parent=None</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>project</i></dt>
 <dd>
 reference to the project object
             (ProjectPyramid.Project.Project)
-</dd><dt><i>parent</i></dt>
+</dd>
+<dt><i>parent</i></dt>
 <dd>
 reference to the parent widget (QWidget)
 </dd>
-</dl><a NAME="PyramidRoutesDialog.__procFinished" ID="PyramidRoutesDialog.__procFinished"></a>
+</dl>
+<a NAME="PyramidRoutesDialog.__procFinished" ID="PyramidRoutesDialog.__procFinished"></a>
 <h4>PyramidRoutesDialog.__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="PyramidRoutesDialog.__processBuffer" ID="PyramidRoutesDialog.__processBuffer"></a>
+</dl>
+<a NAME="PyramidRoutesDialog.__processBuffer" ID="PyramidRoutesDialog.__processBuffer"></a>
 <h4>PyramidRoutesDialog.__processBuffer</h4>
 <b>__processBuffer</b>(<i></i>)
+
 <p>
         Private slot to process the output buffer of the proutes command.
-</p><a NAME="PyramidRoutesDialog.__readStderr" ID="PyramidRoutesDialog.__readStderr"></a>
+</p>
+<a NAME="PyramidRoutesDialog.__readStderr" ID="PyramidRoutesDialog.__readStderr"></a>
 <h4>PyramidRoutesDialog.__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="PyramidRoutesDialog.__readStdout" ID="PyramidRoutesDialog.__readStdout"></a>
+</p>
+<a NAME="PyramidRoutesDialog.__readStdout" ID="PyramidRoutesDialog.__readStdout"></a>
 <h4>PyramidRoutesDialog.__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 appends it to a buffer for
         delayed processing.
-</p><a NAME="PyramidRoutesDialog.finish" ID="PyramidRoutesDialog.finish"></a>
+</p>
+<a NAME="PyramidRoutesDialog.finish" ID="PyramidRoutesDialog.finish"></a>
 <h4>PyramidRoutesDialog.finish</h4>
 <b>finish</b>(<i></i>)
+
 <p>
         Public slot called when the process finished or the user pressed the
         button.
-</p><a NAME="PyramidRoutesDialog.keyPressEvent" ID="PyramidRoutesDialog.keyPressEvent"></a>
+</p>
+<a NAME="PyramidRoutesDialog.keyPressEvent" ID="PyramidRoutesDialog.keyPressEvent"></a>
 <h4>PyramidRoutesDialog.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="PyramidRoutesDialog.on_buttonBox_clicked" ID="PyramidRoutesDialog.on_buttonBox_clicked"></a>
+</dl>
+<a NAME="PyramidRoutesDialog.on_buttonBox_clicked" ID="PyramidRoutesDialog.on_buttonBox_clicked"></a>
 <h4>PyramidRoutesDialog.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="PyramidRoutesDialog.on_input_returnPressed" ID="PyramidRoutesDialog.on_input_returnPressed"></a>
+</dl>
+<a NAME="PyramidRoutesDialog.on_input_returnPressed" ID="PyramidRoutesDialog.on_input_returnPressed"></a>
 <h4>PyramidRoutesDialog.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="PyramidRoutesDialog.on_passwordCheckBox_toggled" ID="PyramidRoutesDialog.on_passwordCheckBox_toggled"></a>
+</p>
+<a NAME="PyramidRoutesDialog.on_passwordCheckBox_toggled" ID="PyramidRoutesDialog.on_passwordCheckBox_toggled"></a>
 <h4>PyramidRoutesDialog.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="PyramidRoutesDialog.on_sendButton_clicked" ID="PyramidRoutesDialog.on_sendButton_clicked"></a>
+</dl>
+<a NAME="PyramidRoutesDialog.on_sendButton_clicked" ID="PyramidRoutesDialog.on_sendButton_clicked"></a>
 <h4>PyramidRoutesDialog.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="PyramidRoutesDialog.start" ID="PyramidRoutesDialog.start"></a>
+</p>
+<a NAME="PyramidRoutesDialog.start" ID="PyramidRoutesDialog.start"></a>
 <h4>PyramidRoutesDialog.start</h4>
 <b>start</b>(<i>projectPath</i>)
+
 <p>
         Public slot used to start the process.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>projectPath</i></dt>
 <dd>
 path to the Pyramid project (string)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a successful start of the process

eric ide

mercurial