Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html
src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10316
- bae834dc40ec
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to show the output of the ericdoc process. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#EricdocExecDialog">EricdocExecDialog</a></td> | |
| 25 <td>Class implementing a dialog to show the output of the ericdoc process.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="EricdocExecDialog" ID="EricdocExecDialog"></a> | |
| 36 <h2>EricdocExecDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to show the output of the ericdoc process. | |
| 40 </p> | |
| 41 <p> | |
| 42 This class starts a QProcess and displays a dialog that | |
| 43 shows the output of the documentation command process. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 QDialog, Ui_EricdocExecDialog | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#EricdocExecDialog.__init__">EricdocExecDialog</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#EricdocExecDialog.__finish">__finish</a></td> | |
| 67 <td>Private slot called when the process finished.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#EricdocExecDialog.__readStderr">__readStderr</a></td> | |
| 71 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#EricdocExecDialog.__readStdout">__readStdout</a></td> | |
| 75 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#EricdocExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 79 <td>Private slot called by a button of the button box clicked.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#EricdocExecDialog.start">start</a></td> | |
| 83 <td>Public slot to start the ericdoc command.</td> | |
| 84 </tr> | |
| 85 </table> | |
| 86 <h3>Static Methods</h3> | |
| 87 | |
| 88 <table> | |
| 89 <tr><td>None</td></tr> | |
| 90 </table> | |
| 91 | |
| 92 <a NAME="EricdocExecDialog.__init__" ID="EricdocExecDialog.__init__"></a> | |
| 93 <h4>EricdocExecDialog (Constructor)</h4> | |
| 94 <b>EricdocExecDialog</b>(<i>cmdname, parent=None</i>) | |
| 95 | |
| 96 <p> | |
| 97 Constructor | |
| 98 </p> | |
| 99 <dl> | |
| 100 | |
| 101 <dt><i>cmdname</i></dt> | |
| 102 <dd> | |
| 103 name of the documentation generator (string) | |
| 104 </dd> | |
| 105 <dt><i>parent</i></dt> | |
| 106 <dd> | |
| 107 parent widget of this dialog (QWidget) | |
| 108 </dd> | |
| 109 </dl> | |
| 110 <a NAME="EricdocExecDialog.__finish" ID="EricdocExecDialog.__finish"></a> | |
| 111 <h4>EricdocExecDialog.__finish</h4> | |
| 112 <b>__finish</b>(<i></i>) | |
| 113 | |
| 114 <p> | |
| 115 Private slot called when the process finished. | |
| 116 </p> | |
| 117 <p> | |
| 118 It is called when the process finished or | |
| 119 the user pressed the button. | |
| 120 </p> | |
| 121 <a NAME="EricdocExecDialog.__readStderr" ID="EricdocExecDialog.__readStderr"></a> | |
| 122 <h4>EricdocExecDialog.__readStderr</h4> | |
| 123 <b>__readStderr</b>(<i></i>) | |
| 124 | |
| 125 <p> | |
| 126 Private slot to handle the readyReadStandardError signal. | |
| 127 </p> | |
| 128 <p> | |
| 129 It reads the error output of the process and inserts it into the | |
| 130 error pane. | |
| 131 </p> | |
| 132 <a NAME="EricdocExecDialog.__readStdout" ID="EricdocExecDialog.__readStdout"></a> | |
| 133 <h4>EricdocExecDialog.__readStdout</h4> | |
| 134 <b>__readStdout</b>(<i></i>) | |
| 135 | |
| 136 <p> | |
| 137 Private slot to handle the readyReadStandardOutput signal. | |
| 138 </p> | |
| 139 <p> | |
| 140 It reads the output of the process, formats it and inserts it into | |
| 141 the contents pane. | |
| 142 </p> | |
| 143 <a NAME="EricdocExecDialog.on_buttonBox_clicked" ID="EricdocExecDialog.on_buttonBox_clicked"></a> | |
| 144 <h4>EricdocExecDialog.on_buttonBox_clicked</h4> | |
| 145 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 146 | |
| 147 <p> | |
| 148 Private slot called by a button of the button box clicked. | |
| 149 </p> | |
| 150 <dl> | |
| 151 | |
| 152 <dt><i>button</i></dt> | |
| 153 <dd> | |
| 154 button that was clicked (QAbstractButton) | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <a NAME="EricdocExecDialog.start" ID="EricdocExecDialog.start"></a> | |
| 158 <h4>EricdocExecDialog.start</h4> | |
| 159 <b>start</b>(<i>args, fn</i>) | |
| 160 | |
| 161 <p> | |
| 162 Public slot to start the ericdoc command. | |
| 163 </p> | |
| 164 <dl> | |
| 165 | |
| 166 <dt><i>args</i></dt> | |
| 167 <dd> | |
| 168 commandline arguments for ericdoc program (list of strings) | |
| 169 </dd> | |
| 170 <dt><i>fn</i></dt> | |
| 171 <dd> | |
| 172 filename or dirname to be processed by ericdoc program | |
| 173 (string) | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <dl> | |
| 177 <dt>Return:</dt> | |
| 178 <dd> | |
| 179 flag indicating the successful start of the process (boolean) | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <div align="right"><a href="#top">Up</a></div> | |
| 183 <hr /> | |
| 184 </body></html> |
