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

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

eric ide

mercurial