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