eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.IconsPage.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.IconsPage</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.IconsPage</h1>
24
25 <p>
26 Module implementing the Icons 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="#IconsPage">IconsPage</a></td>
39 <td>Class implementing the Icons 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="IconsPage" ID="IconsPage"></a>
54 <h2>IconsPage</h2>
55
56 <p>
57 Class implementing the Icons configuration page.
58 </p>
59 <h3>Derived from</h3>
60 ConfigurationPageBase, Ui_IconsPage
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>None</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="#IconsPage.__init__">IconsPage</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#IconsPage.__getSelectedDefaultIconsPath">__getSelectedDefaultIconsPath</a></td>
81 <td>Private method to determine the selected default icons path.</td>
82 </tr>
83 <tr>
84 <td><a href="#IconsPage.on_addIconDirectoryButton_clicked">on_addIconDirectoryButton_clicked</a></td>
85 <td>Private slot to add the icon directory displayed to the listbox.</td>
86 </tr>
87 <tr>
88 <td><a href="#IconsPage.on_deleteIconDirectoryButton_clicked">on_deleteIconDirectoryButton_clicked</a></td>
89 <td>Private slot to delete the currently selected directory of the listbox.</td>
90 </tr>
91 <tr>
92 <td><a href="#IconsPage.on_downButton_clicked">on_downButton_clicked</a></td>
93 <td>Private slot called to move the selected item down in the list.</td>
94 </tr>
95 <tr>
96 <td><a href="#IconsPage.on_iconDirectoryList_currentRowChanged">on_iconDirectoryList_currentRowChanged</a></td>
97 <td>Private slot to handle the currentRowChanged signal of the icons directory list.</td>
98 </tr>
99 <tr>
100 <td><a href="#IconsPage.on_iconDirectoryPicker_textChanged">on_iconDirectoryPicker_textChanged</a></td>
101 <td>Private slot to handle the textChanged signal of the directory picker.</td>
102 </tr>
103 <tr>
104 <td><a href="#IconsPage.on_showDefaultIconsButton_clicked">on_showDefaultIconsButton_clicked</a></td>
105 <td>Private slot to display a preview of the selected default icons.</td>
106 </tr>
107 <tr>
108 <td><a href="#IconsPage.on_showIconsButton_clicked">on_showIconsButton_clicked</a></td>
109 <td>Private slot to display a preview of an icons directory.</td>
110 </tr>
111 <tr>
112 <td><a href="#IconsPage.on_upButton_clicked">on_upButton_clicked</a></td>
113 <td>Private slot called to move the selected item up in the list.</td>
114 </tr>
115 <tr>
116 <td><a href="#IconsPage.save">save</a></td>
117 <td>Public slot to save the Icons configuration.</td>
118 </tr>
119 </table>
120 <h3>Static Methods</h3>
121
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125
126 <a NAME="IconsPage.__init__" ID="IconsPage.__init__"></a>
127 <h4>IconsPage (Constructor)</h4>
128 <b>IconsPage</b>(<i></i>)
129
130 <p>
131 Constructor
132 </p>
133 <a NAME="IconsPage.__getSelectedDefaultIconsPath" ID="IconsPage.__getSelectedDefaultIconsPath"></a>
134 <h4>IconsPage.__getSelectedDefaultIconsPath</h4>
135 <b>__getSelectedDefaultIconsPath</b>(<i></i>)
136
137 <p>
138 Private method to determine the selected default icons path.
139 </p>
140 <dl>
141 <dt>Return:</dt>
142 <dd>
143 selected default icons path
144 </dd>
145 </dl>
146 <dl>
147 <dt>Return Type:</dt>
148 <dd>
149 str
150 </dd>
151 </dl>
152 <a NAME="IconsPage.on_addIconDirectoryButton_clicked" ID="IconsPage.on_addIconDirectoryButton_clicked"></a>
153 <h4>IconsPage.on_addIconDirectoryButton_clicked</h4>
154 <b>on_addIconDirectoryButton_clicked</b>(<i></i>)
155
156 <p>
157 Private slot to add the icon directory displayed to the listbox.
158 </p>
159 <a NAME="IconsPage.on_deleteIconDirectoryButton_clicked" ID="IconsPage.on_deleteIconDirectoryButton_clicked"></a>
160 <h4>IconsPage.on_deleteIconDirectoryButton_clicked</h4>
161 <b>on_deleteIconDirectoryButton_clicked</b>(<i></i>)
162
163 <p>
164 Private slot to delete the currently selected directory of the listbox.
165 </p>
166 <a NAME="IconsPage.on_downButton_clicked" ID="IconsPage.on_downButton_clicked"></a>
167 <h4>IconsPage.on_downButton_clicked</h4>
168 <b>on_downButton_clicked</b>(<i></i>)
169
170 <p>
171 Private slot called to move the selected item down in the list.
172 </p>
173 <a NAME="IconsPage.on_iconDirectoryList_currentRowChanged" ID="IconsPage.on_iconDirectoryList_currentRowChanged"></a>
174 <h4>IconsPage.on_iconDirectoryList_currentRowChanged</h4>
175 <b>on_iconDirectoryList_currentRowChanged</b>(<i>row</i>)
176
177 <p>
178 Private slot to handle the currentRowChanged signal of the icons
179 directory list.
180 </p>
181 <dl>
182
183 <dt><i>row</i></dt>
184 <dd>
185 the current row (integer)
186 </dd>
187 </dl>
188 <a NAME="IconsPage.on_iconDirectoryPicker_textChanged" ID="IconsPage.on_iconDirectoryPicker_textChanged"></a>
189 <h4>IconsPage.on_iconDirectoryPicker_textChanged</h4>
190 <b>on_iconDirectoryPicker_textChanged</b>(<i>txt</i>)
191
192 <p>
193 Private slot to handle the textChanged signal of the directory picker.
194 </p>
195 <dl>
196
197 <dt><i>txt</i></dt>
198 <dd>
199 the text of the directory picker (string)
200 </dd>
201 </dl>
202 <a NAME="IconsPage.on_showDefaultIconsButton_clicked" ID="IconsPage.on_showDefaultIconsButton_clicked"></a>
203 <h4>IconsPage.on_showDefaultIconsButton_clicked</h4>
204 <b>on_showDefaultIconsButton_clicked</b>(<i></i>)
205
206 <p>
207 Private slot to display a preview of the selected default icons.
208 </p>
209 <a NAME="IconsPage.on_showIconsButton_clicked" ID="IconsPage.on_showIconsButton_clicked"></a>
210 <h4>IconsPage.on_showIconsButton_clicked</h4>
211 <b>on_showIconsButton_clicked</b>(<i></i>)
212
213 <p>
214 Private slot to display a preview of an icons directory.
215 </p>
216 <a NAME="IconsPage.on_upButton_clicked" ID="IconsPage.on_upButton_clicked"></a>
217 <h4>IconsPage.on_upButton_clicked</h4>
218 <b>on_upButton_clicked</b>(<i></i>)
219
220 <p>
221 Private slot called to move the selected item up in the list.
222 </p>
223 <a NAME="IconsPage.save" ID="IconsPage.save"></a>
224 <h4>IconsPage.save</h4>
225 <b>save</b>(<i></i>)
226
227 <p>
228 Public slot to save the Icons configuration.
229 </p>
230 <div align="right"><a href="#top">Up</a></div>
231 <hr />
232 <hr />
233 <a NAME="create" ID="create"></a>
234 <h2>create</h2>
235 <b>create</b>(<i>dlg</i>)
236
237 <p>
238 Module function to create the configuration page.
239 </p>
240 <dl>
241
242 <dt><i>dlg</i></dt>
243 <dd>
244 reference to the configuration dialog
245 </dd>
246 </dl>
247 <dl>
248 <dt>Return:</dt>
249 <dd>
250 reference to the instantiated page (ConfigurationPageBase)
251 </dd>
252 </dl>
253 <div align="right"><a href="#top">Up</a></div>
254 <hr />
255 </body></html>

eric ide

mercurial