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