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

branch
eric7
changeset 10479
856476537696
parent 10428
a071d4065202
child 10684
58c7f23ae1cb
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Preferences.ConfigurationPages.IconsPage</h1> 9 <h1>eric7.Preferences.ConfigurationPages.IconsPage</h1>
10
11 <p> 10 <p>
12 Module implementing the Icons configuration page. 11 Module implementing the Icons configuration page.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#IconsPage">IconsPage</a></td> 22 <td><a href="#IconsPage">IconsPage</a></td>
25 <td>Class implementing the Icons configuration page.</td> 23 <td>Class implementing the Icons configuration page.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table>
31
32 <tr> 29 <tr>
33 <td><a href="#create">create</a></td> 30 <td><a href="#create">create</a></td>
34 <td>Module function to create the configuration page.</td> 31 <td>Module function to create the configuration page.</td>
35 </tr> 32 </tr>
36 </table> 33 </table>
34
37 <hr /> 35 <hr />
38 <hr /> 36 <hr />
39 <a NAME="IconsPage" ID="IconsPage"></a> 37 <a NAME="IconsPage" ID="IconsPage"></a>
40 <h2>IconsPage</h2> 38 <h2>IconsPage</h2>
41
42 <p> 39 <p>
43 Class implementing the Icons configuration page. 40 Class implementing the Icons configuration page.
44 </p> 41 </p>
42
45 <h3>Derived from</h3> 43 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_IconsPage 44 ConfigurationPageBase, Ui_IconsPage
47 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
48 46 <table>
49 <table> 47 <tr><td>None</td></tr>
50 <tr><td>None</td></tr> 48 </table>
51 </table> 49
52 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
53 51 <table>
54 <table> 52 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 53 </table>
56 </table> 54
57 <h3>Methods</h3> 55 <h3>Methods</h3>
58 56 <table>
59 <table>
60
61 <tr> 57 <tr>
62 <td><a href="#IconsPage.__init__">IconsPage</a></td> 58 <td><a href="#IconsPage.__init__">IconsPage</a></td>
63 <td>Constructor</td> 59 <td>Constructor</td>
64 </tr> 60 </tr>
65 <tr> 61 <tr>
101 <tr> 97 <tr>
102 <td><a href="#IconsPage.save">save</a></td> 98 <td><a href="#IconsPage.save">save</a></td>
103 <td>Public slot to save the Icons configuration.</td> 99 <td>Public slot to save the Icons configuration.</td>
104 </tr> 100 </tr>
105 </table> 101 </table>
102
106 <h3>Static Methods</h3> 103 <h3>Static Methods</h3>
107 104 <table>
108 <table> 105 <tr><td>None</td></tr>
109 <tr><td>None</td></tr> 106 </table>
110 </table> 107
111 108
112 <a NAME="IconsPage.__init__" ID="IconsPage.__init__"></a> 109 <a NAME="IconsPage.__init__" ID="IconsPage.__init__"></a>
113 <h4>IconsPage (Constructor)</h4> 110 <h4>IconsPage (Constructor)</h4>
114 <b>IconsPage</b>(<i></i>) 111 <b>IconsPage</b>(<i></i>)
115
116 <p> 112 <p>
117 Constructor 113 Constructor
118 </p> 114 </p>
115
119 <a NAME="IconsPage.__getSelectedDefaultIconsPath" ID="IconsPage.__getSelectedDefaultIconsPath"></a> 116 <a NAME="IconsPage.__getSelectedDefaultIconsPath" ID="IconsPage.__getSelectedDefaultIconsPath"></a>
120 <h4>IconsPage.__getSelectedDefaultIconsPath</h4> 117 <h4>IconsPage.__getSelectedDefaultIconsPath</h4>
121 <b>__getSelectedDefaultIconsPath</b>(<i></i>) 118 <b>__getSelectedDefaultIconsPath</b>(<i></i>)
122
123 <p> 119 <p>
124 Private method to determine the selected default icons path. 120 Private method to determine the selected default icons path.
125 </p> 121 </p>
122
126 <dl> 123 <dl>
127 <dt>Return:</dt> 124 <dt>Return:</dt>
128 <dd> 125 <dd>
129 selected default icons path 126 selected default icons path
130 </dd> 127 </dd>
136 </dd> 133 </dd>
137 </dl> 134 </dl>
138 <a NAME="IconsPage.on_addIconDirectoryButton_clicked" ID="IconsPage.on_addIconDirectoryButton_clicked"></a> 135 <a NAME="IconsPage.on_addIconDirectoryButton_clicked" ID="IconsPage.on_addIconDirectoryButton_clicked"></a>
139 <h4>IconsPage.on_addIconDirectoryButton_clicked</h4> 136 <h4>IconsPage.on_addIconDirectoryButton_clicked</h4>
140 <b>on_addIconDirectoryButton_clicked</b>(<i></i>) 137 <b>on_addIconDirectoryButton_clicked</b>(<i></i>)
141
142 <p> 138 <p>
143 Private slot to add the icon directory displayed to the listbox. 139 Private slot to add the icon directory displayed to the listbox.
144 </p> 140 </p>
141
145 <a NAME="IconsPage.on_deleteIconDirectoryButton_clicked" ID="IconsPage.on_deleteIconDirectoryButton_clicked"></a> 142 <a NAME="IconsPage.on_deleteIconDirectoryButton_clicked" ID="IconsPage.on_deleteIconDirectoryButton_clicked"></a>
146 <h4>IconsPage.on_deleteIconDirectoryButton_clicked</h4> 143 <h4>IconsPage.on_deleteIconDirectoryButton_clicked</h4>
147 <b>on_deleteIconDirectoryButton_clicked</b>(<i></i>) 144 <b>on_deleteIconDirectoryButton_clicked</b>(<i></i>)
148
149 <p> 145 <p>
150 Private slot to delete the currently selected directory of the listbox. 146 Private slot to delete the currently selected directory of the listbox.
151 </p> 147 </p>
148
152 <a NAME="IconsPage.on_downButton_clicked" ID="IconsPage.on_downButton_clicked"></a> 149 <a NAME="IconsPage.on_downButton_clicked" ID="IconsPage.on_downButton_clicked"></a>
153 <h4>IconsPage.on_downButton_clicked</h4> 150 <h4>IconsPage.on_downButton_clicked</h4>
154 <b>on_downButton_clicked</b>(<i></i>) 151 <b>on_downButton_clicked</b>(<i></i>)
155
156 <p> 152 <p>
157 Private slot called to move the selected item down in the list. 153 Private slot called to move the selected item down in the list.
158 </p> 154 </p>
155
159 <a NAME="IconsPage.on_iconDirectoryList_currentRowChanged" ID="IconsPage.on_iconDirectoryList_currentRowChanged"></a> 156 <a NAME="IconsPage.on_iconDirectoryList_currentRowChanged" ID="IconsPage.on_iconDirectoryList_currentRowChanged"></a>
160 <h4>IconsPage.on_iconDirectoryList_currentRowChanged</h4> 157 <h4>IconsPage.on_iconDirectoryList_currentRowChanged</h4>
161 <b>on_iconDirectoryList_currentRowChanged</b>(<i>row</i>) 158 <b>on_iconDirectoryList_currentRowChanged</b>(<i>row</i>)
162
163 <p> 159 <p>
164 Private slot to handle the currentRowChanged signal of the icons 160 Private slot to handle the currentRowChanged signal of the icons
165 directory list. 161 directory list.
166 </p> 162 </p>
163
167 <dl> 164 <dl>
168 165
169 <dt><i>row</i> (int)</dt> 166 <dt><i>row</i> (int)</dt>
170 <dd> 167 <dd>
171 the current row 168 the current row
172 </dd> 169 </dd>
173 </dl> 170 </dl>
174 <a NAME="IconsPage.on_iconDirectoryPicker_textChanged" ID="IconsPage.on_iconDirectoryPicker_textChanged"></a> 171 <a NAME="IconsPage.on_iconDirectoryPicker_textChanged" ID="IconsPage.on_iconDirectoryPicker_textChanged"></a>
175 <h4>IconsPage.on_iconDirectoryPicker_textChanged</h4> 172 <h4>IconsPage.on_iconDirectoryPicker_textChanged</h4>
176 <b>on_iconDirectoryPicker_textChanged</b>(<i>txt</i>) 173 <b>on_iconDirectoryPicker_textChanged</b>(<i>txt</i>)
177
178 <p> 174 <p>
179 Private slot to handle the textChanged signal of the directory picker. 175 Private slot to handle the textChanged signal of the directory picker.
180 </p> 176 </p>
177
181 <dl> 178 <dl>
182 179
183 <dt><i>txt</i> (str)</dt> 180 <dt><i>txt</i> (str)</dt>
184 <dd> 181 <dd>
185 the text of the directory picker 182 the text of the directory picker
186 </dd> 183 </dd>
187 </dl> 184 </dl>
188 <a NAME="IconsPage.on_showDefaultIconsButton_clicked" ID="IconsPage.on_showDefaultIconsButton_clicked"></a> 185 <a NAME="IconsPage.on_showDefaultIconsButton_clicked" ID="IconsPage.on_showDefaultIconsButton_clicked"></a>
189 <h4>IconsPage.on_showDefaultIconsButton_clicked</h4> 186 <h4>IconsPage.on_showDefaultIconsButton_clicked</h4>
190 <b>on_showDefaultIconsButton_clicked</b>(<i></i>) 187 <b>on_showDefaultIconsButton_clicked</b>(<i></i>)
191
192 <p> 188 <p>
193 Private slot to display a preview of the selected default icons. 189 Private slot to display a preview of the selected default icons.
194 </p> 190 </p>
191
195 <a NAME="IconsPage.on_showIconsButton_clicked" ID="IconsPage.on_showIconsButton_clicked"></a> 192 <a NAME="IconsPage.on_showIconsButton_clicked" ID="IconsPage.on_showIconsButton_clicked"></a>
196 <h4>IconsPage.on_showIconsButton_clicked</h4> 193 <h4>IconsPage.on_showIconsButton_clicked</h4>
197 <b>on_showIconsButton_clicked</b>(<i></i>) 194 <b>on_showIconsButton_clicked</b>(<i></i>)
198
199 <p> 195 <p>
200 Private slot to display a preview of an icons directory. 196 Private slot to display a preview of an icons directory.
201 </p> 197 </p>
198
202 <a NAME="IconsPage.on_upButton_clicked" ID="IconsPage.on_upButton_clicked"></a> 199 <a NAME="IconsPage.on_upButton_clicked" ID="IconsPage.on_upButton_clicked"></a>
203 <h4>IconsPage.on_upButton_clicked</h4> 200 <h4>IconsPage.on_upButton_clicked</h4>
204 <b>on_upButton_clicked</b>(<i></i>) 201 <b>on_upButton_clicked</b>(<i></i>)
205
206 <p> 202 <p>
207 Private slot called to move the selected item up in the list. 203 Private slot called to move the selected item up in the list.
208 </p> 204 </p>
205
209 <a NAME="IconsPage.save" ID="IconsPage.save"></a> 206 <a NAME="IconsPage.save" ID="IconsPage.save"></a>
210 <h4>IconsPage.save</h4> 207 <h4>IconsPage.save</h4>
211 <b>save</b>(<i></i>) 208 <b>save</b>(<i></i>)
212
213 <p> 209 <p>
214 Public slot to save the Icons configuration. 210 Public slot to save the Icons configuration.
215 </p> 211 </p>
212
216 <div align="right"><a href="#top">Up</a></div> 213 <div align="right"><a href="#top">Up</a></div>
217 <hr /> 214 <hr />
218 <hr /> 215 <hr />
219 <a NAME="create" ID="create"></a> 216 <a NAME="create" ID="create"></a>
220 <h2>create</h2> 217 <h2>create</h2>
221 <b>create</b>(<i>dlg</i>) 218 <b>create</b>(<i>dlg</i>)
222
223 <p> 219 <p>
224 Module function to create the configuration page. 220 Module function to create the configuration page.
225 </p> 221 </p>
222
226 <dl> 223 <dl>
227 224
228 <dt><i>dlg</i> (ConfigurationDialog)</dt> 225 <dt><i>dlg</i> (ConfigurationDialog)</dt>
229 <dd> 226 <dd>
230 reference to the configuration dialog 227 reference to the configuration dialog

eric ide

mercurial