eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorGeneralPage.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
diff -r d6062691d424 -r e0227a7c850e eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorGeneralPage.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorGeneralPage.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,252 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Preferences.ConfigurationPages.EditorGeneralPage</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.Preferences.ConfigurationPages.EditorGeneralPage</h1>
+
+<p>
+Module implementing the Editor General configuration page.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#EditorGeneralPage">EditorGeneralPage</a></td>
+<td>Class implementing the Editor General configuration page.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#create">create</a></td>
+<td>Module function to create the configuration page.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="EditorGeneralPage" ID="EditorGeneralPage"></a>
+<h2>EditorGeneralPage</h2>
+
+<p>
+    Class implementing the Editor General configuration page.
+</p>
+<h3>Derived from</h3>
+ConfigurationPageBase, Ui_EditorGeneralPage
+<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="#EditorGeneralPage.__init__">EditorGeneralPage</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EditorGeneralPage.__createOverrideItem">__createOverrideItem</a></td>
+<td>Private method to create an entry for a language override.</td>
+</tr>
+<tr>
+<td><a href="#EditorGeneralPage.__populateLanguageOverrideWidget">__populateLanguageOverrideWidget</a></td>
+<td>Private method to populate the language specific indentation and tab width override widget.</td>
+</tr>
+<tr>
+<td><a href="#EditorGeneralPage.__resizeOverrideColumns">__resizeOverrideColumns</a></td>
+<td>Private method to resize the list columns.</td>
+</tr>
+<tr>
+<td><a href="#EditorGeneralPage.__saveLanguageOverrides">__saveLanguageOverrides</a></td>
+<td>Private method to save the language specific indentation and tab width overrides.</td>
+</tr>
+<tr>
+<td><a href="#EditorGeneralPage.on_addButton_clicked">on_addButton_clicked</a></td>
+<td>Private slot to add a new override entry.</td>
+</tr>
+<tr>
+<td><a href="#EditorGeneralPage.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
+<td>Private slot to delete the selected override entries.</td>
+</tr>
+<tr>
+<td><a href="#EditorGeneralPage.on_editButton_clicked">on_editButton_clicked</a></td>
+<td>Private slot to edit the selected override entry.</td>
+</tr>
+<tr>
+<td><a href="#EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged">on_languageOverrideWidget_itemSelectionChanged</a></td>
+<td>Private slot handling a change of the override selection.</td>
+</tr>
+<tr>
+<td><a href="#EditorGeneralPage.on_tabforindentationCheckBox_toggled">on_tabforindentationCheckBox_toggled</a></td>
+<td>Private slot used to set the tab conversion check box.</td>
+</tr>
+<tr>
+<td><a href="#EditorGeneralPage.save">save</a></td>
+<td>Public slot to save the Editor General configuration.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EditorGeneralPage.__init__" ID="EditorGeneralPage.__init__"></a>
+<h4>EditorGeneralPage (Constructor)</h4>
+<b>EditorGeneralPage</b>(<i></i>)
+
+<p>
+        Constructor
+</p>
+<a NAME="EditorGeneralPage.__createOverrideItem" ID="EditorGeneralPage.__createOverrideItem"></a>
+<h4>EditorGeneralPage.__createOverrideItem</h4>
+<b>__createOverrideItem</b>(<i>language, tabWidth, indentWidth</i>)
+
+<p>
+        Private method to create an entry for a language override.
+</p>
+<dl>
+
+<dt><i>language</i> (str)</dt>
+<dd>
+name of the language
+</dd>
+<dt><i>tabWidth</i> (int)</dt>
+<dd>
+tabulator width
+</dd>
+<dt><i>indentWidth</i> (int)</dt>
+<dd>
+indentation width
+</dd>
+</dl>
+<a NAME="EditorGeneralPage.__populateLanguageOverrideWidget" ID="EditorGeneralPage.__populateLanguageOverrideWidget"></a>
+<h4>EditorGeneralPage.__populateLanguageOverrideWidget</h4>
+<b>__populateLanguageOverrideWidget</b>(<i></i>)
+
+<p>
+        Private method to populate the language specific indentation and tab
+        width override widget.
+</p>
+<a NAME="EditorGeneralPage.__resizeOverrideColumns" ID="EditorGeneralPage.__resizeOverrideColumns"></a>
+<h4>EditorGeneralPage.__resizeOverrideColumns</h4>
+<b>__resizeOverrideColumns</b>(<i></i>)
+
+<p>
+        Private method to resize the list columns.
+</p>
+<a NAME="EditorGeneralPage.__saveLanguageOverrides" ID="EditorGeneralPage.__saveLanguageOverrides"></a>
+<h4>EditorGeneralPage.__saveLanguageOverrides</h4>
+<b>__saveLanguageOverrides</b>(<i></i>)
+
+<p>
+        Private method to save the language specific indentation and tab width
+        overrides.
+</p>
+<a NAME="EditorGeneralPage.on_addButton_clicked" ID="EditorGeneralPage.on_addButton_clicked"></a>
+<h4>EditorGeneralPage.on_addButton_clicked</h4>
+<b>on_addButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to add a new override entry.
+</p>
+<a NAME="EditorGeneralPage.on_deleteButton_clicked" ID="EditorGeneralPage.on_deleteButton_clicked"></a>
+<h4>EditorGeneralPage.on_deleteButton_clicked</h4>
+<b>on_deleteButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to delete the selected override entries.
+</p>
+<a NAME="EditorGeneralPage.on_editButton_clicked" ID="EditorGeneralPage.on_editButton_clicked"></a>
+<h4>EditorGeneralPage.on_editButton_clicked</h4>
+<b>on_editButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to edit the selected override entry.
+</p>
+<a NAME="EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged" ID="EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged"></a>
+<h4>EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged</h4>
+<b>on_languageOverrideWidget_itemSelectionChanged</b>(<i></i>)
+
+<p>
+        Private slot handling a change of the override selection.
+</p>
+<a NAME="EditorGeneralPage.on_tabforindentationCheckBox_toggled" ID="EditorGeneralPage.on_tabforindentationCheckBox_toggled"></a>
+<h4>EditorGeneralPage.on_tabforindentationCheckBox_toggled</h4>
+<b>on_tabforindentationCheckBox_toggled</b>(<i>checked</i>)
+
+<p>
+        Private slot used to set the tab conversion check box.
+</p>
+<dl>
+
+<dt><i>checked</i></dt>
+<dd>
+flag received from the signal (boolean)
+</dd>
+</dl>
+<a NAME="EditorGeneralPage.save" ID="EditorGeneralPage.save"></a>
+<h4>EditorGeneralPage.save</h4>
+<b>save</b>(<i></i>)
+
+<p>
+        Public slot to save the Editor General configuration.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="create" ID="create"></a>
+<h2>create</h2>
+<b>create</b>(<i>dlg</i>)
+
+<p>
+    Module function to create the configuration page.
+</p>
+<dl>
+
+<dt><i>dlg</i></dt>
+<dd>
+reference to the configuration dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the instantiated page (ConfigurationPageBase)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial