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

eric ide

mercurial