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