Mercurial Repositories > eric / file diff

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

Documentation/Source/eric5.Plugins.PluginTabnanny.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.Plugins.PluginTabnanny.html
--- a/Documentation/Source/eric5.Plugins.PluginTabnanny.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Plugins.PluginTabnanny.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Plugins.PluginTabnanny</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#84;&#97;&#98;&#110;&#97;&#110;&#110;y &#112;&#108;&#117;&#103;&#105;&#110;.
+Module implementing the Tabnanny plugin.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#TabnannyPlugin">TabnannyPlugin</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#84;&#97;&#98;&#110;&#97;&#110;&#110;y &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Class implementing the Tabnanny plugin.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="TabnannyPlugin" ID="TabnannyPlugin"></a>
 <h2>TabnannyPlugin</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#84;&#97;&#98;&#110;&#97;&#110;&#110;y &#112;&#108;&#117;&#103;&#105;&#110;.
+    Class implementing the Tabnanny plugin.
 </p>
 <h3>Derived from</h3>
 QObject
@@ -55,153 +55,153 @@
 <table>
 <tr>
 <td><a href="#TabnannyPlugin.__init__">TabnannyPlugin</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#TabnannyPlugin.__editorClosed">__editorClosed</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#97;&#110; &#101;&#100;&#105;&#116;&#111;&#114; w&#97;&#115; &#99;&#108;&#111;&#115;&#101;&#100;.</td>
+<td>Private slot called, when an editor was closed.</td>
 </tr><tr>
 <td><a href="#TabnannyPlugin.__editorOpened">__editorOpened</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#97; &#110;&#101;w &#101;&#100;&#105;&#116;&#111;&#114; w&#97;&#115; &#111;&#112;&#101;&#110;&#101;&#100;.</td>
+<td>Private slot called, when a new editor was opened.</td>
 </tr><tr>
 <td><a href="#TabnannyPlugin.__editorShowMenu">__editorShowMenu</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#111;&#114; &#97; &#115;&#117;&#98;&#109;&#101;&#110;&#117; &#105;&#115; &#97;&#98;&#111;&#117;&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110;.</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="#TabnannyPlugin.__editorTabnanny">__editorTabnanny</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#116;&#97;&#98;&#110;&#97;&#110;&#110;y &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#97;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114;&#115;.</td>
