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