--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.PluginCodeStyleChecker.html Fri Oct 04 17:48:17 2013 +0200 @@ -0,0 +1,216 @@ +<!DOCTYPE html> +<html><head> +<title>eric5.Plugins.PluginCodeStyleChecker</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>eric5.Plugins.PluginCodeStyleChecker</h1> +<p> +Module implementing the code style checker plug-in. +</p> +<h3>Global Attributes</h3> +<table> +<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>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#CodeStyleCheckerPlugin">CodeStyleCheckerPlugin</a></td> +<td>Class implementing the code style checker plug-in.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="CodeStyleCheckerPlugin" ID="CodeStyleCheckerPlugin"></a> +<h2>CodeStyleCheckerPlugin</h2> +<p> + Class implementing the code style checker plug-in. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#CodeStyleCheckerPlugin.__init__">CodeStyleCheckerPlugin</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.__editorClosed">__editorClosed</a></td> +<td>Private slot called, when an editor was closed.</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.__editorCodeStyleCheck">__editorCodeStyleCheck</a></td> +<td>Private slot to handle the code style check context menu action of the editors.</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.__editorOpened">__editorOpened</a></td> +<td>Private slot called, when a new editor was opened.</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.__editorShowMenu">__editorShowMenu</a></td> +<td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.__initialize">__initialize</a></td> +<td>Private slot to (re)initialize the plugin.</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck">__projectBrowserCodeStyleCheck</a></td> +<td>Private method to handle the code style check context menu action of the project sources browser.</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td> +<td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.__projectCodeStyleCheck">__projectCodeStyleCheck</a></td> +<td>Public slot used to check the project files for code style.</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.__projectShowMenu">__projectShowMenu</a></td> +<td>Private slot called, when the the project menu or a submenu is about to be shown.</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.activate">activate</a></td> +<td>Public method to activate this plugin.</td> +</tr><tr> +<td><a href="#CodeStyleCheckerPlugin.deactivate">deactivate</a></td> +<td>Public method to deactivate this plugin.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="CodeStyleCheckerPlugin.__init__" ID="CodeStyleCheckerPlugin.__init__"></a> +<h4>CodeStyleCheckerPlugin (Constructor)</h4> +<b>CodeStyleCheckerPlugin</b>(<i>ui</i>) +<p> + Constructor +</p><dl> +<dt><i>ui</i></dt> +<dd> +reference to the user interface object (UI.UserInterface) +</dd> +</dl><a NAME="CodeStyleCheckerPlugin.__editorClosed" ID="CodeStyleCheckerPlugin.__editorClosed"></a> +<h4>CodeStyleCheckerPlugin.__editorClosed</h4> +<b>__editorClosed</b>(<i>editor</i>) +<p> + Private slot called, when an editor was closed. +</p><dl> +<dt><i>editor</i></dt> +<dd> +reference to the editor (QScintilla.Editor) +</dd> +</dl><a NAME="CodeStyleCheckerPlugin.__editorCodeStyleCheck" ID="CodeStyleCheckerPlugin.__editorCodeStyleCheck"></a> +<h4>CodeStyleCheckerPlugin.__editorCodeStyleCheck</h4> +<b>__editorCodeStyleCheck</b>(<i></i>) +<p> + Private slot to handle the code style check context menu action + of the editors. +</p><a NAME="CodeStyleCheckerPlugin.__editorOpened" ID="CodeStyleCheckerPlugin.__editorOpened"></a> +<h4>CodeStyleCheckerPlugin.__editorOpened</h4> +<b>__editorOpened</b>(<i>editor</i>) +<p> + Private slot called, when a new editor was opened. +</p><dl> +<dt><i>editor</i></dt> +<dd> +reference to the new editor (QScintilla.Editor) +</dd> +</dl><a NAME="CodeStyleCheckerPlugin.__editorShowMenu" ID="CodeStyleCheckerPlugin.__editorShowMenu"></a> +<h4>CodeStyleCheckerPlugin.__editorShowMenu</h4> +<b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) +<p> + Private slot called, when the the editor context menu or a submenu is + about to be shown. +</p><dl> +<dt><i>menuName</i></dt> +<dd> +name of the menu to be shown (string) +</dd><dt><i>menu</i></dt> +<dd> +reference to the menu (QMenu) +</dd><dt><i>editor</i></dt> +<dd> +reference to the editor +</dd> +</dl><a NAME="CodeStyleCheckerPlugin.__initialize" ID="CodeStyleCheckerPlugin.__initialize"></a> +<h4>CodeStyleCheckerPlugin.__initialize</h4> +<b>__initialize</b>(<i></i>) +<p> + Private slot to (re)initialize the plugin. +</p><a NAME="CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck"></a> +<h4>CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck</h4> +<b>__projectBrowserCodeStyleCheck</b>(<i></i>) +<p> + Private method to handle the code style check context menu action of + the project sources browser. +</p><a NAME="CodeStyleCheckerPlugin.__projectBrowserShowMenu" ID="CodeStyleCheckerPlugin.__projectBrowserShowMenu"></a> +<h4>CodeStyleCheckerPlugin.__projectBrowserShowMenu</h4> +<b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>) +<p> + Private slot called, when the the project browser menu or a submenu is + about to be shown. +</p><dl> +<dt><i>menuName</i></dt> +<dd> +name of the menu to be shown (string) +</dd><dt><i>menu</i></dt> +<dd> +reference to the menu (QMenu) +</dd> +</dl><a NAME="CodeStyleCheckerPlugin.__projectCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectCodeStyleCheck"></a> +<h4>CodeStyleCheckerPlugin.__projectCodeStyleCheck</h4> +<b>__projectCodeStyleCheck</b>(<i></i>) +<p> + Public slot used to check the project files for code style. +</p><a NAME="CodeStyleCheckerPlugin.__projectShowMenu" ID="CodeStyleCheckerPlugin.__projectShowMenu"></a> +<h4>CodeStyleCheckerPlugin.__projectShowMenu</h4> +<b>__projectShowMenu</b>(<i>menuName, menu</i>) +<p> + Private slot called, when the the project menu or a submenu is + about to be shown. +</p><dl> +<dt><i>menuName</i></dt> +<dd> +name of the menu to be shown (string) +</dd><dt><i>menu</i></dt> +<dd> +reference to the menu (QMenu) +</dd> +</dl><a NAME="CodeStyleCheckerPlugin.activate" ID="CodeStyleCheckerPlugin.activate"></a> +<h4>CodeStyleCheckerPlugin.activate</h4> +<b>activate</b>(<i></i>) +<p> + Public method to activate this plugin. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple of None and activation status (boolean) +</dd> +</dl><a NAME="CodeStyleCheckerPlugin.deactivate" ID="CodeStyleCheckerPlugin.deactivate"></a> +<h4>CodeStyleCheckerPlugin.deactivate</h4> +<b>deactivate</b>(<i></i>) +<p> + Public method to deactivate this plugin. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file