+<td>Private slot to handle the tabnanny context menu action of the editors.</td>
 </tr><tr>
 <td><a href="#TabnannyPlugin.__initialize">__initialize</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; (&#114;&#101;)&#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#116;&#104;&#101; &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Private slot to (re)initialize the plugin.</td>
 </tr><tr>
 <td><a href="#TabnannyPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#98;&#114;&#111;w&#115;&#101;&#114; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#111;&#114; &#97; &#115;&#117;&#98;&#109;&#101;&#110;&#117; &#105;&#115; &#97;&#98;&#111;&#117;&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110;.</td>
+<td>Private slot called, when the the project browser context menu or a submenu is about to be shown.</td>
 </tr><tr>
 <td><a href="#TabnannyPlugin.__projectBrowserTabnanny">__projectBrowserTabnanny</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#116;&#97;&#98;&#110;&#97;&#110;&#110;y &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#97;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#115;&#111;&#117;&#114;&#99;&#101;&#115; &#98;&#114;&#111;w&#115;&#101;&#114;.</td>
+<td>Private method to handle the tabnanny context menu action of the project sources browser.</td>
 </tr><tr>
 <td><a href="#TabnannyPlugin.__projectShowMenu">__projectShowMenu</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#109;&#101;&#110;&#117; &#111;&#114; &#97; &#115;&#117;&#98;&#109;&#101;&#110;&#117; &#105;&#115; &#97;&#98;&#111;&#117;&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110;.</td>
+<td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
 </tr><tr>
 <td><a href="#TabnannyPlugin.__projectTabnanny">__projectTabnanny</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#105;&#108;&#101;&#115; &#102;&#111;&#114; &#98;&#97;&#100; &#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Public slot used to check the project files for bad indentations.</td>
 </tr><tr>
 <td><a href="#TabnannyPlugin.activate">activate</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Public method to activate this plugin.</td>
 </tr><tr>
 <td><a href="#TabnannyPlugin.deactivate">deactivate</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Public method to deactivate this plugin.</td>
 </tr>
 </table>
 <a NAME="TabnannyPlugin.__init__" ID="TabnannyPlugin.__init__"></a>
 <h4>TabnannyPlugin (Constructor)</h4>
 <b>TabnannyPlugin</b>(<i>ui</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>ui</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#111;&#98;&#106;&#101;&#99;&#116; (&#85;&#73;.&#85;&#115;&#101;&#114;&#73;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;)
+reference to the user interface object (UI.UserInterface)
 </dd>
 </dl><a NAME="TabnannyPlugin.__editorClosed" ID="TabnannyPlugin.__editorClosed"></a>
 <h4>TabnannyPlugin.__editorClosed</h4>
 <b>__editorClosed</b>(<i>editor</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#97;&#110; &#101;&#100;&#105;&#116;&#111;&#114; w&#97;&#115; &#99;&#108;&#111;&#115;&#101;&#100;.
+        Private slot called, when an editor was closed.
 </p><dl>
 <dt><i>editor</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114; (&#81;&#83;&#99;&#105;&#110;&#116;&#105;&#108;&#108;&#97;.&#69;&#100;&#105;&#116;&#111;&#114;)
+reference to the editor (QScintilla.Editor)
 </dd>
 </dl><a NAME="TabnannyPlugin.__editorOpened" ID="TabnannyPlugin.__editorOpened"></a>
 <h4>TabnannyPlugin.__editorOpened</h4>
 <b>__editorOpened</b>(<i>editor</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#97; &#110;&#101;w &#101;&#100;&#105;&#116;&#111;&#114; w&#97;&#115; &#111;&#112;&#101;&#110;&#101;&#100;.
+        Private slot called, when a new editor was opened.
 </p><dl>
 <dt><i>editor</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#110;&#101;w &#101;&#100;&#105;&#116;&#111;&#114; (&#81;&#83;&#99;&#105;&#110;&#116;&#105;&#108;&#108;&#97;.&#69;&#100;&#105;&#116;&#111;&#114;)
+reference to the new editor (QScintilla.Editor)
 </dd>
 </dl><a NAME="TabnannyPlugin.__editorShowMenu" ID="TabnannyPlugin.__editorShowMenu"></a>
 <h4>TabnannyPlugin.__editorShowMenu</h4>
 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#111;&#114; &#97; &#115;&#117;&#98;&#109;&#101;&#110;&#117; &#105;&#115; 
-        &#97;&#98;&#111;&#117;&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110;.
+        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>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#101;&#110;&#117; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the menu to be shown (string)
 </dd><dt><i>menu</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#109;&#101;&#110;&#117; (&#81;&#77;&#101;&#110;&#117;)
+reference to the menu (QMenu)
 </dd><dt><i>editor</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114;
+reference to the editor
 </dd>
 </dl><a NAME="TabnannyPlugin.__editorTabnanny" ID="TabnannyPlugin.__editorTabnanny"></a>
 <h4>TabnannyPlugin.__editorTabnanny</h4>
 <b>__editorTabnanny</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#116;&#97;&#98;&#110;&#97;&#110;&#110;y &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#97;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114;&#115;.
+        Private slot to handle the tabnanny context menu action of the editors.
 </p><a NAME="TabnannyPlugin.__initialize" ID="TabnannyPlugin.__initialize"></a>
 <h4>TabnannyPlugin.__initialize</h4>
 <b>__initialize</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; (&#114;&#101;)&#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#116;&#104;&#101; &#112;&#108;&#117;&#103;&#105;&#110;.
+        Private slot to (re)initialize the plugin.
 </p><a NAME="TabnannyPlugin.__projectBrowserShowMenu" ID="TabnannyPlugin.__projectBrowserShowMenu"></a>
 <h4>TabnannyPlugin.__projectBrowserShowMenu</h4>
 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#98;&#114;&#111;w&#115;&#101;&#114; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#111;&#114; &#97; &#115;&#117;&#98;&#109;&#101;&#110;&#117; &#105;&#115; 
-        &#97;&#98;&#111;&#117;&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110;.
+        Private slot called, when the the project browser context menu or a submenu is 
+        about to be shown.
 </p><dl>
 <dt><i>menuName</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#101;&#110;&#117; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the menu to be shown (string)
 </dd><dt><i>menu</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#109;&#101;&#110;&#117; (&#81;&#77;&#101;&#110;&#117;)
+reference to the menu (QMenu)
 </dd>
 </dl><a NAME="TabnannyPlugin.__projectBrowserTabnanny" ID="TabnannyPlugin.__projectBrowserTabnanny"></a>
 <h4>TabnannyPlugin.__projectBrowserTabnanny</h4>
 <b>__projectBrowserTabnanny</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#116;&#97;&#98;&#110;&#97;&#110;&#110;y &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#97;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116;
-        &#115;&#111;&#117;&#114;&#99;&#101;&#115; &#98;&#114;&#111;w&#115;&#101;&#114;.
+        Private method to handle the tabnanny context menu action of the project
+        sources browser.
 </p><a NAME="TabnannyPlugin.__projectShowMenu" ID="TabnannyPlugin.__projectShowMenu"></a>
 <h4>TabnannyPlugin.__projectShowMenu</h4>
 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#109;&#101;&#110;&#117; &#111;&#114; &#97; &#115;&#117;&#98;&#109;&#101;&#110;&#117; &#105;&#115; 
-        &#97;&#98;&#111;&#117;&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110;.
+        Private slot called, when the the project menu or a submenu is 
+        about to be shown.
 </p><dl>
 <dt><i>menuName</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#101;&#110;&#117; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the menu to be shown (string)
 </dd><dt><i>menu</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#109;&#101;&#110;&#117; (&#81;&#77;&#101;&#110;&#117;)
+reference to the menu (QMenu)
 </dd>
 </dl><a NAME="TabnannyPlugin.__projectTabnanny" ID="TabnannyPlugin.__projectTabnanny"></a>
 <h4>TabnannyPlugin.__projectTabnanny</h4>
 <b>__projectTabnanny</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#105;&#108;&#101;&#115; &#102;&#111;&#114; &#98;&#97;&#100; &#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;&#115;.
+        Public slot used to check the project files for bad indentations.
 </p><a NAME="TabnannyPlugin.activate" ID="TabnannyPlugin.activate"></a>
 <h4>TabnannyPlugin.activate</h4>
 <b>activate</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.
+        Public method to activate this plugin.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#78;&#111;&#110;&#101; &#97;&#110;&#100; &#97;&#99;&#116;&#105;v&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#97;&#116;&#117;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+tuple of None and activation status (boolean)
 </dd>
 </dl><a NAME="TabnannyPlugin.deactivate" ID="TabnannyPlugin.deactivate"></a>
 <h4>TabnannyPlugin.deactivate</h4>
 <b>deactivate</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.
+        Public method to deactivate this plugin.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

Mercurial Repository: eric

eric ide

mercurial