src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorKeywordsPage.html

branch
eric7
changeset 10479
856476537696
parent 10259
b51dfacef37f
child 10684
58c7f23ae1cb
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Preferences.ConfigurationPages.EditorKeywordsPage</h1> 9 <h1>eric7.Preferences.ConfigurationPages.EditorKeywordsPage</h1>
10
11 <p> 10 <p>
12 Module implementing the editor highlighter keywords configuration page. 11 Module implementing the editor highlighter keywords configuration page.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#EditorKeywordsPage">EditorKeywordsPage</a></td> 22 <td><a href="#EditorKeywordsPage">EditorKeywordsPage</a></td>
25 <td>Class implementing the editor highlighter keywords configuration page.</td> 23 <td>Class implementing the editor highlighter keywords configuration page.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table>
31
32 <tr> 29 <tr>
33 <td><a href="#create">create</a></td> 30 <td><a href="#create">create</a></td>
34 <td>Module function to create the configuration page.</td> 31 <td>Module function to create the configuration page.</td>
35 </tr> 32 </tr>
36 </table> 33 </table>
34
37 <hr /> 35 <hr />
38 <hr /> 36 <hr />
39 <a NAME="EditorKeywordsPage" ID="EditorKeywordsPage"></a> 37 <a NAME="EditorKeywordsPage" ID="EditorKeywordsPage"></a>
40 <h2>EditorKeywordsPage</h2> 38 <h2>EditorKeywordsPage</h2>
41
42 <p> 39 <p>
43 Class implementing the editor highlighter keywords configuration page. 40 Class implementing the editor highlighter keywords configuration page.
44 </p> 41 </p>
42
45 <h3>Derived from</h3> 43 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_EditorKeywordsPage 44 ConfigurationPageBase, Ui_EditorKeywordsPage
47 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
48
49 <table> 46 <table>
50 <tr><td>MaxKeywordSets</td></tr> 47 <tr><td>MaxKeywordSets</td></tr>
51 </table> 48 </table>
49
52 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
53
54 <table> 51 <table>
55 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
56 </table> 53 </table>
54
57 <h3>Methods</h3> 55 <h3>Methods</h3>
58 56 <table>
59 <table>
60
61 <tr> 57 <tr>
62 <td><a href="#EditorKeywordsPage.__init__">EditorKeywordsPage</a></td> 58 <td><a href="#EditorKeywordsPage.__init__">EditorKeywordsPage</a></td>
63 <td>Constructor</td> 59 <td>Constructor</td>
64 </tr> 60 </tr>
65 <tr> 61 <tr>
89 <tr> 85 <tr>
90 <td><a href="#EditorKeywordsPage.setMode">setMode</a></td> 86 <td><a href="#EditorKeywordsPage.setMode">setMode</a></td>
91 <td>Public method to perform mode dependent setups.</td> 87 <td>Public method to perform mode dependent setups.</td>
92 </tr> 88 </tr>
93 </table> 89 </table>
90
94 <h3>Static Methods</h3> 91 <h3>Static Methods</h3>
95
96 <table> 92 <table>
97 <tr><td>None</td></tr> 93 <tr><td>None</td></tr>
98 </table> 94 </table>
95
99 96
100 <a NAME="EditorKeywordsPage.__init__" ID="EditorKeywordsPage.__init__"></a> 97 <a NAME="EditorKeywordsPage.__init__" ID="EditorKeywordsPage.__init__"></a>
101 <h4>EditorKeywordsPage (Constructor)</h4> 98 <h4>EditorKeywordsPage (Constructor)</h4>
102 <b>EditorKeywordsPage</b>(<i></i>) 99 <b>EditorKeywordsPage</b>(<i></i>)
103
104 <p> 100 <p>
105 Constructor 101 Constructor
106 </p> 102 </p>
103
107 <a NAME="EditorKeywordsPage.__populateLanguages" ID="EditorKeywordsPage.__populateLanguages"></a> 104 <a NAME="EditorKeywordsPage.__populateLanguages" ID="EditorKeywordsPage.__populateLanguages"></a>
108 <h4>EditorKeywordsPage.__populateLanguages</h4> 105 <h4>EditorKeywordsPage.__populateLanguages</h4>
109 <b>__populateLanguages</b>(<i>languages</i>) 106 <b>__populateLanguages</b>(<i>languages</i>)
110
111 <p> 107 <p>
112 Private method to populate the language selection box. 108 Private method to populate the language selection box.
113 </p> 109 </p>
110
114 <dl> 111 <dl>
115 112
116 <dt><i>languages</i> (list of str)</dt> 113 <dt><i>languages</i> (list of str)</dt>
117 <dd> 114 <dd>
118 list of languages to include in the language selector 115 list of languages to include in the language selector
119 </dd> 116 </dd>
120 </dl> 117 </dl>
121 <a NAME="EditorKeywordsPage.on_allDefaultButton_clicked" ID="EditorKeywordsPage.on_allDefaultButton_clicked"></a> 118 <a NAME="EditorKeywordsPage.on_allDefaultButton_clicked" ID="EditorKeywordsPage.on_allDefaultButton_clicked"></a>
122 <h4>EditorKeywordsPage.on_allDefaultButton_clicked</h4> 119 <h4>EditorKeywordsPage.on_allDefaultButton_clicked</h4>
123 <b>on_allDefaultButton_clicked</b>(<i></i>) 120 <b>on_allDefaultButton_clicked</b>(<i></i>)
124
125 <p> 121 <p>
126 Private slot to set all keyword sets of the current language to default 122 Private slot to set all keyword sets of the current language to default
127 values. 123 values.
128 </p> 124 </p>
125
129 <a NAME="EditorKeywordsPage.on_defaultButton_clicked" ID="EditorKeywordsPage.on_defaultButton_clicked"></a> 126 <a NAME="EditorKeywordsPage.on_defaultButton_clicked" ID="EditorKeywordsPage.on_defaultButton_clicked"></a>
130 <h4>EditorKeywordsPage.on_defaultButton_clicked</h4> 127 <h4>EditorKeywordsPage.on_defaultButton_clicked</h4>
131 <b>on_defaultButton_clicked</b>(<i></i>) 128 <b>on_defaultButton_clicked</b>(<i></i>)
132
133 <p> 129 <p>
134 Private slot to set the current keyword set to default values. 130 Private slot to set the current keyword set to default values.
135 </p> 131 </p>
132
136 <a NAME="EditorKeywordsPage.on_languageCombo_activated" ID="EditorKeywordsPage.on_languageCombo_activated"></a> 133 <a NAME="EditorKeywordsPage.on_languageCombo_activated" ID="EditorKeywordsPage.on_languageCombo_activated"></a>
137 <h4>EditorKeywordsPage.on_languageCombo_activated</h4> 134 <h4>EditorKeywordsPage.on_languageCombo_activated</h4>
138 <b>on_languageCombo_activated</b>(<i>index</i>) 135 <b>on_languageCombo_activated</b>(<i>index</i>)
139
140 <p> 136 <p>
141 Private slot to fill the keywords edit. 137 Private slot to fill the keywords edit.
142 </p> 138 </p>
139
143 <dl> 140 <dl>
144 141
145 <dt><i>index</i> (int)</dt> 142 <dt><i>index</i> (int)</dt>
146 <dd> 143 <dd>
147 index of the selected entry 144 index of the selected entry
148 </dd> 145 </dd>
149 </dl> 146 </dl>
150 <a NAME="EditorKeywordsPage.on_setSpinBox_valueChanged" ID="EditorKeywordsPage.on_setSpinBox_valueChanged"></a> 147 <a NAME="EditorKeywordsPage.on_setSpinBox_valueChanged" ID="EditorKeywordsPage.on_setSpinBox_valueChanged"></a>
151 <h4>EditorKeywordsPage.on_setSpinBox_valueChanged</h4> 148 <h4>EditorKeywordsPage.on_setSpinBox_valueChanged</h4>
152 <b>on_setSpinBox_valueChanged</b>(<i>kwSet</i>) 149 <b>on_setSpinBox_valueChanged</b>(<i>kwSet</i>)
153
154 <p> 150 <p>
155 Private slot to fill the keywords edit. 151 Private slot to fill the keywords edit.
156 </p> 152 </p>
153
157 <dl> 154 <dl>
158 155
159 <dt><i>kwSet</i> (int)</dt> 156 <dt><i>kwSet</i> (int)</dt>
160 <dd> 157 <dd>
161 number of the selected keyword set 158 number of the selected keyword set
162 </dd> 159 </dd>
163 </dl> 160 </dl>
164 <a NAME="EditorKeywordsPage.save" ID="EditorKeywordsPage.save"></a> 161 <a NAME="EditorKeywordsPage.save" ID="EditorKeywordsPage.save"></a>
165 <h4>EditorKeywordsPage.save</h4> 162 <h4>EditorKeywordsPage.save</h4>
166 <b>save</b>(<i></i>) 163 <b>save</b>(<i></i>)
167
168 <p> 164 <p>
169 Public slot to save the editor highlighter keywords configuration. 165 Public slot to save the editor highlighter keywords configuration.
170 </p> 166 </p>
167
171 <a NAME="EditorKeywordsPage.setMode" ID="EditorKeywordsPage.setMode"></a> 168 <a NAME="EditorKeywordsPage.setMode" ID="EditorKeywordsPage.setMode"></a>
172 <h4>EditorKeywordsPage.setMode</h4> 169 <h4>EditorKeywordsPage.setMode</h4>
173 <b>setMode</b>(<i>displayMode</i>) 170 <b>setMode</b>(<i>displayMode</i>)
174
175 <p> 171 <p>
176 Public method to perform mode dependent setups. 172 Public method to perform mode dependent setups.
177 </p> 173 </p>
174
178 <dl> 175 <dl>
179 176
180 <dt><i>displayMode</i> (ConfigurationMode)</dt> 177 <dt><i>displayMode</i> (ConfigurationMode)</dt>
181 <dd> 178 <dd>
182 mode of the configuration dialog 179 mode of the configuration dialog
186 <hr /> 183 <hr />
187 <hr /> 184 <hr />
188 <a NAME="create" ID="create"></a> 185 <a NAME="create" ID="create"></a>
189 <h2>create</h2> 186 <h2>create</h2>
190 <b>create</b>(<i>dlg</i>) 187 <b>create</b>(<i>dlg</i>)
191
192 <p> 188 <p>
193 Module function to create the configuration page. 189 Module function to create the configuration page.
194 </p> 190 </p>
191
195 <dl> 192 <dl>
196 193
197 <dt><i>dlg</i> (ConfigurationWidget)</dt> 194 <dt><i>dlg</i> (ConfigurationWidget)</dt>
198 <dd> 195 <dd>
199 reference to the configuration dialog 196 reference to the configuration dialog

eric ide

mercurial