Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html
Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.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.Ericapi.EricapiConfigDialog</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.Ericapi.EricapiConfigDialog</h1> | |
| 12 <p> | |
| 13 Module implementing a dialog to enter the parameters for eric5-api. | |
| 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="#EricapiConfigDialog">EricapiConfigDialog</a></td> | |
| 23 <td>Class implementing a dialog to enter the parameters for eric5-api.</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="EricapiConfigDialog" ID="EricapiConfigDialog"></a> | |
| 32 <h2>EricapiConfigDialog</h2> | |
| 33 <p> | |
| 34 Class implementing a dialog to enter the parameters for eric5-api. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 QDialog, Ui_EricapiConfigDialog | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#EricapiConfigDialog.__init__">EricapiConfigDialog</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#EricapiConfigDialog.__initializeDefaults">__initializeDefaults</a></td> | |
| 49 <td>Private method to set the default values.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#EricapiConfigDialog.accept">accept</a></td> | |
| 52 <td>Protected slot called by the Ok button.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#EricapiConfigDialog.generateParameters">generateParameters</a></td> | |
| 55 <td>Public method that generates the commandline parameters.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#EricapiConfigDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 58 <td>Private slot to add the directory displayed to the listview.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#EricapiConfigDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> | |
| 61 <td>Private slot to delete the currently selected directory of the listbox.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#EricapiConfigDialog.on_ignoreDirButton_clicked">on_ignoreDirButton_clicked</a></td> | |
| 64 <td>Private slot to select a directory to be ignored.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#EricapiConfigDialog.on_outputFileButton_clicked">on_outputFileButton_clicked</a></td> | |
| 67 <td>Private slot to select the output file.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#EricapiConfigDialog.on_outputFileEdit_textChanged">on_outputFileEdit_textChanged</a></td> | |
| 70 <td>Private slot to enable/disable the "OK" button.</td> | |
| 71 </tr> | |
| 72 </table> | |
| 73 <a NAME="EricapiConfigDialog.__init__" ID="EricapiConfigDialog.__init__"></a> | |
| 74 <h4>EricapiConfigDialog (Constructor)</h4> | |
| 75 <b>EricapiConfigDialog</b>(<i>project, parms = None, parent = None</i>) | |
| 76 <p> | |
| 77 Constructor | |
| 78 </p><dl> | |
| 79 <dt><i>project</i></dt> | |
| 80 <dd> | |
| 81 reference to the project object (Project.Project) | |
| 82 </dd><dt><i>parms</i></dt> | |
| 83 <dd> | |
| 84 parameters to set in the dialog | |
| 85 </dd><dt><i>parent</i></dt> | |
| 86 <dd> | |
| 87 parent widget of this dialog | |
| 88 </dd> | |
| 89 </dl><a NAME="EricapiConfigDialog.__initializeDefaults" ID="EricapiConfigDialog.__initializeDefaults"></a> | |
| 90 <h4>EricapiConfigDialog.__initializeDefaults</h4> | |
| 91 <b>__initializeDefaults</b>(<i></i>) | |
| 92 <p> | |
| 93 Private method to set the default values. | |
| 94 </p><p> | |
| 95 These are needed later on to generate the commandline | |
| 96 parameters. | |
| 97 </p><a NAME="EricapiConfigDialog.accept" ID="EricapiConfigDialog.accept"></a> | |
| 98 <h4>EricapiConfigDialog.accept</h4> | |
| 99 <b>accept</b>(<i></i>) | |
| 100 <p> | |
| 101 Protected slot called by the Ok button. | |
| 102 </p><p> | |
| 103 It saves the values in the parameters dictionary. | |
| 104 </p><a NAME="EricapiConfigDialog.generateParameters" ID="EricapiConfigDialog.generateParameters"></a> | |
| 105 <h4>EricapiConfigDialog.generateParameters</h4> | |
| 106 <b>generateParameters</b>(<i></i>) | |
| 107 <p> | |
| 108 Public method that generates the commandline parameters. | |
| 109 </p><p> | |
| 110 It generates a list of strings to be used | |
| 111 to set the QProcess arguments for the ericapi call and | |
| 112 a dictionary containing the non default parameters. This | |
| 113 dictionary can be passed back upon object generation to overwrite | |
| 114 the default settings. | |
| 115 </p><dl> | |
| 116 <dt>Returns:</dt> | |
| 117 <dd> | |
| 118 a tuple of the commandline parameters and non default parameters | |
| 119 (list of strings, dictionary) | |
| 120 </dd> | |
| 121 </dl><a NAME="EricapiConfigDialog.on_addButton_clicked" ID="EricapiConfigDialog.on_addButton_clicked"></a> | |
| 122 <h4>EricapiConfigDialog.on_addButton_clicked</h4> | |
| 123 <b>on_addButton_clicked</b>(<i></i>) | |
| 124 <p> | |
| 125 Private slot to add the directory displayed to the listview. | |
| 126 </p><p> | |
| 127 The directory in the ignore directories | |
| 128 line edit is moved to the listbox above and the edit is cleared. | |
| 129 </p><a NAME="EricapiConfigDialog.on_deleteButton_clicked" ID="EricapiConfigDialog.on_deleteButton_clicked"></a> | |
| 130 <h4>EricapiConfigDialog.on_deleteButton_clicked</h4> | |
| 131 <b>on_deleteButton_clicked</b>(<i></i>) | |
| 132 <p> | |
| 133 Private slot to delete the currently selected directory of the listbox. | |
| 134 </p><a NAME="EricapiConfigDialog.on_ignoreDirButton_clicked" ID="EricapiConfigDialog.on_ignoreDirButton_clicked"></a> | |
| 135 <h4>EricapiConfigDialog.on_ignoreDirButton_clicked</h4> | |
| 136 <b>on_ignoreDirButton_clicked</b>(<i></i>) | |
| 137 <p> | |
| 138 Private slot to select a directory to be ignored. | |
| 139 </p><p> | |
| 140 It displays a directory selection dialog to | |
| 141 select a directory to be ignored. | |
| 142 </p><a NAME="EricapiConfigDialog.on_outputFileButton_clicked" ID="EricapiConfigDialog.on_outputFileButton_clicked"></a> | |
| 143 <h4>EricapiConfigDialog.on_outputFileButton_clicked</h4> | |
| 144 <b>on_outputFileButton_clicked</b>(<i></i>) | |
| 145 <p> | |
| 146 Private slot to select the output file. | |
| 147 </p><p> | |
| 148 It displays a file selection dialog to | |
| 149 select the file the api is written to. | |
| 150 </p><a NAME="EricapiConfigDialog.on_outputFileEdit_textChanged" ID="EricapiConfigDialog.on_outputFileEdit_textChanged"></a> | |
| 151 <h4>EricapiConfigDialog.on_outputFileEdit_textChanged</h4> | |
| 152 <b>on_outputFileEdit_textChanged</b>(<i>filename</i>) | |
| 153 <p> | |
| 154 Private slot to enable/disable the "OK" button. | |
| 155 </p><dl> | |
| 156 <dt><i>filename</i></dt> | |
| 157 <dd> | |
| 158 name of the file (string) | |
| 159 </dd> | |
| 160 </dl> | |
| 161 <div align="right"><a href="#top">Up</a></div> | |
| 162 <hr /> | |
| 163 </body></html> |
