Documentation/Source/eric6.Preferences.ConfigurationPages.EditorHighlightersPage.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Preferences.ConfigurationPages.EditorHighlightersPage</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><a NAME="top" ID="top"></a>
22 <h1>eric6.Preferences.ConfigurationPages.EditorHighlightersPage</h1>
23 <p>
24 Module implementing the Editor Highlighter Associations configuration page.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#EditorHighlightersPage">EditorHighlightersPage</a></td>
34 <td>Class implementing the Editor Highlighter Associations configuration page.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr>
40 <td><a href="#create">create</a></td>
41 <td>Module function to create the configuration page.</td>
42 </tr>
43 </table>
44 <hr /><hr />
45 <a NAME="EditorHighlightersPage" ID="EditorHighlightersPage"></a>
46 <h2>EditorHighlightersPage</h2>
47 <p>
48 Class implementing the Editor Highlighter Associations configuration page.
49 </p>
50 <h3>Derived from</h3>
51 ConfigurationPageBase, Ui_EditorHighlightersPage
52 <h3>Class Attributes</h3>
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#EditorHighlightersPage.__init__">EditorHighlightersPage</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#EditorHighlightersPage.on_addLexerButton_clicked">on_addLexerButton_clicked</a></td>
67 <td>Private slot to add the lexer association displayed to the list.</td>
68 </tr><tr>
69 <td><a href="#EditorHighlightersPage.on_deleteLexerButton_clicked">on_deleteLexerButton_clicked</a></td>
70 <td>Private slot to delete the currently selected lexer association of the list.</td>
71 </tr><tr>
72 <td><a href="#EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged">on_editorLexerCombo_currentIndexChanged</a></td>
73 <td>Private slot to handle the selection of a lexer.</td>
74 </tr><tr>
75 <td><a href="#EditorHighlightersPage.on_editorLexerList_itemActivated">on_editorLexerList_itemActivated</a></td>
76 <td>Private slot to handle the activated signal of the lexer association list.</td>
77 </tr><tr>
78 <td><a href="#EditorHighlightersPage.on_editorLexerList_itemClicked">on_editorLexerList_itemClicked</a></td>
79 <td>Private slot to handle the clicked signal of the lexer association list.</td>
80 </tr><tr>
81 <td><a href="#EditorHighlightersPage.save">save</a></td>
82 <td>Public slot to save the Editor Highlighter Associations configuration.</td>
83 </tr>
84 </table>
85 <h3>Static Methods</h3>
86 <table>
87 <tr><td>None</td></tr>
88 </table>
89 <a NAME="EditorHighlightersPage.__init__" ID="EditorHighlightersPage.__init__"></a>
90 <h4>EditorHighlightersPage (Constructor)</h4>
91 <b>EditorHighlightersPage</b>(<i>lexers</i>)
92 <p>
93 Constructor
94 </p><dl>
95 <dt><i>lexers</i></dt>
96 <dd>
97 reference to the lexers dictionary
98 </dd>
99 </dl><a NAME="EditorHighlightersPage.on_addLexerButton_clicked" ID="EditorHighlightersPage.on_addLexerButton_clicked"></a>
100 <h4>EditorHighlightersPage.on_addLexerButton_clicked</h4>
101 <b>on_addLexerButton_clicked</b>(<i></i>)
102 <p>
103 Private slot to add the lexer association displayed to the list.
104 </p><a NAME="EditorHighlightersPage.on_deleteLexerButton_clicked" ID="EditorHighlightersPage.on_deleteLexerButton_clicked"></a>
105 <h4>EditorHighlightersPage.on_deleteLexerButton_clicked</h4>
106 <b>on_deleteLexerButton_clicked</b>(<i></i>)
107 <p>
108 Private slot to delete the currently selected lexer association of the
109 list.
110 </p><a NAME="EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged" ID="EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged"></a>
111 <h4>EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged</h4>
112 <b>on_editorLexerCombo_currentIndexChanged</b>(<i>text</i>)
113 <p>
114 Private slot to handle the selection of a lexer.
115 </p><dl>
116 <dt><i>text</i></dt>
117 <dd>
118 text of the lexer combo (string)
119 </dd>
120 </dl><a NAME="EditorHighlightersPage.on_editorLexerList_itemActivated" ID="EditorHighlightersPage.on_editorLexerList_itemActivated"></a>
121 <h4>EditorHighlightersPage.on_editorLexerList_itemActivated</h4>
122 <b>on_editorLexerList_itemActivated</b>(<i>itm, column</i>)
123 <p>
124 Private slot to handle the activated signal of the lexer association
125 list.
126 </p><dl>
127 <dt><i>itm</i></dt>
128 <dd>
129 reference to the selecte item (QTreeWidgetItem)
130 </dd><dt><i>column</i></dt>
131 <dd>
132 column the item was clicked or activated (integer)
133 (ignored)
134 </dd>
135 </dl><a NAME="EditorHighlightersPage.on_editorLexerList_itemClicked" ID="EditorHighlightersPage.on_editorLexerList_itemClicked"></a>
136 <h4>EditorHighlightersPage.on_editorLexerList_itemClicked</h4>
137 <b>on_editorLexerList_itemClicked</b>(<i>itm, column</i>)
138 <p>
139 Private slot to handle the clicked signal of the lexer association
140 list.
141 </p><dl>
142 <dt><i>itm</i></dt>
143 <dd>
144 reference to the selecte item (QTreeWidgetItem)
145 </dd><dt><i>column</i></dt>
146 <dd>
147 column the item was clicked or activated (integer)
148 (ignored)
149 </dd>
150 </dl><a NAME="EditorHighlightersPage.save" ID="EditorHighlightersPage.save"></a>
151 <h4>EditorHighlightersPage.save</h4>
152 <b>save</b>(<i></i>)
153 <p>
154 Public slot to save the Editor Highlighter Associations configuration.
155 </p>
156 <div align="right"><a href="#top">Up</a></div>
157 <hr /><hr />
158 <a NAME="create" ID="create"></a>
159 <h2>create</h2>
160 <b>create</b>(<i>dlg</i>)
161 <p>
162 Module function to create the configuration page.
163 </p><dl>
164 <dt><i>dlg</i></dt>
165 <dd>
166 reference to the configuration dialog
167 </dd>
168 </dl><dl>
169 <dt>Returns:</dt>
170 <dd>
171 reference to the instantiated page (ConfigurationPageBase)
172 </dd>
173 </dl>
174 <div align="right"><a href="#top">Up</a></div>
175 <hr />
176 </body></html>

eric ide

mercurial