eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorKeywordsPage.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.EditorKeywordsPage</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.EditorKeywordsPage</h1>
24
25 <p>
26 Module implementing the editor highlighter keywords configuration page.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#EditorKeywordsPage">EditorKeywordsPage</a></td>
39 <td>Class implementing the editor highlighter keywords configuration page.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45
46 <tr>
47 <td><a href="#create">create</a></td>
48 <td>Module function to create the configuration page.</td>
49 </tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="EditorKeywordsPage" ID="EditorKeywordsPage"></a>
54 <h2>EditorKeywordsPage</h2>
55
56 <p>
57 Class implementing the editor highlighter keywords configuration page.
58 </p>
59 <h3>Derived from</h3>
60 ConfigurationPageBase, Ui_EditorKeywordsPage
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>MaxKeywordSets</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#EditorKeywordsPage.__init__">EditorKeywordsPage</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#EditorKeywordsPage.on_allDefaultButton_clicked">on_allDefaultButton_clicked</a></td>
81 <td>Private slot to set all keyword sets of the current language to default values.</td>
82 </tr>
83 <tr>
84 <td><a href="#EditorKeywordsPage.on_defaultButton_clicked">on_defaultButton_clicked</a></td>
85 <td>Private slot to set the current keyword set to default values.</td>
86 </tr>
87 <tr>
88 <td><a href="#EditorKeywordsPage.on_languageCombo_activated">on_languageCombo_activated</a></td>
89 <td>Private slot to fill the keywords edit.</td>
90 </tr>
91 <tr>
92 <td><a href="#EditorKeywordsPage.on_setSpinBox_valueChanged">on_setSpinBox_valueChanged</a></td>
93 <td>Private slot to fill the keywords edit.</td>
94 </tr>
95 <tr>
96 <td><a href="#EditorKeywordsPage.save">save</a></td>
97 <td>Public slot to save the editor highlighter keywords configuration.</td>
98 </tr>
99 </table>
100 <h3>Static Methods</h3>
101
102 <table>
103 <tr><td>None</td></tr>
104 </table>
105
106 <a NAME="EditorKeywordsPage.__init__" ID="EditorKeywordsPage.__init__"></a>
107 <h4>EditorKeywordsPage (Constructor)</h4>
108 <b>EditorKeywordsPage</b>(<i></i>)
109
110 <p>
111 Constructor
112 </p>
113 <a NAME="EditorKeywordsPage.on_allDefaultButton_clicked" ID="EditorKeywordsPage.on_allDefaultButton_clicked"></a>
114 <h4>EditorKeywordsPage.on_allDefaultButton_clicked</h4>
115 <b>on_allDefaultButton_clicked</b>(<i></i>)
116
117 <p>
118 Private slot to set all keyword sets of the current language to default
119 values.
120 </p>
121 <a NAME="EditorKeywordsPage.on_defaultButton_clicked" ID="EditorKeywordsPage.on_defaultButton_clicked"></a>
122 <h4>EditorKeywordsPage.on_defaultButton_clicked</h4>
123 <b>on_defaultButton_clicked</b>(<i></i>)
124
125 <p>
126 Private slot to set the current keyword set to default values.
127 </p>
128 <a NAME="EditorKeywordsPage.on_languageCombo_activated" ID="EditorKeywordsPage.on_languageCombo_activated"></a>
129 <h4>EditorKeywordsPage.on_languageCombo_activated</h4>
130 <b>on_languageCombo_activated</b>(<i>index</i>)
131
132 <p>
133 Private slot to fill the keywords edit.
134 </p>
135 <dl>
136
137 <dt><i>index</i> (int)</dt>
138 <dd>
139 index of the selected entry
140 </dd>
141 </dl>
142 <a NAME="EditorKeywordsPage.on_setSpinBox_valueChanged" ID="EditorKeywordsPage.on_setSpinBox_valueChanged"></a>
143 <h4>EditorKeywordsPage.on_setSpinBox_valueChanged</h4>
144 <b>on_setSpinBox_valueChanged</b>(<i>kwSet</i>)
145
146 <p>
147 Private slot to fill the keywords edit.
148 </p>
149 <dl>
150
151 <dt><i>kwSet</i> (int)</dt>
152 <dd>
153 number of the selected keyword set
154 </dd>
155 </dl>
156 <a NAME="EditorKeywordsPage.save" ID="EditorKeywordsPage.save"></a>
157 <h4>EditorKeywordsPage.save</h4>
158 <b>save</b>(<i></i>)
159
160 <p>
161 Public slot to save the editor highlighter keywords configuration.
162 </p>
163 <div align="right"><a href="#top">Up</a></div>
164 <hr />
165 <hr />
166 <a NAME="create" ID="create"></a>
167 <h2>create</h2>
168 <b>create</b>(<i>dlg</i>)
169
170 <p>
171 Module function to create the configuration page.
172 </p>
173 <dl>
174
175 <dt><i>dlg</i> (ConfigurationWidget)</dt>
176 <dd>
177 reference to the configuration dialog
178 </dd>
179 </dl>
180 <dl>
181 <dt>Return:</dt>
182 <dd>
183 reference to the instantiated page
184 </dd>
185 </dl>
186 <dl>
187 <dt>Return Type:</dt>
188 <dd>
189 ConfigurationPageBase
190 </dd>
191 </dl>
192 <div align="right"><a href="#top">Up</a></div>
193 <hr />
194 </body></html>

eric ide

mercurial