Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html
Documentation/Source/eric4.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 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>eric4.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog to show the output of the ericdoc process. | |
| 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="#EricdocExecDialog">EricdocExecDialog</a></td> | |
| 35 <td>Class implementing a dialog to show the output of the ericdoc process.</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="EricdocExecDialog" ID="EricdocExecDialog"></a> | |
| 44 <h2>EricdocExecDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to show the output of the ericdoc process. | |
| 47 </p><p> | |
| 48 This class starts a QProcess and displays a dialog that | |
| 49 shows the output of the documentation command process. | |
| 50 </p> | |
| 51 <h3>Derived from</h3> | |
| 52 QDialog, Ui_EricdocExecDialog | |
| 53 <h3>Class Attributes</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#EricdocExecDialog.__init__">EricdocExecDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#EricdocExecDialog.__finish">__finish</a></td> | |
| 64 <td>Private slot called when the process finished.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#EricdocExecDialog.__readStderr">__readStderr</a></td> | |
| 67 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#EricdocExecDialog.__readStdout">__readStdout</a></td> | |
| 70 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#EricdocExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 73 <td>Private slot called by a button of the button box clicked.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#EricdocExecDialog.start">start</a></td> | |
| 76 <td>Public slot to start the ericdoc command.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <a NAME="EricdocExecDialog.__init__" ID="EricdocExecDialog.__init__"></a> | |
| 80 <h4>EricdocExecDialog (Constructor)</h4> | |
| 81 <b>EricdocExecDialog</b>(<i>cmdname, parent = None</i>) | |
| 82 <p> | |
| 83 Constructor | |
| 84 </p><dl> | |
| 85 <dt><i>cmdname</i></dt> | |
| 86 <dd> | |
| 87 name of the documentation generator (string) | |
| 88 </dd><dt><i>parent</i></dt> | |
| 89 <dd> | |
| 90 parent widget of this dialog (QWidget) | |
| 91 </dd> | |
| 92 </dl><a NAME="EricdocExecDialog.__finish" ID="EricdocExecDialog.__finish"></a> | |
| 93 <h4>EricdocExecDialog.__finish</h4> | |
| 94 <b>__finish</b>(<i></i>) | |
| 95 <p> | |
| 96 Private slot called when the process finished. | |
| 97 </p><p> | |
| 98 It is called when the process finished or | |
| 99 the user pressed the button. | |
| 100 </p><a NAME="EricdocExecDialog.__readStderr" ID="EricdocExecDialog.__readStderr"></a> | |
| 101 <h4>EricdocExecDialog.__readStderr</h4> | |
| 102 <b>__readStderr</b>(<i></i>) | |
| 103 <p> | |
| 104 Private slot to handle the readyReadStandardError signal. | |
| 105 </p><p> | |
| 106 It reads the error output of the process and inserts it into the | |
| 107 error pane. | |
| 108 </p><a NAME="EricdocExecDialog.__readStdout" ID="EricdocExecDialog.__readStdout"></a> | |
| 109 <h4>EricdocExecDialog.__readStdout</h4> | |
| 110 <b>__readStdout</b>(<i></i>) | |
| 111 <p> | |
| 112 Private slot to handle the readyReadStandardOutput signal. | |
| 113 </p><p> | |
| 114 It reads the output of the process, formats it and inserts it into | |
| 115 the contents pane. | |
| 116 </p><a NAME="EricdocExecDialog.on_buttonBox_clicked" ID="EricdocExecDialog.on_buttonBox_clicked"></a> | |
| 117 <h4>EricdocExecDialog.on_buttonBox_clicked</h4> | |
| 118 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 119 <p> | |
| 120 Private slot called by a button of the button box clicked. | |
| 121 </p><dl> | |
| 122 <dt><i>button</i></dt> | |
| 123 <dd> | |
| 124 button that was clicked (QAbstractButton) | |
| 125 </dd> | |
| 126 </dl><a NAME="EricdocExecDialog.start" ID="EricdocExecDialog.start"></a> | |
| 127 <h4>EricdocExecDialog.start</h4> | |
| 128 <b>start</b>(<i>args, fn</i>) | |
| 129 <p> | |
| 130 Public slot to start the ericdoc command. | |
| 131 </p><dl> | |
| 132 <dt><i>args</i></dt> | |
| 133 <dd> | |
| 134 commandline arguments for ericdoc program (list of strings) | |
| 135 </dd><dt><i>fn</i></dt> | |
| 136 <dd> | |
| 137 filename or dirname to be processed by ericdoc program (string) | |
| 138 </dd> | |
| 139 </dl><dl> | |
| 140 <dt>Returns:</dt> | |
| 141 <dd> | |
| 142 flag indicating the successful start of the process (boolean) | |
| 143 </dd> | |
| 144 </dl> | |
| 145 <div align="right"><a href="#top">Up</a></div> | |
| 146 <hr /> | |
| 147 </body></html> |
