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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,114 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations</h1>
+
+<p>
+Module implementing message translations for the code style plugin messages.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<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>
+</table>
+<h3>Classes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#getMessageCodes">getMessageCodes</a></td>
+<td>Module function to get a list of known message codes.</td>
+</tr>
+<tr>
+<td><a href="#getTranslatedMessage">getTranslatedMessage</a></td>
+<td>Module function to get a translated and formatted message for a given message ID.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="getMessageCodes" ID="getMessageCodes"></a>
+<h2>getMessageCodes</h2>
+<b>getMessageCodes</b>(<i></i>)
+
+<p>
+    Module function to get a list of known message codes.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of known message codes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+set of str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getTranslatedMessage" ID="getTranslatedMessage"></a>
+<h2>getTranslatedMessage</h2>
+<b>getTranslatedMessage</b>(<i>messageCode, messageArgs, example=False</i>)
+
+<p>
+    Module function to get a translated and formatted message for a
+    given message ID.
+</p>
+<dl>
+
+<dt><i>messageCode</i> (str)</dt>
+<dd>
+the message code
+</dd>
+<dt><i>messageArgs</i> (list or int)</dt>
+<dd>
+list of arguments or a single integer value to format
+        the message
+</dd>
+<dt><i>example</i> (bool)</dt>
+<dd>
+flag indicating a translated message filled with example
+        data is requested (messageArgs is ignored if given)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+translated and formatted message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial