Mercurial Repositories > Pyramid Project / file comparison
comparison: ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html
ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html
- changeset 15
- db83e46b35da
- child 37
- 1b089e0fba1e
equal
deleted
inserted
replaced
| 14:e3cb581b4653 | 15:db83e46b35da |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog showing the available routes. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#PyramidRoutesDialog">PyramidRoutesDialog</a></td> | |
| 35 <td>Class implementing a dialog showing the available routes.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="PyramidRoutesDialog" ID="PyramidRoutesDialog"></a> | |
| 44 <h2>PyramidRoutesDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog showing the available routes. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QDialog, Ui_PyramidRoutesDialog | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Class Methods</h3> | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 <table> | |
| 60 <tr> | |
| 61 <td><a href="#PyramidRoutesDialog.__init__">PyramidRoutesDialog</a></td> | |
| 62 <td>Constructor</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#PyramidRoutesDialog.__procFinished">__procFinished</a></td> | |
| 65 <td>Private slot connected to the finished signal.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#PyramidRoutesDialog.__processBuffer">__processBuffer</a></td> | |
| 68 <td>Private slot to process the output buffer of the proutes command.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#PyramidRoutesDialog.__readStderr">__readStderr</a></td> | |
| 71 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#PyramidRoutesDialog.__readStdout">__readStdout</a></td> | |
| 74 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#PyramidRoutesDialog.finish">finish</a></td> | |
| 77 <td>Public slot called when the process finished or the user pressed the button.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#PyramidRoutesDialog.keyPressEvent">keyPressEvent</a></td> | |
| 80 <td>Protected slot to handle a key press event.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#PyramidRoutesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 83 <td>Private slot called by a button of the button box clicked.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#PyramidRoutesDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 86 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#PyramidRoutesDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 89 <td>Private slot to handle the password checkbox toggled.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#PyramidRoutesDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 92 <td>Private slot to send the input to the subversion process.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#PyramidRoutesDialog.start">start</a></td> | |
| 95 <td>Public slot used to start the process.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 <table> | |
| 100 <tr><td>None</td></tr> | |
| 101 </table> | |
| 102 <a NAME="PyramidRoutesDialog.__init__" ID="PyramidRoutesDialog.__init__"></a> | |
| 103 <h4>PyramidRoutesDialog (Constructor)</h4> | |
| 104 <b>PyramidRoutesDialog</b>(<i>project, parent=None</i>) | |
| 105 <p> | |
| 106 Constructor | |
| 107 </p><dl> | |
| 108 <dt><i>project</i></dt> | |
| 109 <dd> | |
| 110 reference to the project object (ProjectPyramid.Project.Project) | |
| 111 </dd><dt><i>parent</i></dt> | |
| 112 <dd> | |
| 113 reference to the parent widget (QWidget) | |
| 114 </dd> | |
| 115 </dl><a NAME="PyramidRoutesDialog.__procFinished" ID="PyramidRoutesDialog.__procFinished"></a> | |
| 116 <h4>PyramidRoutesDialog.__procFinished</h4> | |
| 117 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 118 <p> | |
| 119 Private slot connected to the finished signal. | |
| 120 </p><dl> | |
| 121 <dt><i>exitCode</i></dt> | |
| 122 <dd> | |
| 123 exit code of the process (integer) | |
| 124 </dd><dt><i>exitStatus</i></dt> | |
| 125 <dd> | |
| 126 exit status of the process (QProcess.ExitStatus) | |
| 127 </dd> | |
| 128 </dl><a NAME="PyramidRoutesDialog.__processBuffer" ID="PyramidRoutesDialog.__processBuffer"></a> | |
| 129 <h4>PyramidRoutesDialog.__processBuffer</h4> | |
| 130 <b>__processBuffer</b>(<i></i>) | |
| 131 <p> | |
| 132 Private slot to process the output buffer of the proutes command. | |
| 133 </p><a NAME="PyramidRoutesDialog.__readStderr" ID="PyramidRoutesDialog.__readStderr"></a> | |
| 134 <h4>PyramidRoutesDialog.__readStderr</h4> | |
| 135 <b>__readStderr</b>(<i></i>) | |
| 136 <p> | |
| 137 Private slot to handle the readyReadStandardError signal. | |
| 138 </p><p> | |
| 139 It reads the error output of the process and inserts it into the | |
| 140 error pane. | |
| 141 </p><a NAME="PyramidRoutesDialog.__readStdout" ID="PyramidRoutesDialog.__readStdout"></a> | |
| 142 <h4>PyramidRoutesDialog.__readStdout</h4> | |
| 143 <b>__readStdout</b>(<i></i>) | |
| 144 <p> | |
| 145 Private slot to handle the readyReadStandardOutput signal. | |
| 146 </p><p> | |
| 147 It reads the output of the process and appends it to a buffer for | |
| 148 delayed processing. | |
| 149 </p><a NAME="PyramidRoutesDialog.finish" ID="PyramidRoutesDialog.finish"></a> | |
| 150 <h4>PyramidRoutesDialog.finish</h4> | |
| 151 <b>finish</b>(<i></i>) | |
| 152 <p> | |
| 153 Public slot called when the process finished or the user pressed the button. | |
| 154 </p><a NAME="PyramidRoutesDialog.keyPressEvent" ID="PyramidRoutesDialog.keyPressEvent"></a> | |
| 155 <h4>PyramidRoutesDialog.keyPressEvent</h4> | |
| 156 <b>keyPressEvent</b>(<i>evt</i>) | |
| 157 <p> | |
| 158 Protected slot to handle a key press event. | |
| 159 </p><dl> | |
| 160 <dt><i>evt</i></dt> | |
| 161 <dd> | |
| 162 the key press event (QKeyEvent) | |
| 163 </dd> | |
| 164 </dl><a NAME="PyramidRoutesDialog.on_buttonBox_clicked" ID="PyramidRoutesDialog.on_buttonBox_clicked"></a> | |
| 165 <h4>PyramidRoutesDialog.on_buttonBox_clicked</h4> | |
| 166 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 167 <p> | |
| 168 Private slot called by a button of the button box clicked. | |
| 169 </p><dl> | |
| 170 <dt><i>button</i></dt> | |
| 171 <dd> | |
| 172 button that was clicked (QAbstractButton) | |
| 173 </dd> | |
| 174 </dl><a NAME="PyramidRoutesDialog.on_input_returnPressed" ID="PyramidRoutesDialog.on_input_returnPressed"></a> | |
| 175 <h4>PyramidRoutesDialog.on_input_returnPressed</h4> | |
| 176 <b>on_input_returnPressed</b>(<i></i>) | |
| 177 <p> | |
| 178 Private slot to handle the press of the return key in the input field. | |
| 179 </p><a NAME="PyramidRoutesDialog.on_passwordCheckBox_toggled" ID="PyramidRoutesDialog.on_passwordCheckBox_toggled"></a> | |
| 180 <h4>PyramidRoutesDialog.on_passwordCheckBox_toggled</h4> | |
| 181 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 182 <p> | |
| 183 Private slot to handle the password checkbox toggled. | |
| 184 </p><dl> | |
| 185 <dt><i>isOn</i></dt> | |
| 186 <dd> | |
| 187 flag indicating the status of the check box (boolean) | |
| 188 </dd> | |
| 189 </dl><a NAME="PyramidRoutesDialog.on_sendButton_clicked" ID="PyramidRoutesDialog.on_sendButton_clicked"></a> | |
| 190 <h4>PyramidRoutesDialog.on_sendButton_clicked</h4> | |
| 191 <b>on_sendButton_clicked</b>(<i></i>) | |
| 192 <p> | |
| 193 Private slot to send the input to the subversion process. | |
| 194 </p><a NAME="PyramidRoutesDialog.start" ID="PyramidRoutesDialog.start"></a> | |
| 195 <h4>PyramidRoutesDialog.start</h4> | |
| 196 <b>start</b>(<i>projectPath</i>) | |
| 197 <p> | |
| 198 Public slot used to start the process. | |
| 199 </p><dl> | |
| 200 <dt><i>command</i></dt> | |
| 201 <dd> | |
| 202 command to start (string) | |
| 203 </dd><dt><i>projectPath</i></dt> | |
| 204 <dd> | |
| 205 path to the Pyramid project (string) | |
| 206 </dd> | |
| 207 </dl><dl> | |
| 208 <dt>Returns:</dt> | |
| 209 <dd> | |
| 210 flag indicating a successful start of the process | |
| 211 </dd> | |
| 212 </dl> | |
| 213 <div align="right"><a href="#top">Up</a></div> | |
| 214 <hr /> | |
| 215 </body></html> |
