eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.translations.html

changeset 7624
6eabbcf3bdf8
parent 7610
df7025fe26a3
child 7989
a21d673a8f99
equal deleted inserted replaced
7623:ddea119f0b1d 7624:6eabbcf3bdf8
26 Module implementing message translations for the code style plugin messages. 26 Module implementing message translations for the code style plugin messages.
27 </p> 27 </p>
28 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29 29
30 <table> 30 <table>
31 <tr><td>__all__</td></tr><tr><td>_messages</td></tr><tr><td>_messages_sample_args</td></tr> 31 <tr><td>_messages</td></tr><tr><td>_messages_sample_args</td></tr><tr><td>messageCatalogs</td></tr><tr><td>messageSampleArgsCatalog</td></tr>
32 </table> 32 </table>
33 <h3>Classes</h3> 33 <h3>Classes</h3>
34 34
35 <table> 35 <table>
36 <tr><td>None</td></tr> 36 <tr><td>None</td></tr>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 39
40 <table> 40 <table>
41 41
42 <tr> 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>
43 <td><a href="#getTranslatedMessage">getTranslatedMessage</a></td> 47 <td><a href="#getTranslatedMessage">getTranslatedMessage</a></td>
44 <td>Module function to get a translated and formatted message for a given message ID.</td> 48 <td>Module function to get a translated and formatted message for a given message ID.</td>
45 </tr> 49 </tr>
46 </table> 50 </table>
47 <hr /> 51 <hr />
48 <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>Returns:</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 />
49 <a NAME="getTranslatedMessage" ID="getTranslatedMessage"></a> 75 <a NAME="getTranslatedMessage" ID="getTranslatedMessage"></a>
50 <h2>getTranslatedMessage</h2> 76 <h2>getTranslatedMessage</h2>
51 <b>getTranslatedMessage</b>(<i>messageCode, messageArgs</i>) 77 <b>getTranslatedMessage</b>(<i>messageCode, messageArgs, example=False</i>)
52 78
53 <p> 79 <p>
54 Module function to get a translated and formatted message for a 80 Module function to get a translated and formatted message for a
55 given message ID. 81 given message ID.
56 </p> 82 </p>
62 </dd> 88 </dd>
63 <dt><i>messageArgs</i> (list or int)</dt> 89 <dt><i>messageArgs</i> (list or int)</dt>
64 <dd> 90 <dd>
65 list of arguments or a single integer value to format 91 list of arguments or a single integer value to format
66 the message 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)
67 </dd> 98 </dd>
68 </dl> 99 </dl>
69 <dl> 100 <dl>
70 <dt>Returns:</dt> 101 <dt>Returns:</dt>
71 <dd> 102 <dd>

eric ide

mercurial