Mercurial Repositories > Protobuf and gRPC Extension / file comparison
comparison: ExtensionProtobuf/Documentation/source/Plugin_Extension_Protobuf.PluginExtensionProtobuf.html
ExtensionProtobuf/Documentation/source/Plugin_Extension_Protobuf.PluginExtensionProtobuf.html
- changeset 1
- 7157a39d4a0f
- child 10
- 362689624e2d
equal
deleted
inserted
replaced
| 0:f6cff7759b24 | 1:7157a39d4a0f |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Extension_Protobuf.PluginExtensionProtobuf</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>Plugin_Extension_Protobuf.PluginExtensionProtobuf</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a plugin to add support for Protobuf development. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>protobufExtensionPluginObject</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#ProtobufExtensionPlugin">ProtobufExtensionPlugin</a></td> | |
| 25 <td>Class implementing a plugin to add support for Protobuf development.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#createProtobufPage">createProtobufPage</a></td> | |
| 34 <td>Module function to create the Protobuf configuration page.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td> | |
| 38 <td>Module function to support the display of some executable info.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#getConfigData">getConfigData</a></td> | |
| 42 <td>Module function returning data as required by the configuration dialog.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#installDependencies">installDependencies</a></td> | |
| 46 <td>Function to install dependencies of this plug-in.</td> | |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 50 <td>Module function to prepare for an un-installation.</td> | |
| 51 </tr> | |
| 52 </table> | |
| 53 <hr /> | |
| 54 <hr /> | |
| 55 <a NAME="ProtobufExtensionPlugin" ID="ProtobufExtensionPlugin"></a> | |
| 56 <h2>ProtobufExtensionPlugin</h2> | |
| 57 | |
| 58 <p> | |
| 59 Class implementing a plugin to add support for Protobuf development. | |
| 60 </p> | |
| 61 <h3>Derived from</h3> | |
| 62 QObject | |
| 63 <h3>Class Attributes</h3> | |
| 64 | |
| 65 <table> | |
| 66 <tr><td>PreferencesKey</td></tr> | |
| 67 </table> | |
| 68 <h3>Class Methods</h3> | |
| 69 | |
| 70 <table> | |
| 71 <tr><td>None</td></tr> | |
| 72 </table> | |
| 73 <h3>Methods</h3> | |
| 74 | |
| 75 <table> | |
| 76 | |
| 77 <tr> | |
| 78 <td><a href="#ProtobufExtensionPlugin.__init__">ProtobufExtensionPlugin</a></td> | |
| 79 <td>Constructor</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#ProtobufExtensionPlugin.__initialize">__initialize</a></td> | |
| 83 <td>Private slot to (re)initialize the plugin.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#ProtobufExtensionPlugin.__loadTranslator">__loadTranslator</a></td> | |
| 87 <td>Private method to load the translation file.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#ProtobufExtensionPlugin.activate">activate</a></td> | |
| 91 <td>Public method to activate this plug-in.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#ProtobufExtensionPlugin.deactivate">deactivate</a></td> | |
| 95 <td>Public method to deactivate this plug-in.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#ProtobufExtensionPlugin.getPreferences">getPreferences</a></td> | |
| 99 <td>Public method to retrieve the various settings values.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#ProtobufExtensionPlugin.setPreferences">setPreferences</a></td> | |
| 103 <td>Public method to store the various settings values.</td> | |
| 104 </tr> | |
| 105 </table> | |
| 106 <h3>Static Methods</h3> | |
| 107 | |
| 108 <table> | |
| 109 <tr><td>None</td></tr> | |
| 110 </table> | |
| 111 | |
| 112 <a NAME="ProtobufExtensionPlugin.__init__" ID="ProtobufExtensionPlugin.__init__"></a> | |
| 113 <h4>ProtobufExtensionPlugin (Constructor)</h4> | |
| 114 <b>ProtobufExtensionPlugin</b>(<i>ui</i>) | |
| 115 | |
| 116 <p> | |
| 117 Constructor | |
| 118 </p> | |
| 119 <dl> | |
| 120 | |
| 121 <dt><i>ui</i> (UI.UserInterface)</dt> | |
| 122 <dd> | |
| 123 reference to the user interface object | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <a NAME="ProtobufExtensionPlugin.__initialize" ID="ProtobufExtensionPlugin.__initialize"></a> | |
| 127 <h4>ProtobufExtensionPlugin.__initialize</h4> | |
| 128 <b>__initialize</b>(<i></i>) | |
| 129 | |
| 130 <p> | |
| 131 Private slot to (re)initialize the plugin. | |
| 132 </p> | |
| 133 <a NAME="ProtobufExtensionPlugin.__loadTranslator" ID="ProtobufExtensionPlugin.__loadTranslator"></a> | |
| 134 <h4>ProtobufExtensionPlugin.__loadTranslator</h4> | |
| 135 <b>__loadTranslator</b>(<i></i>) | |
| 136 | |
| 137 <p> | |
| 138 Private method to load the translation file. | |
| 139 </p> | |
| 140 <a NAME="ProtobufExtensionPlugin.activate" ID="ProtobufExtensionPlugin.activate"></a> | |
| 141 <h4>ProtobufExtensionPlugin.activate</h4> | |
| 142 <b>activate</b>(<i></i>) | |
| 143 | |
| 144 <p> | |
| 145 Public method to activate this plug-in. | |
| 146 </p> | |
| 147 <dl> | |
| 148 <dt>Return:</dt> | |
| 149 <dd> | |
| 150 tuple of None and activation status | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <dl> | |
| 154 <dt>Return Type:</dt> | |
| 155 <dd> | |
| 156 bool | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <a NAME="ProtobufExtensionPlugin.deactivate" ID="ProtobufExtensionPlugin.deactivate"></a> | |
| 160 <h4>ProtobufExtensionPlugin.deactivate</h4> | |
| 161 <b>deactivate</b>(<i></i>) | |
| 162 | |
| 163 <p> | |
| 164 Public method to deactivate this plug-in. | |
| 165 </p> | |
| 166 <a NAME="ProtobufExtensionPlugin.getPreferences" ID="ProtobufExtensionPlugin.getPreferences"></a> | |
| 167 <h4>ProtobufExtensionPlugin.getPreferences</h4> | |
| 168 <b>getPreferences</b>(<i>key</i>) | |
| 169 | |
| 170 <p> | |
| 171 Public method to retrieve the various settings values. | |
| 172 </p> | |
| 173 <dl> | |
| 174 | |
| 175 <dt><i>key</i> (str)</dt> | |
| 176 <dd> | |
| 177 the key of the value to get | |
| 178 </dd> | |
| 179 </dl> | |
| 180 <dl> | |
| 181 <dt>Return:</dt> | |
| 182 <dd> | |
| 183 the requested setting value | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <dl> | |
| 187 <dt>Return Type:</dt> | |
| 188 <dd> | |
| 189 any | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <a NAME="ProtobufExtensionPlugin.setPreferences" ID="ProtobufExtensionPlugin.setPreferences"></a> | |
| 193 <h4>ProtobufExtensionPlugin.setPreferences</h4> | |
| 194 <b>setPreferences</b>(<i>key, value</i>) | |
| 195 | |
| 196 <p> | |
| 197 Public method to store the various settings values. | |
| 198 </p> | |
| 199 <dl> | |
| 200 | |
| 201 <dt><i>key</i> (str)</dt> | |
| 202 <dd> | |
| 203 the key of the setting to be set | |
| 204 </dd> | |
| 205 <dt><i>value</i> (any)</dt> | |
| 206 <dd> | |
| 207 the value to be set | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <div align="right"><a href="#top">Up</a></div> | |
| 211 <hr /> | |
| 212 <hr /> | |
| 213 <a NAME="createProtobufPage" ID="createProtobufPage"></a> | |
| 214 <h2>createProtobufPage</h2> | |
| 215 <b>createProtobufPage</b>(<i>configDlg</i>) | |
| 216 | |
| 217 <p> | |
| 218 Module function to create the Protobuf configuration page. | |
| 219 </p> | |
| 220 <dl> | |
| 221 | |
| 222 <dt><i>configDlg</i> (ConfigurationWidget)</dt> | |
| 223 <dd> | |
| 224 reference to the configuration dialog | |
| 225 </dd> | |
| 226 </dl> | |
| 227 <dl> | |
| 228 <dt>Return:</dt> | |
| 229 <dd> | |
| 230 reference to the configuration page | |
| 231 </dd> | |
| 232 </dl> | |
| 233 <dl> | |
| 234 <dt>Return Type:</dt> | |
| 235 <dd> | |
| 236 CorbaPage | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <div align="right"><a href="#top">Up</a></div> | |
| 240 <hr /> | |
| 241 <hr /> | |
| 242 <a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a> | |
| 243 <h2>exeDisplayDataList</h2> | |
| 244 <b>exeDisplayDataList</b>(<i></i>) | |
| 245 | |
| 246 <p> | |
| 247 Module function to support the display of some executable info. | |
| 248 </p> | |
| 249 <dl> | |
| 250 <dt>Return:</dt> | |
| 251 <dd> | |
| 252 list of dictionaries containing the data to query the presence of | |
| 253 the executable | |
| 254 </dd> | |
| 255 </dl> | |
| 256 <dl> | |
| 257 <dt>Return Type:</dt> | |
| 258 <dd> | |
| 259 list of dict | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <div align="right"><a href="#top">Up</a></div> | |
| 263 <hr /> | |
| 264 <hr /> | |
| 265 <a NAME="getConfigData" ID="getConfigData"></a> | |
| 266 <h2>getConfigData</h2> | |
| 267 <b>getConfigData</b>(<i></i>) | |
| 268 | |
| 269 <p> | |
| 270 Module function returning data as required by the configuration dialog. | |
| 271 </p> | |
| 272 <dl> | |
| 273 <dt>Return:</dt> | |
| 274 <dd> | |
| 275 dictionary containing the relevant data | |
| 276 </dd> | |
| 277 </dl> | |
| 278 <dl> | |
| 279 <dt>Return Type:</dt> | |
| 280 <dd> | |
| 281 dict | |
| 282 </dd> | |
| 283 </dl> | |
| 284 <div align="right"><a href="#top">Up</a></div> | |
| 285 <hr /> | |
| 286 <hr /> | |
| 287 <a NAME="installDependencies" ID="installDependencies"></a> | |
| 288 <h2>installDependencies</h2> | |
| 289 <b>installDependencies</b>(<i>pipInstall</i>) | |
| 290 | |
| 291 <p> | |
| 292 Function to install dependencies of this plug-in. | |
| 293 </p> | |
| 294 <dl> | |
| 295 | |
| 296 <dt><i>pipInstall</i> (function)</dt> | |
| 297 <dd> | |
| 298 function to be called with a list of package names. | |
| 299 </dd> | |
| 300 </dl> | |
| 301 <div align="right"><a href="#top">Up</a></div> | |
| 302 <hr /> | |
| 303 <hr /> | |
| 304 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 305 <h2>prepareUninstall</h2> | |
| 306 <b>prepareUninstall</b>(<i></i>) | |
| 307 | |
| 308 <p> | |
| 309 Module function to prepare for an un-installation. | |
| 310 </p> | |
| 311 <div align="right"><a href="#top">Up</a></div> | |
| 312 <hr /> | |
| 313 </body></html> |
