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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorLanguageTabIndentOverrideDialog.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,207 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Preferences.ConfigurationPages.EditorLanguageTabIndentOverrideDialog</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.EditorLanguageTabIndentOverrideDialog</h1>
+
+<p>
+Module implementing a dialog to set the tab and indentation width override for
+a language.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#EditorLanguageTabIndentOverrideDialog">EditorLanguageTabIndentOverrideDialog</a></td>
+<td>Class implementing a dialog to set the tab and indentation width override for a language.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="EditorLanguageTabIndentOverrideDialog" ID="EditorLanguageTabIndentOverrideDialog"></a>
+<h2>EditorLanguageTabIndentOverrideDialog</h2>
+
+<p>
+    Class implementing a dialog to set the tab and indentation width override
+    for a language.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_EditorLanguageTabIndentOverrideDialog
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>PygmentsMarker</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#EditorLanguageTabIndentOverrideDialog.__init__">EditorLanguageTabIndentOverrideDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EditorLanguageTabIndentOverrideDialog.__populateLanguages">__populateLanguages</a></td>
+<td>Private method to populate the language combo boxes.</td>
+</tr>
+<tr>
+<td><a href="#EditorLanguageTabIndentOverrideDialog.__updateOkButton">__updateOkButton</a></td>
+<td>Private method to set the enabled status of the OK button.</td>
+</tr>
+<tr>
+<td><a href="#EditorLanguageTabIndentOverrideDialog.getData">getData</a></td>
+<td>Public method to get the entered data.</td>
+</tr>
+<tr>
+<td><a href="#EditorLanguageTabIndentOverrideDialog.on_languageComboBox_currentIndexChanged">on_languageComboBox_currentIndexChanged</a></td>
+<td>Private slot to handle the selection of a language.</td>
+</tr>
+<tr>
+<td><a href="#EditorLanguageTabIndentOverrideDialog.on_pygmentsLexerCombo_currentIndexChanged">on_pygmentsLexerCombo_currentIndexChanged</a></td>
+<td>Private slot to handle the selection of a language.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EditorLanguageTabIndentOverrideDialog.__init__" ID="EditorLanguageTabIndentOverrideDialog.__init__"></a>
+<h4>EditorLanguageTabIndentOverrideDialog (Constructor)</h4>
+<b>EditorLanguageTabIndentOverrideDialog</b>(<i>*, editMode=False, languages=None, tabWidth=0, indentWidth=0, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>editMode=</i> (bool)</dt>
+<dd>
+flag indicating the edit mode (Note: in edit mode
+            the language is fixed)
+</dd>
+<dt><i>languages=</i> (list of str)</dt>
+<dd>
+list of existing languages (if in add mode) or
+            a list containing the language to be edited
+</dd>
+<dt><i>tabWidth=</i> (int)</dt>
+<dd>
+tab width to be set
+</dd>
+<dt><i>indentWidth=</i> (int)</dt>
+<dd>
+indentation width to be set
+</dd>
+<dt><i>parent=</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="EditorLanguageTabIndentOverrideDialog.__populateLanguages" ID="EditorLanguageTabIndentOverrideDialog.__populateLanguages"></a>
+<h4>EditorLanguageTabIndentOverrideDialog.__populateLanguages</h4>
+<b>__populateLanguages</b>(<i>filterLanguages</i>)
+
+<p>
+        Private method to populate the language combo boxes.
+</p>
+<dl>
+
+<dt><i>filterLanguages</i> (list of str)</dt>
+<dd>
+list of languages to be filtered out
+</dd>
+</dl>
+<a NAME="EditorLanguageTabIndentOverrideDialog.__updateOkButton" ID="EditorLanguageTabIndentOverrideDialog.__updateOkButton"></a>
+<h4>EditorLanguageTabIndentOverrideDialog.__updateOkButton</h4>
+<b>__updateOkButton</b>(<i></i>)
+
+<p>
+        Private method to set the enabled status of the OK button.
+</p>
+<a NAME="EditorLanguageTabIndentOverrideDialog.getData" ID="EditorLanguageTabIndentOverrideDialog.getData"></a>
+<h4>EditorLanguageTabIndentOverrideDialog.getData</h4>
+<b>getData</b>(<i></i>)
+
+<p>
+        Public method to get the entered data.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the language, the tab width and the
+            indentation width
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, int, int)
+</dd>
+</dl>
+<a NAME="EditorLanguageTabIndentOverrideDialog.on_languageComboBox_currentIndexChanged" ID="EditorLanguageTabIndentOverrideDialog.on_languageComboBox_currentIndexChanged"></a>
+<h4>EditorLanguageTabIndentOverrideDialog.on_languageComboBox_currentIndexChanged</h4>
+<b>on_languageComboBox_currentIndexChanged</b>(<i>index</i>)
+
+<p>
+        Private slot to handle the selection of a language.
+</p>
+<dl>
+
+<dt><i>index</i> (int)</dt>
+<dd>
+index of the current item
+</dd>
+</dl>
+<a NAME="EditorLanguageTabIndentOverrideDialog.on_pygmentsLexerCombo_currentIndexChanged" ID="EditorLanguageTabIndentOverrideDialog.on_pygmentsLexerCombo_currentIndexChanged"></a>
+<h4>EditorLanguageTabIndentOverrideDialog.on_pygmentsLexerCombo_currentIndexChanged</h4>
+<b>on_pygmentsLexerCombo_currentIndexChanged</b>(<i>index</i>)
+
+<p>
+        Private slot to handle the selection of a language.
+</p>
+<dl>
+
+<dt><i>index</i> (int)</dt>
+<dd>
+index of the current item
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial