Mercurial Repositories > eric / file diff

diff: Documentation/Source/eric5.Plugins.PluginPep8Checker.html

Documentation/Source/eric5.Plugins.PluginPep8Checker.html

changeset 832
eb5ff61f927b
child 945
8cd4d08fa9f6
child 1278
fb0460fd00b9
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.PluginPep8Checker.html	Sun Jan 09 18:16:46 2011 +0100
@@ -0,0 +1,209 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.Plugins.PluginPep8Checker</title>
+<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.PluginPep8Checker</h1>
+<p>
+Module implementing the PEP 8 Checker plugin.
+</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="#Pep8CheckerPlugin">Pep8CheckerPlugin</a></td>
+<td>Class implementing the PEP 8 Checker plugin.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="Pep8CheckerPlugin" ID="Pep8CheckerPlugin"></a>
+<h2>Pep8CheckerPlugin</h2>
+<p>
+    Class implementing the PEP 8 Checker plugin.
+</p>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Pep8CheckerPlugin.__init__">Pep8CheckerPlugin</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#Pep8CheckerPlugin.__editorClosed">__editorClosed</a></td>
+<td>Private slot called, when an editor was closed.</td>
+</tr><tr>
+<td><a href="#Pep8CheckerPlugin.__editorOpened">__editorOpened</a></td>
+<td>Private slot called, when a new editor was opened.</td>
+</tr><tr>
+<td><a href="#Pep8CheckerPlugin.__editorPep8Check">__editorPep8Check</a></td>
+<td>Private slot to handle the PEP 8 check context menu action of the editors.</td>
+</tr><tr>
+<td><a href="#Pep8CheckerPlugin.__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="#Pep8CheckerPlugin.__initialize">__initialize</a></td>
+<td>Private slot to (re)initialize the plugin.</td>
+</tr><tr>
+<td><a href="#Pep8CheckerPlugin.__projectBrowserPep8Check">__projectBrowserPep8Check</a></td>
+<td>Private method to handle the PEP 8 check context menu action of the project sources browser.</td>
+</tr><tr>
+<td><a href="#Pep8CheckerPlugin.__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="#Pep8CheckerPlugin.__projectPep8Check">__projectPep8Check</a></td>
+<td>Public slot used to check the project files for PEP 8 compliance.</td>
+</tr><tr>
+<td><a href="#Pep8CheckerPlugin.__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="#Pep8CheckerPlugin.activate">activate</a></td>
+<td>Public method to activate this plugin.</td>
+</tr><tr>
+<td><a href="#Pep8CheckerPlugin.deactivate">deactivate</a></td>
+<td>Public method to deactivate this plugin.</td>
+</tr>
+</table>
+<a NAME="Pep8CheckerPlugin.__init__" ID="Pep8CheckerPlugin.__init__"></a>
+<h4>Pep8CheckerPlugin (Constructor)</h4>
+<b>Pep8CheckerPlugin</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="Pep8CheckerPlugin.__editorClosed" ID="Pep8CheckerPlugin.__editorClosed"></a>
+<h4>Pep8CheckerPlugin.__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="Pep8CheckerPlugin.__editorOpened" ID="Pep8CheckerPlugin.__editorOpened"></a>
+<h4>Pep8CheckerPlugin.__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="Pep8CheckerPlugin.__editorPep8Check" ID="Pep8CheckerPlugin.__editorPep8Check"></a>
+<h4>Pep8CheckerPlugin.__editorPep8Check</h4>
+<b>__editorPep8Check</b>(<i></i>)
+<p>
+        Private slot to handle the PEP 8 check context menu action
+        of the editors.
+</p><a NAME="Pep8CheckerPlugin.__editorShowMenu" ID="Pep8CheckerPlugin.__editorShowMenu"></a>
+<h4>Pep8CheckerPlugin.__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="Pep8CheckerPlugin.__initialize" ID="Pep8CheckerPlugin.__initialize"></a>
+<h4>Pep8CheckerPlugin.__initialize</h4>
+<b>__initialize</b>(<i></i>)
+<p>
+        Private slot to (re)initialize the plugin.
+</p><a NAME="Pep8CheckerPlugin.__projectBrowserPep8Check" ID="Pep8CheckerPlugin.__projectBrowserPep8Check"></a>
+<h4>Pep8CheckerPlugin.__projectBrowserPep8Check</h4>
+<b>__projectBrowserPep8Check</b>(<i></i>)
+<p>
+        Private method to handle the PEP 8 check context menu action of
+        the project sources browser.
+</p><a NAME="Pep8CheckerPlugin.__projectBrowserShowMenu" ID="Pep8CheckerPlugin.__projectBrowserShowMenu"></a>
+<h4>Pep8CheckerPlugin.__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="Pep8CheckerPlugin.__projectPep8Check" ID="Pep8CheckerPlugin.__projectPep8Check"></a>
+<h4>Pep8CheckerPlugin.__projectPep8Check</h4>
+<b>__projectPep8Check</b>(<i></i>)
+<p>
+        Public slot used to check the project files for PEP 8 compliance.
+</p><a NAME="Pep8CheckerPlugin.__projectShowMenu" ID="Pep8CheckerPlugin.__projectShowMenu"></a>
+<h4>Pep8CheckerPlugin.__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="Pep8CheckerPlugin.activate" ID="Pep8CheckerPlugin.activate"></a>
+<h4>Pep8CheckerPlugin.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="Pep8CheckerPlugin.deactivate" ID="Pep8CheckerPlugin.deactivate"></a>
+<h4>Pep8CheckerPlugin.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

Mercurial Repository: eric

eric ide

mercurial