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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ConfigurationPages.EditorLanguageTabIndentOverrideDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Preferences.ConfigurationPages.EditorLanguageTabIndentOverrideDialog</h1>
24
25 <p>
26 Module implementing a dialog to set the tab and indentation width override for
27 a language.
28 </p>
29 <h3>Global Attributes</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <h3>Classes</h3>
35
36 <table>
37
38 <tr>
39 <td><a href="#EditorLanguageTabIndentOverrideDialog">EditorLanguageTabIndentOverrideDialog</a></td>
40 <td>Class implementing a dialog to set the tab and indentation width override for a language.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr />
49 <hr />
50 <a NAME="EditorLanguageTabIndentOverrideDialog" ID="EditorLanguageTabIndentOverrideDialog"></a>
51 <h2>EditorLanguageTabIndentOverrideDialog</h2>
52
53 <p>
54 Class implementing a dialog to set the tab and indentation width override
55 for a language.
56 </p>
57 <h3>Derived from</h3>
58 QDialog, Ui_EditorLanguageTabIndentOverrideDialog
59 <h3>Class Attributes</h3>
60
61 <table>
62 <tr><td>PygmentsMarker</td></tr>
63 </table>
64 <h3>Class Methods</h3>
65
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70
71 <table>
72
73 <tr>
74 <td><a href="#EditorLanguageTabIndentOverrideDialog.__init__">EditorLanguageTabIndentOverrideDialog</a></td>
75 <td>Constructor</td>
76 </tr>
77 <tr>
78 <td><a href="#EditorLanguageTabIndentOverrideDialog.__populateLanguages">__populateLanguages</a></td>
79 <td>Private method to populate the language combo boxes.</td>
80 </tr>
81 <tr>
82 <td><a href="#EditorLanguageTabIndentOverrideDialog.__updateOkButton">__updateOkButton</a></td>
83 <td>Private method to set the enabled status of the OK button.</td>
84 </tr>
85 <tr>
86 <td><a href="#EditorLanguageTabIndentOverrideDialog.getData">getData</a></td>
87 <td>Public method to get the entered data.</td>
88 </tr>
89 <tr>
90 <td><a href="#EditorLanguageTabIndentOverrideDialog.on_languageComboBox_currentIndexChanged">on_languageComboBox_currentIndexChanged</a></td>
91 <td>Private slot to handle the selection of a language.</td>
92 </tr>
93 <tr>
94 <td><a href="#EditorLanguageTabIndentOverrideDialog.on_pygmentsLexerCombo_currentIndexChanged">on_pygmentsLexerCombo_currentIndexChanged</a></td>
95 <td>Private slot to handle the selection of a language.</td>
96 </tr>
97 </table>
98 <h3>Static Methods</h3>
99
100 <table>
101 <tr><td>None</td></tr>
102 </table>
103
104 <a NAME="EditorLanguageTabIndentOverrideDialog.__init__" ID="EditorLanguageTabIndentOverrideDialog.__init__"></a>
105 <h4>EditorLanguageTabIndentOverrideDialog (Constructor)</h4>
106 <b>EditorLanguageTabIndentOverrideDialog</b>(<i>*, editMode=False, languages=None, tabWidth=0, indentWidth=0, parent=None</i>)
107
108 <p>
109 Constructor
110 </p>
111 <dl>
112
113 <dt><i>editMode=</i> (bool)</dt>
114 <dd>
115 flag indicating the edit mode (Note: in edit mode
116 the language is fixed)
117 </dd>
118 <dt><i>languages=</i> (list of str)</dt>
119 <dd>
120 list of existing languages (if in add mode) or
121 a list containing the language to be edited
122 </dd>
123 <dt><i>tabWidth=</i> (int)</dt>
124 <dd>
125 tab width to be set
126 </dd>
127 <dt><i>indentWidth=</i> (int)</dt>
128 <dd>
129 indentation width to be set
130 </dd>
131 <dt><i>parent=</i> (QWidget)</dt>
132 <dd>
133 reference to the parent widget
134 </dd>
135 </dl>
136 <a NAME="EditorLanguageTabIndentOverrideDialog.__populateLanguages" ID="EditorLanguageTabIndentOverrideDialog.__populateLanguages"></a>
137 <h4>EditorLanguageTabIndentOverrideDialog.__populateLanguages</h4>
138 <b>__populateLanguages</b>(<i>filterLanguages</i>)
139
140 <p>
141 Private method to populate the language combo boxes.
142 </p>
143 <dl>
144
145 <dt><i>filterLanguages</i> (list of str)</dt>
146 <dd>
147 list of languages to be filtered out
148 </dd>
149 </dl>
150 <a NAME="EditorLanguageTabIndentOverrideDialog.__updateOkButton" ID="EditorLanguageTabIndentOverrideDialog.__updateOkButton"></a>
151 <h4>EditorLanguageTabIndentOverrideDialog.__updateOkButton</h4>
152 <b>__updateOkButton</b>(<i></i>)
153
154 <p>
155 Private method to set the enabled status of the OK button.
156 </p>
157 <a NAME="EditorLanguageTabIndentOverrideDialog.getData" ID="EditorLanguageTabIndentOverrideDialog.getData"></a>
158 <h4>EditorLanguageTabIndentOverrideDialog.getData</h4>
159 <b>getData</b>(<i></i>)
160
161 <p>
162 Public method to get the entered data.
163 </p>
164 <dl>
165 <dt>Return:</dt>
166 <dd>
167 tuple containing the language, the tab width and the
168 indentation width
169 </dd>
170 </dl>
171 <dl>
172 <dt>Return Type:</dt>
173 <dd>
174 tuple of (str, int, int)
175 </dd>
176 </dl>
177 <a NAME="EditorLanguageTabIndentOverrideDialog.on_languageComboBox_currentIndexChanged" ID="EditorLanguageTabIndentOverrideDialog.on_languageComboBox_currentIndexChanged"></a>
178 <h4>EditorLanguageTabIndentOverrideDialog.on_languageComboBox_currentIndexChanged</h4>
179 <b>on_languageComboBox_currentIndexChanged</b>(<i>index</i>)
180
181 <p>
182 Private slot to handle the selection of a language.
183 </p>
184 <dl>
185
186 <dt><i>index</i> (int)</dt>
187 <dd>
188 index of the current item
189 </dd>
190 </dl>
191 <a NAME="EditorLanguageTabIndentOverrideDialog.on_pygmentsLexerCombo_currentIndexChanged" ID="EditorLanguageTabIndentOverrideDialog.on_pygmentsLexerCombo_currentIndexChanged"></a>
192 <h4>EditorLanguageTabIndentOverrideDialog.on_pygmentsLexerCombo_currentIndexChanged</h4>
193 <b>on_pygmentsLexerCombo_currentIndexChanged</b>(<i>index</i>)
194
195 <p>
196 Private slot to handle the selection of a language.
197 </p>
198 <dl>
199
200 <dt><i>index</i> (int)</dt>
201 <dd>
202 index of the current item
203 </dd>
204 </dl>
205 <div align="right"><a href="#top">Up</a></div>
206 <hr />
207 </body></html>

eric ide

mercurial