Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations.html
eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing message translations for the code style plugin messages. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>_fixMessages</td></tr><tr><td>_fixMessagesSampleArgs</td></tr><tr><td>_pycodestyleErrorMessages</td></tr><tr><td>_pycodestyleErrorMessagesSampleArgs</td></tr><tr><td>_pycodestyleWarningMessages</td></tr><tr><td>_pycodestyleWarningMessagesSampleArgs</td></tr><tr><td>messageCatalogs</td></tr><tr><td>messageCategoryRe</td></tr><tr><td>messageSampleArgsCatalog</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 <tr><td>None</td></tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 | |
| 40 <table> | |
| 41 | |
| 42 <tr> | |
| 43 <td><a href="#getMessageCodes">getMessageCodes</a></td> | |
| 44 <td>Module function to get a list of known message codes.</td> | |
| 45 </tr> | |
| 46 <tr> | |
| 47 <td><a href="#getTranslatedMessage">getTranslatedMessage</a></td> | |
| 48 <td>Module function to get a translated and formatted message for a given message ID.</td> | |
| 49 </tr> | |
| 50 </table> | |
| 51 <hr /> | |
| 52 <hr /> | |
| 53 <a NAME="getMessageCodes" ID="getMessageCodes"></a> | |
| 54 <h2>getMessageCodes</h2> | |
| 55 <b>getMessageCodes</b>(<i></i>) | |
| 56 | |
| 57 <p> | |
| 58 Module function to get a list of known message codes. | |
| 59 </p> | |
| 60 <dl> | |
| 61 <dt>Return:</dt> | |
| 62 <dd> | |
| 63 list of known message codes | |
| 64 </dd> | |
| 65 </dl> | |
| 66 <dl> | |
| 67 <dt>Return Type:</dt> | |
| 68 <dd> | |
| 69 set of str | |
| 70 </dd> | |
| 71 </dl> | |
| 72 <div align="right"><a href="#top">Up</a></div> | |
| 73 <hr /> | |
| 74 <hr /> | |
| 75 <a NAME="getTranslatedMessage" ID="getTranslatedMessage"></a> | |
| 76 <h2>getTranslatedMessage</h2> | |
| 77 <b>getTranslatedMessage</b>(<i>messageCode, messageArgs, example=False</i>) | |
| 78 | |
| 79 <p> | |
| 80 Module function to get a translated and formatted message for a | |
| 81 given message ID. | |
| 82 </p> | |
| 83 <dl> | |
| 84 | |
| 85 <dt><i>messageCode</i> (str)</dt> | |
| 86 <dd> | |
| 87 the message code | |
| 88 </dd> | |
| 89 <dt><i>messageArgs</i> (list or int)</dt> | |
| 90 <dd> | |
| 91 list of arguments or a single integer value to format | |
| 92 the message | |
| 93 </dd> | |
| 94 <dt><i>example</i> (bool)</dt> | |
| 95 <dd> | |
| 96 flag indicating a translated message filled with example | |
| 97 data is requested (messageArgs is ignored if given) | |
| 98 </dd> | |
| 99 </dl> | |
| 100 <dl> | |
| 101 <dt>Return:</dt> | |
| 102 <dd> | |
| 103 translated and formatted message | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <dl> | |
| 107 <dt>Return Type:</dt> | |
| 108 <dd> | |
| 109 str | |
| 110 </dd> | |
| 111 </dl> | |
| 112 <div align="right"><a href="#top">Up</a></div> | |
| 113 <hr /> | |
| 114 </body></html> |
