Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog.html

Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog</h1> 23 <h1>eric5.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#97;&#112;&#105; &#112;&#114;&#111;&#99;&#101;&#115;&#115;. 25 Module implementing a dialog to show the output of the ericapi process.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#EricapiExecDialog">EricapiExecDialog</a></td> 34 <td><a href="#EricapiExecDialog">EricapiExecDialog</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#97;&#112;&#105; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.</td> 35 <td>Class implementing a dialog to show the output of the ericapi process.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="EricapiExecDialog" ID="EricapiExecDialog"></a> 43 <a NAME="EricapiExecDialog" ID="EricapiExecDialog"></a>
44 <h2>EricapiExecDialog</h2> 44 <h2>EricapiExecDialog</h2>
45 <p> 45 <p>
46 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#97;&#112;&#105; &#112;&#114;&#111;&#99;&#101;&#115;&#115;. 46 Class implementing a dialog to show the output of the ericapi process.
47 </p><p> 47 </p><p>
48 &#84;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115; &#115;&#116;&#97;&#114;&#116;&#115; &#97; &#81;&#80;&#114;&#111;&#99;&#101;&#115;&#115; &#97;&#110;&#100; &#100;&#105;&#115;&#112;&#108;&#97;y&#115; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#104;&#97;&#116; 48 This class starts a QProcess and displays a dialog that
49 &#115;&#104;&#111;w&#115; &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#112;&#114;&#111;&#99;&#101;&#115;&#115;. 49 shows the output of the documentation command process.
50 </p> 50 </p>
51 <h3>Derived from</h3> 51 <h3>Derived from</h3>
52 QDialog, Ui_EricapiExecDialog 52 QDialog, Ui_EricapiExecDialog
53 <h3>Class Attributes</h3> 53 <h3>Class Attributes</h3>
54 <table> 54 <table>
56 </table> 56 </table>
57 <h3>Methods</h3> 57 <h3>Methods</h3>
58 <table> 58 <table>
59 <tr> 59 <tr>
60 <td><a href="#EricapiExecDialog.__init__">EricapiExecDialog</a></td> 60 <td><a href="#EricapiExecDialog.__init__">EricapiExecDialog</a></td>
61 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 61 <td>Constructor</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#EricapiExecDialog.__finish">__finish</a></td> 63 <td><a href="#EricapiExecDialog.__finish">__finish</a></td>
64 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; w&#104;&#101;&#110; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#102;&#105;&#110;&#105;&#115;&#104;&#101;&#100;.</td> 64 <td>Private slot called when the process finished.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#EricapiExecDialog.__readStderr">__readStderr</a></td> 66 <td><a href="#EricapiExecDialog.__readStderr">__readStderr</a></td>
67 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#69;&#114;&#114;&#111;&#114; &#115;&#105;&#103;&#110;&#97;&#108;.</td> 67 <td>Private slot to handle the readyReadStandardError signal.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#EricapiExecDialog.__readStdout">__readStdout</a></td> 69 <td><a href="#EricapiExecDialog.__readStdout">__readStdout</a></td>
70 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#79;&#117;&#116;&#112;&#117;&#116; &#115;&#105;&#103;&#110;&#97;&#108;.</td> 70 <td>Private slot to handle the readyReadStandardOutput signal.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#EricapiExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 72 <td><a href="#EricapiExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
73 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#98;&#111;x &#99;&#108;&#105;&#99;&#107;&#101;&#100;.</td> 73 <td>Private slot called by a button of the button box clicked.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#EricapiExecDialog.start">start</a></td> 75 <td><a href="#EricapiExecDialog.start">start</a></td>
76 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#97;&#112;&#105; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.</td> 76 <td>Public slot to start the ericapi command.</td>
77 </tr> 77 </tr>
78 </table> 78 </table>
79 <a NAME="EricapiExecDialog.__init__" ID="EricapiExecDialog.__init__"></a> 79 <a NAME="EricapiExecDialog.__init__" ID="EricapiExecDialog.__init__"></a>
80 <h4>EricapiExecDialog (Constructor)</h4> 80 <h4>EricapiExecDialog (Constructor)</h4>
81 <b>EricapiExecDialog</b>(<i>cmdname, parent = None</i>) 81 <b>EricapiExecDialog</b>(<i>cmdname, parent = None</i>)
82 <p> 82 <p>
83 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 83 Constructor
84 </p><dl> 84 </p><dl>
85 <dt><i>cmdname</i></dt> 85 <dt><i>cmdname</i></dt>
86 <dd> 86 <dd>
87 &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#97;&#112;&#105; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;) 87 name of the ericapi generator (string)
88 </dd><dt><i>parent</i></dt> 88 </dd><dt><i>parent</i></dt>
89 <dd> 89 <dd>
90 &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; &#111;&#102; &#116;&#104;&#105;&#115; &#100;&#105;&#97;&#108;&#111;&#103; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;) 90 parent widget of this dialog (QWidget)
91 </dd> 91 </dd>
92 </dl><a NAME="EricapiExecDialog.__finish" ID="EricapiExecDialog.__finish"></a> 92 </dl><a NAME="EricapiExecDialog.__finish" ID="EricapiExecDialog.__finish"></a>
93 <h4>EricapiExecDialog.__finish</h4> 93 <h4>EricapiExecDialog.__finish</h4>
94 <b>__finish</b>(<i></i>) 94 <b>__finish</b>(<i></i>)
95 <p> 95 <p>
96 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; w&#104;&#101;&#110; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#102;&#105;&#110;&#105;&#115;&#104;&#101;&#100;. 96 Private slot called when the process finished.
97 </p><p> 97 </p><p>
98 &#73;&#116; &#105;&#115; &#99;&#97;&#108;&#108;&#101;&#100; w&#104;&#101;&#110; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#102;&#105;&#110;&#105;&#115;&#104;&#101;&#100; &#111;&#114; 98 It is called when the process finished or
99 &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#112;&#114;&#101;&#115;&#115;&#101;&#100; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110;. 99 the user pressed the button.
100 </p><a NAME="EricapiExecDialog.__readStderr" ID="EricapiExecDialog.__readStderr"></a> 100 </p><a NAME="EricapiExecDialog.__readStderr" ID="EricapiExecDialog.__readStderr"></a>
101 <h4>EricapiExecDialog.__readStderr</h4> 101 <h4>EricapiExecDialog.__readStderr</h4>
102 <b>__readStderr</b>(<i></i>) 102 <b>__readStderr</b>(<i></i>)
103 <p> 103 <p>
104 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#69;&#114;&#114;&#111;&#114; &#115;&#105;&#103;&#110;&#97;&#108;. 104 Private slot to handle the readyReadStandardError signal.
105 </p><p> 105 </p><p>
106 &#73;&#116; &#114;&#101;&#97;&#100;&#115; &#116;&#104;&#101; &#101;&#114;&#114;&#111;&#114; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#97;&#110;&#100; &#105;&#110;&#115;&#101;&#114;&#116;&#115; &#105;&#116; &#105;&#110;&#116;&#111; &#116;&#104;&#101; 106 It reads the error output of the process and inserts it into the
107 &#101;&#114;&#114;&#111;&#114; &#112;&#97;&#110;&#101;. 107 error pane.
108 </p><a NAME="EricapiExecDialog.__readStdout" ID="EricapiExecDialog.__readStdout"></a> 108 </p><a NAME="EricapiExecDialog.__readStdout" ID="EricapiExecDialog.__readStdout"></a>
109 <h4>EricapiExecDialog.__readStdout</h4> 109 <h4>EricapiExecDialog.__readStdout</h4>
110 <b>__readStdout</b>(<i></i>) 110 <b>__readStdout</b>(<i></i>)
111 <p> 111 <p>
112 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#79;&#117;&#116;&#112;&#117;&#116; &#115;&#105;&#103;&#110;&#97;&#108;. 112 Private slot to handle the readyReadStandardOutput signal.
113 </p><p> 113 </p><p>
114 &#73;&#116; &#114;&#101;&#97;&#100;&#115; &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115;, &#102;&#111;&#114;&#109;&#97;&#116;&#115; &#105;&#116; &#97;&#110;&#100; &#105;&#110;&#115;&#101;&#114;&#116;&#115; &#105;&#116; &#105;&#110;&#116;&#111; 114 It reads the output of the process, formats it and inserts it into
115 &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#112;&#97;&#110;&#101;. 115 the contents pane.
116 </p><a NAME="EricapiExecDialog.on_buttonBox_clicked" ID="EricapiExecDialog.on_buttonBox_clicked"></a> 116 </p><a NAME="EricapiExecDialog.on_buttonBox_clicked" ID="EricapiExecDialog.on_buttonBox_clicked"></a>
117 <h4>EricapiExecDialog.on_buttonBox_clicked</h4> 117 <h4>EricapiExecDialog.on_buttonBox_clicked</h4>
118 <b>on_buttonBox_clicked</b>(<i>button</i>) 118 <b>on_buttonBox_clicked</b>(<i>button</i>)
119 <p> 119 <p>
120 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#98;&#111;x &#99;&#108;&#105;&#99;&#107;&#101;&#100;. 120 Private slot called by a button of the button box clicked.
121 </p><dl> 121 </p><dl>
122 <dt><i>button</i></dt> 122 <dt><i>button</i></dt>
123 <dd> 123 <dd>
124 &#98;&#117;&#116;&#116;&#111;&#110; &#116;&#104;&#97;&#116; w&#97;&#115; &#99;&#108;&#105;&#99;&#107;&#101;&#100; (&#81;&#65;&#98;&#115;&#116;&#114;&#97;&#99;&#116;&#66;&#117;&#116;&#116;&#111;&#110;) 124 button that was clicked (QAbstractButton)
125 </dd> 125 </dd>
126 </dl><a NAME="EricapiExecDialog.start" ID="EricapiExecDialog.start"></a> 126 </dl><a NAME="EricapiExecDialog.start" ID="EricapiExecDialog.start"></a>
127 <h4>EricapiExecDialog.start</h4> 127 <h4>EricapiExecDialog.start</h4>
128 <b>start</b>(<i>args, fn</i>) 128 <b>start</b>(<i>args, fn</i>)
129 <p> 129 <p>
130 &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#97;&#112;&#105; &#99;&#111;&#109;&#109;&#97;&#110;&#100;. 130 Public slot to start the ericapi command.
131 </p><dl> 131 </p><dl>
132 <dt><i>args</i></dt> 132 <dt><i>args</i></dt>
133 <dd> 133 <dd>
134 &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#97;&#114;&#103;&#117;&#109;&#101;&#110;&#116;&#115; &#102;&#111;&#114; &#101;&#114;&#105;&#99;&#97;&#112;&#105; &#112;&#114;&#111;&#103;&#114;&#97;&#109; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;) 134 commandline arguments for ericapi program (list of strings)
135 </dd><dt><i>fn</i></dt> 135 </dd><dt><i>fn</i></dt>
136 <dd> 136 <dd>
137 &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#114; &#100;&#105;&#114;&#110;&#97;&#109;&#101; &#116;&#111; &#98;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115;&#101;&#100; &#98;y &#101;&#114;&#105;&#99;&#97;&#112;&#105; &#112;&#114;&#111;&#103;&#114;&#97;&#109; (&#115;&#116;&#114;&#105;&#110;&#103;) 137 filename or dirname to be processed by ericapi program (string)
138 </dd> 138 </dd>
139 </dl><dl> 139 </dl><dl>
140 <dt>Returns:</dt> 140 <dt>Returns:</dt>
141 <dd> 141 <dd>
142 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#115;&#117;&#99;&#99;&#101;&#115;&#115;&#102;&#117;&#108; &#115;&#116;&#97;&#114;&#116; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 142 flag indicating the successful start of the process (boolean)
143 </dd> 143 </dd>
144 </dl> 144 </dl>
145 <div align="right"><a href="#top">Up</a></div> 145 <div align="right"><a href="#top">Up</a></div>
146 <hr /> 146 <hr />
147 </body></html> 147 </body></html>

Mercurial Repository: eric

eric ide

mercurial