Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.SystemUtilities.QtUtilities.html
src/eric7/Documentation/Source/eric7.SystemUtilities.QtUtilities.html
- branch
- eric7
- changeset 9624
- b47dfa7a137d
- child 10158
- b5aadedf4214
equal
deleted
inserted
replaced
| 9623:9c1f429cb56b | 9624:b47dfa7a137d |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.SystemUtilities.QtUtilities</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>eric7.SystemUtilities.QtUtilities</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing Qt/PyQt/PySide related utility functions. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#checkPyside">checkPyside</a></td> | |
| 30 <td>Module function to check the presence of PySide2/PySide6.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#generatePyQtToolPath">generatePyQtToolPath</a></td> | |
| 34 <td>Module function to generate the executable path for a PyQt tool.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#generatePySideToolPath">generatePySideToolPath</a></td> | |
| 38 <td>Module function to generate the executable path for a PySide2/PySide6 tool.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#generateQtToolName">generateQtToolName</a></td> | |
| 42 <td>Module function to generate the executable name for a Qt tool like designer.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#getPyQt6ModulesDirectory">getPyQt6ModulesDirectory</a></td> | |
| 46 <td>Function to determine the path to PyQt6 modules directory.</td> | |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#getPyQtToolsPath">getPyQtToolsPath</a></td> | |
| 50 <td>Module function to get the path of the PyQt tools.</td> | |
| 51 </tr> | |
| 52 <tr> | |
| 53 <td><a href="#getQtBinariesPath">getQtBinariesPath</a></td> | |
| 54 <td>Module function to get the path of the Qt binaries.</td> | |
| 55 </tr> | |
| 56 <tr> | |
| 57 <td><a href="#getQtMacBundle">getQtMacBundle</a></td> | |
| 58 <td>Module function to determine the correct Mac OS X bundle name for Qt tools.</td> | |
| 59 </tr> | |
| 60 <tr> | |
| 61 <td><a href="#prepareQtMacBundle">prepareQtMacBundle</a></td> | |
| 62 <td>Module function for starting Qt tools that are Mac OS X bundles.</td> | |
| 63 </tr> | |
| 64 <tr> | |
| 65 <td><a href="#qVersionTuple">qVersionTuple</a></td> | |
| 66 <td>Module function to get the Qt version as a tuple.</td> | |
| 67 </tr> | |
| 68 </table> | |
| 69 <hr /> | |
| 70 <hr /> | |
| 71 <a NAME="checkPyside" ID="checkPyside"></a> | |
| 72 <h2>checkPyside</h2> | |
| 73 <b>checkPyside</b>(<i>variant=2</i>) | |
| 74 | |
| 75 <p> | |
| 76 Module function to check the presence of PySide2/PySide6. | |
| 77 </p> | |
| 78 <dl> | |
| 79 | |
| 80 <dt><i>variant</i> (int or str)</dt> | |
| 81 <dd> | |
| 82 indicator for the PySide variant | |
| 83 </dd> | |
| 84 </dl> | |
| 85 <dl> | |
| 86 <dt>Return:</dt> | |
| 87 <dd> | |
| 88 flags indicating the presence of PySide2/PySide6 | |
| 89 </dd> | |
| 90 </dl> | |
| 91 <dl> | |
| 92 <dt>Return Type:</dt> | |
| 93 <dd> | |
| 94 bool | |
| 95 </dd> | |
| 96 </dl> | |
| 97 <div align="right"><a href="#top">Up</a></div> | |
| 98 <hr /> | |
| 99 <hr /> | |
| 100 <a NAME="generatePyQtToolPath" ID="generatePyQtToolPath"></a> | |
| 101 <h2>generatePyQtToolPath</h2> | |
| 102 <b>generatePyQtToolPath</b>(<i>toolname, alternatives=None</i>) | |
| 103 | |
| 104 <p> | |
| 105 Module function to generate the executable path for a PyQt tool. | |
| 106 </p> | |
| 107 <dl> | |
| 108 | |
| 109 <dt><i>toolname</i> (str)</dt> | |
| 110 <dd> | |
| 111 base name of the tool | |
| 112 </dd> | |
| 113 <dt><i>alternatives</i> (list of str)</dt> | |
| 114 <dd> | |
| 115 list of alternative tool names to try | |
| 116 </dd> | |
| 117 </dl> | |
| 118 <dl> | |
| 119 <dt>Return:</dt> | |
| 120 <dd> | |
| 121 executable path name of the tool | |
| 122 </dd> | |
| 123 </dl> | |
| 124 <dl> | |
| 125 <dt>Return Type:</dt> | |
| 126 <dd> | |
| 127 str | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <div align="right"><a href="#top">Up</a></div> | |
| 131 <hr /> | |
| 132 <hr /> | |
| 133 <a NAME="generatePySideToolPath" ID="generatePySideToolPath"></a> | |
| 134 <h2>generatePySideToolPath</h2> | |
| 135 <b>generatePySideToolPath</b>(<i>toolname, variant=2</i>) | |
| 136 | |
| 137 <p> | |
| 138 Module function to generate the executable path for a PySide2/PySide6 tool. | |
| 139 </p> | |
| 140 <dl> | |
| 141 | |
| 142 <dt><i>toolname</i> (str)</dt> | |
| 143 <dd> | |
| 144 base name of the tool | |
| 145 </dd> | |
| 146 <dt><i>variant</i> (int or str)</dt> | |
| 147 <dd> | |
| 148 indicator for the PySide variant | |
| 149 </dd> | |
| 150 </dl> | |
| 151 <dl> | |
| 152 <dt>Return:</dt> | |
| 153 <dd> | |
| 154 the PySide2/PySide6 tool path with extension | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <dl> | |
| 158 <dt>Return Type:</dt> | |
| 159 <dd> | |
| 160 str | |
| 161 </dd> | |
| 162 </dl> | |
| 163 <div align="right"><a href="#top">Up</a></div> | |
| 164 <hr /> | |
| 165 <hr /> | |
| 166 <a NAME="generateQtToolName" ID="generateQtToolName"></a> | |
| 167 <h2>generateQtToolName</h2> | |
| 168 <b>generateQtToolName</b>(<i>toolname</i>) | |
| 169 | |
| 170 <p> | |
| 171 Module function to generate the executable name for a Qt tool like | |
| 172 designer. | |
| 173 </p> | |
| 174 <dl> | |
| 175 | |
| 176 <dt><i>toolname</i></dt> | |
| 177 <dd> | |
| 178 base name of the tool (string) | |
| 179 </dd> | |
| 180 </dl> | |
| 181 <dl> | |
| 182 <dt>Return:</dt> | |
| 183 <dd> | |
| 184 the Qt tool name without extension (string) | |
| 185 </dd> | |
| 186 </dl> | |
| 187 <div align="right"><a href="#top">Up</a></div> | |
| 188 <hr /> | |
| 189 <hr /> | |
| 190 <a NAME="getPyQt6ModulesDirectory" ID="getPyQt6ModulesDirectory"></a> | |
| 191 <h2>getPyQt6ModulesDirectory</h2> | |
| 192 <b>getPyQt6ModulesDirectory</b>(<i></i>) | |
| 193 | |
| 194 <p> | |
| 195 Function to determine the path to PyQt6 modules directory. | |
| 196 </p> | |
| 197 <dl> | |
| 198 <dt>Return:</dt> | |
| 199 <dd> | |
| 200 path to the PyQt6 modules directory | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <dl> | |
| 204 <dt>Return Type:</dt> | |
| 205 <dd> | |
| 206 str | |
| 207 </dd> | |
| 208 </dl> | |
| 209 <div align="right"><a href="#top">Up</a></div> | |
| 210 <hr /> | |
| 211 <hr /> | |
| 212 <a NAME="getPyQtToolsPath" ID="getPyQtToolsPath"></a> | |
| 213 <h2>getPyQtToolsPath</h2> | |
| 214 <b>getPyQtToolsPath</b>(<i>version=5</i>) | |
| 215 | |
| 216 <p> | |
| 217 Module function to get the path of the PyQt tools. | |
| 218 </p> | |
| 219 <dl> | |
| 220 | |
| 221 <dt><i>version</i> (int)</dt> | |
| 222 <dd> | |
| 223 PyQt major version | |
| 224 </dd> | |
| 225 </dl> | |
| 226 <dl> | |
| 227 <dt>Return:</dt> | |
| 228 <dd> | |
| 229 path to the PyQt tools | |
| 230 </dd> | |
| 231 </dl> | |
| 232 <dl> | |
| 233 <dt>Return Type:</dt> | |
| 234 <dd> | |
| 235 str | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <div align="right"><a href="#top">Up</a></div> | |
| 239 <hr /> | |
| 240 <hr /> | |
| 241 <a NAME="getQtBinariesPath" ID="getQtBinariesPath"></a> | |
| 242 <h2>getQtBinariesPath</h2> | |
| 243 <b>getQtBinariesPath</b>(<i>libexec=False</i>) | |
| 244 | |
| 245 <p> | |
| 246 Module function to get the path of the Qt binaries. | |
| 247 </p> | |
| 248 <dl> | |
| 249 | |
| 250 <dt><i>libexec</i> (bool (optional))</dt> | |
| 251 <dd> | |
| 252 flag indicating to get the path of the executable library | |
| 253 (defaults to False) | |
| 254 </dd> | |
| 255 </dl> | |
| 256 <dl> | |
| 257 <dt>Return:</dt> | |
| 258 <dd> | |
| 259 path of the Qt binaries | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <dl> | |
| 263 <dt>Return Type:</dt> | |
| 264 <dd> | |
| 265 str | |
| 266 </dd> | |
| 267 </dl> | |
| 268 <div align="right"><a href="#top">Up</a></div> | |
| 269 <hr /> | |
| 270 <hr /> | |
| 271 <a NAME="getQtMacBundle" ID="getQtMacBundle"></a> | |
| 272 <h2>getQtMacBundle</h2> | |
| 273 <b>getQtMacBundle</b>(<i>toolname</i>) | |
| 274 | |
| 275 <p> | |
| 276 Module function to determine the correct Mac OS X bundle name for Qt tools. | |
| 277 </p> | |
| 278 <dl> | |
| 279 | |
| 280 <dt><i>toolname</i></dt> | |
| 281 <dd> | |
| 282 plain name of the tool (e.g. "designer") (string) | |
| 283 </dd> | |
| 284 </dl> | |
| 285 <dl> | |
| 286 <dt>Return:</dt> | |
| 287 <dd> | |
| 288 bundle name of the Qt tool (string) | |
| 289 </dd> | |
| 290 </dl> | |
| 291 <div align="right"><a href="#top">Up</a></div> | |
| 292 <hr /> | |
| 293 <hr /> | |
| 294 <a NAME="prepareQtMacBundle" ID="prepareQtMacBundle"></a> | |
| 295 <h2>prepareQtMacBundle</h2> | |
| 296 <b>prepareQtMacBundle</b>(<i>toolname, args</i>) | |
| 297 | |
| 298 <p> | |
| 299 Module function for starting Qt tools that are Mac OS X bundles. | |
| 300 </p> | |
| 301 <dl> | |
| 302 | |
| 303 <dt><i>toolname</i> (str)</dt> | |
| 304 <dd> | |
| 305 plain name of the tool (e.g. "designer") | |
| 306 </dd> | |
| 307 <dt><i>args</i> (list of str)</dt> | |
| 308 <dd> | |
| 309 name of input file for tool, if any | |
| 310 </dd> | |
| 311 </dl> | |
| 312 <dl> | |
| 313 <dt>Return:</dt> | |
| 314 <dd> | |
| 315 command-name and args for QProcess | |
| 316 </dd> | |
| 317 </dl> | |
| 318 <dl> | |
| 319 <dt>Return Type:</dt> | |
| 320 <dd> | |
| 321 tuple of (str, list of str) | |
| 322 </dd> | |
| 323 </dl> | |
| 324 <div align="right"><a href="#top">Up</a></div> | |
| 325 <hr /> | |
| 326 <hr /> | |
| 327 <a NAME="qVersionTuple" ID="qVersionTuple"></a> | |
| 328 <h2>qVersionTuple</h2> | |
| 329 <b>qVersionTuple</b>(<i></i>) | |
| 330 | |
| 331 <p> | |
| 332 Module function to get the Qt version as a tuple. | |
| 333 </p> | |
| 334 <dl> | |
| 335 <dt>Return:</dt> | |
| 336 <dd> | |
| 337 Qt version as a tuple | |
| 338 </dd> | |
| 339 </dl> | |
| 340 <dl> | |
| 341 <dt>Return Type:</dt> | |
| 342 <dd> | |
| 343 tuple of int | |
| 344 </dd> | |
| 345 </dl> | |
| 346 <div align="right"><a href="#top">Up</a></div> | |
| 347 <hr /> | |
| 348 </body></html> |
