Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html

eric6/Documentation/Source/eric6.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog</h1> 23 <h1>eric6.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to enter the parameters for eric6_doc. 26 Module implementing a dialog to enter the parameters for eric6_doc.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#EricdocConfigDialog">EricdocConfigDialog</a></td> 38 <td><a href="#EricdocConfigDialog">EricdocConfigDialog</a></td>
34 <td>Class implementing a dialog to enter the parameters for eric6_doc.</td> 39 <td>Class implementing a dialog to enter the parameters for eric6_doc.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="EricdocConfigDialog" ID="EricdocConfigDialog"></a> 49 <a NAME="EricdocConfigDialog" ID="EricdocConfigDialog"></a>
43 <h2>EricdocConfigDialog</h2> 50 <h2>EricdocConfigDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to enter the parameters for eric6_doc. 53 Class implementing a dialog to enter the parameters for eric6_doc.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_EricdocConfigDialog 56 QDialog, Ui_EricdocConfigDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#EricdocConfigDialog.__init__">EricdocConfigDialog</a></td> 72 <td><a href="#EricdocConfigDialog.__init__">EricdocConfigDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#EricdocConfigDialog.__checkQtHelpOptions">__checkQtHelpOptions</a></td> 76 <td><a href="#EricdocConfigDialog.__checkQtHelpOptions">__checkQtHelpOptions</a></td>
64 <td>Private slot to check the QtHelp options and set the ok button accordingly.</td> 77 <td>Private slot to check the QtHelp options and set the ok button accordingly.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#EricdocConfigDialog.__initializeDefaults">__initializeDefaults</a></td> 80 <td><a href="#EricdocConfigDialog.__initializeDefaults">__initializeDefaults</a></td>
67 <td>Private method to set the default values.</td> 81 <td>Private method to set the default values.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#EricdocConfigDialog.__selectColor">__selectColor</a></td> 84 <td><a href="#EricdocConfigDialog.__selectColor">__selectColor</a></td>
70 <td>Private method to select a color.</td> 85 <td>Private method to select a color.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#EricdocConfigDialog.accept">accept</a></td> 88 <td><a href="#EricdocConfigDialog.accept">accept</a></td>
73 <td>Public slot called by the Ok button.</td> 89 <td>Public slot called by the Ok button.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#EricdocConfigDialog.generateParameters">generateParameters</a></td> 92 <td><a href="#EricdocConfigDialog.generateParameters">generateParameters</a></td>
76 <td>Public method that generates the commandline parameters.</td> 93 <td>Public method that generates the commandline parameters.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#EricdocConfigDialog.on_addButton_clicked">on_addButton_clicked</a></td> 96 <td><a href="#EricdocConfigDialog.on_addButton_clicked">on_addButton_clicked</a></td>
79 <td>Private slot to add the directory displayed to the listview.</td> 97 <td>Private slot to add the directory displayed to the listview.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#EricdocConfigDialog.on_bodyBgButton_clicked">on_bodyBgButton_clicked</a></td> 100 <td><a href="#EricdocConfigDialog.on_bodyBgButton_clicked">on_bodyBgButton_clicked</a></td>
82 <td>Private slot to select the body background color.</td> 101 <td>Private slot to select the body background color.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#EricdocConfigDialog.on_bodyFgButton_clicked">on_bodyFgButton_clicked</a></td> 104 <td><a href="#EricdocConfigDialog.on_bodyFgButton_clicked">on_bodyFgButton_clicked</a></td>
85 <td>Private slot to select the body foreground color.</td> 105 <td>Private slot to select the body foreground color.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#EricdocConfigDialog.on_cfBgButton_clicked">on_cfBgButton_clicked</a></td> 108 <td><a href="#EricdocConfigDialog.on_cfBgButton_clicked">on_cfBgButton_clicked</a></td>
88 <td>Private slot to select the class/function header background color.</td> 109 <td>Private slot to select the class/function header background color.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#EricdocConfigDialog.on_cfFgButton_clicked">on_cfFgButton_clicked</a></td> 112 <td><a href="#EricdocConfigDialog.on_cfFgButton_clicked">on_cfFgButton_clicked</a></td>
91 <td>Private slot to select the class/function header foreground color.</td> 113 <td>Private slot to select the class/function header foreground color.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#EricdocConfigDialog.on_cssPicker_pathSelected">on_cssPicker_pathSelected</a></td> 116 <td><a href="#EricdocConfigDialog.on_cssPicker_pathSelected">on_cssPicker_pathSelected</a></td>
94 <td>Private slot handling the selection of a css style sheet.</td> 117 <td>Private slot handling the selection of a css style sheet.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#EricdocConfigDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> 120 <td><a href="#EricdocConfigDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
97 <td>Private slot to delete the currently selected directory of the listbox.</td> 121 <td>Private slot to delete the currently selected directory of the listbox.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#EricdocConfigDialog.on_ignoreDirPicker_pathSelected">on_ignoreDirPicker_pathSelected</a></td> 124 <td><a href="#EricdocConfigDialog.on_ignoreDirPicker_pathSelected">on_ignoreDirPicker_pathSelected</a></td>
100 <td>Private slot handling the selection of a directory to be ignored.</td> 125 <td>Private slot handling the selection of a directory to be ignored.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#EricdocConfigDialog.on_l1BgButton_clicked">on_l1BgButton_clicked</a></td> 128 <td><a href="#EricdocConfigDialog.on_l1BgButton_clicked">on_l1BgButton_clicked</a></td>
103 <td>Private slot to select the level 1 header background color.</td> 129 <td>Private slot to select the level 1 header background color.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#EricdocConfigDialog.on_l1FgButton_clicked">on_l1FgButton_clicked</a></td> 132 <td><a href="#EricdocConfigDialog.on_l1FgButton_clicked">on_l1FgButton_clicked</a></td>
106 <td>Private slot to select the level 1 header foreground color.</td> 133 <td>Private slot to select the level 1 header foreground color.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#EricdocConfigDialog.on_l2BgButton_clicked">on_l2BgButton_clicked</a></td> 136 <td><a href="#EricdocConfigDialog.on_l2BgButton_clicked">on_l2BgButton_clicked</a></td>
109 <td>Private slot to select the level 2 header background color.</td> 137 <td>Private slot to select the level 2 header background color.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#EricdocConfigDialog.on_l2FgButton_clicked">on_l2FgButton_clicked</a></td> 140 <td><a href="#EricdocConfigDialog.on_l2FgButton_clicked">on_l2FgButton_clicked</a></td>
112 <td>Private slot to select the level 2 header foreground color.</td> 141 <td>Private slot to select the level 2 header foreground color.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#EricdocConfigDialog.on_linkFgButton_clicked">on_linkFgButton_clicked</a></td> 144 <td><a href="#EricdocConfigDialog.on_linkFgButton_clicked">on_linkFgButton_clicked</a></td>
115 <td>Private slot to select the foreground color of links.</td> 145 <td>Private slot to select the foreground color of links.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#EricdocConfigDialog.on_outputDirPicker_pathSelected">on_outputDirPicker_pathSelected</a></td> 148 <td><a href="#EricdocConfigDialog.on_outputDirPicker_pathSelected">on_outputDirPicker_pathSelected</a></td>
118 <td>Private slot handling the selection of an output directory.</td> 149 <td>Private slot handling the selection of an output directory.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#EricdocConfigDialog.on_qtHelpDirPicker_pathSelected">on_qtHelpDirPicker_pathSelected</a></td> 152 <td><a href="#EricdocConfigDialog.on_qtHelpDirPicker_pathSelected">on_qtHelpDirPicker_pathSelected</a></td>
121 <td>Private slot handling the selection of the output directory for the QtHelp files.</td> 153 <td>Private slot handling the selection of the output directory for the QtHelp files.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#EricdocConfigDialog.on_qtHelpFolderEdit_textChanged">on_qtHelpFolderEdit_textChanged</a></td> 156 <td><a href="#EricdocConfigDialog.on_qtHelpFolderEdit_textChanged">on_qtHelpFolderEdit_textChanged</a></td>
124 <td>Private slot to check the virtual folder.</td> 157 <td>Private slot to check the virtual folder.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#EricdocConfigDialog.on_qtHelpGroup_toggled">on_qtHelpGroup_toggled</a></td> 160 <td><a href="#EricdocConfigDialog.on_qtHelpGroup_toggled">on_qtHelpGroup_toggled</a></td>
127 <td>Private slot to toggle the generation of QtHelp files.</td> 161 <td>Private slot to toggle the generation of QtHelp files.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged">on_qtHelpNamespaceEdit_textChanged</a></td> 164 <td><a href="#EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged">on_qtHelpNamespaceEdit_textChanged</a></td>
130 <td>Private slot to check the namespace.</td> 165 <td>Private slot to check the namespace.</td>
131 </tr><tr> 166 </tr>
167 <tr>
132 <td><a href="#EricdocConfigDialog.on_qtHelpTitleEdit_textChanged">on_qtHelpTitleEdit_textChanged</a></td> 168 <td><a href="#EricdocConfigDialog.on_qtHelpTitleEdit_textChanged">on_qtHelpTitleEdit_textChanged</a></td>
133 <td>Private slot to check the title.</td> 169 <td>Private slot to check the title.</td>
134 </tr> 170 </tr>
135 </table> 171 </table>
136 <h3>Static Methods</h3> 172 <h3>Static Methods</h3>
173
137 <table> 174 <table>
138 <tr><td>None</td></tr> 175 <tr><td>None</td></tr>
139 </table> 176 </table>
177
140 <a NAME="EricdocConfigDialog.__init__" ID="EricdocConfigDialog.__init__"></a> 178 <a NAME="EricdocConfigDialog.__init__" ID="EricdocConfigDialog.__init__"></a>
141 <h4>EricdocConfigDialog (Constructor)</h4> 179 <h4>EricdocConfigDialog (Constructor)</h4>
142 <b>EricdocConfigDialog</b>(<i>project, parms=None, parent=None</i>) 180 <b>EricdocConfigDialog</b>(<i>project, parms=None, parent=None</i>)
181
143 <p> 182 <p>
144 Constructor 183 Constructor
145 </p><dl> 184 </p>
185 <dl>
186
146 <dt><i>project</i></dt> 187 <dt><i>project</i></dt>
147 <dd> 188 <dd>
148 reference to the project object (Project.Project) 189 reference to the project object (Project.Project)
149 </dd><dt><i>parms</i></dt> 190 </dd>
191 <dt><i>parms</i></dt>
150 <dd> 192 <dd>
151 parameters to set in the dialog 193 parameters to set in the dialog
152 </dd><dt><i>parent</i></dt> 194 </dd>
195 <dt><i>parent</i></dt>
153 <dd> 196 <dd>
154 parent widget of this dialog 197 parent widget of this dialog
155 </dd> 198 </dd>
156 </dl><a NAME="EricdocConfigDialog.__checkQtHelpOptions" ID="EricdocConfigDialog.__checkQtHelpOptions"></a> 199 </dl>
200 <a NAME="EricdocConfigDialog.__checkQtHelpOptions" ID="EricdocConfigDialog.__checkQtHelpOptions"></a>
157 <h4>EricdocConfigDialog.__checkQtHelpOptions</h4> 201 <h4>EricdocConfigDialog.__checkQtHelpOptions</h4>
158 <b>__checkQtHelpOptions</b>(<i></i>) 202 <b>__checkQtHelpOptions</b>(<i></i>)
203
159 <p> 204 <p>
160 Private slot to check the QtHelp options and set the ok button 205 Private slot to check the QtHelp options and set the ok button
161 accordingly. 206 accordingly.
162 </p><a NAME="EricdocConfigDialog.__initializeDefaults" ID="EricdocConfigDialog.__initializeDefaults"></a> 207 </p>
208 <a NAME="EricdocConfigDialog.__initializeDefaults" ID="EricdocConfigDialog.__initializeDefaults"></a>
163 <h4>EricdocConfigDialog.__initializeDefaults</h4> 209 <h4>EricdocConfigDialog.__initializeDefaults</h4>
164 <b>__initializeDefaults</b>(<i></i>) 210 <b>__initializeDefaults</b>(<i></i>)
211
165 <p> 212 <p>
166 Private method to set the default values. 213 Private method to set the default values.
167 </p><p> 214 </p>
215 <p>
168 These are needed later on to generate the commandline 216 These are needed later on to generate the commandline
169 parameters. 217 parameters.
170 </p><a NAME="EricdocConfigDialog.__selectColor" ID="EricdocConfigDialog.__selectColor"></a> 218 </p>
219 <a NAME="EricdocConfigDialog.__selectColor" ID="EricdocConfigDialog.__selectColor"></a>
171 <h4>EricdocConfigDialog.__selectColor</h4> 220 <h4>EricdocConfigDialog.__selectColor</h4>
172 <b>__selectColor</b>(<i>colorKey</i>) 221 <b>__selectColor</b>(<i>colorKey</i>)
222
173 <p> 223 <p>
174 Private method to select a color. 224 Private method to select a color.
175 </p><dl> 225 </p>
226 <dl>
227
176 <dt><i>colorKey</i></dt> 228 <dt><i>colorKey</i></dt>
177 <dd> 229 <dd>
178 key of the color to select (string) 230 key of the color to select (string)
179 </dd> 231 </dd>
180 </dl><a NAME="EricdocConfigDialog.accept" ID="EricdocConfigDialog.accept"></a> 232 </dl>
233 <a NAME="EricdocConfigDialog.accept" ID="EricdocConfigDialog.accept"></a>
181 <h4>EricdocConfigDialog.accept</h4> 234 <h4>EricdocConfigDialog.accept</h4>
182 <b>accept</b>(<i></i>) 235 <b>accept</b>(<i></i>)
236
183 <p> 237 <p>
184 Public slot called by the Ok button. 238 Public slot called by the Ok button.
185 </p><p> 239 </p>
240 <p>
186 It saves the values in the parameters dictionary. 241 It saves the values in the parameters dictionary.
187 </p><a NAME="EricdocConfigDialog.generateParameters" ID="EricdocConfigDialog.generateParameters"></a> 242 </p>
243 <a NAME="EricdocConfigDialog.generateParameters" ID="EricdocConfigDialog.generateParameters"></a>
188 <h4>EricdocConfigDialog.generateParameters</h4> 244 <h4>EricdocConfigDialog.generateParameters</h4>
189 <b>generateParameters</b>(<i></i>) 245 <b>generateParameters</b>(<i></i>)
246
190 <p> 247 <p>
191 Public method that generates the commandline parameters. 248 Public method that generates the commandline parameters.
192 </p><p> 249 </p>
250 <p>
193 It generates a list of strings to be used 251 It generates a list of strings to be used
194 to set the QProcess arguments for the ericdoc call and 252 to set the QProcess arguments for the ericdoc call and
195 a dictionary containing the non default parameters. This 253 a dictionary containing the non default parameters. This
196 dictionary can be passed back upon object generation to overwrite 254 dictionary can be passed back upon object generation to overwrite
197 the default settings. 255 the default settings.
198 </p><dl> 256 </p>
257 <dl>
199 <dt>Returns:</dt> 258 <dt>Returns:</dt>
200 <dd> 259 <dd>
201 a tuple of the commandline parameters and non default 260 a tuple of the commandline parameters and non default
202 parameters (list of strings, dictionary) 261 parameters (list of strings, dictionary)
203 </dd> 262 </dd>
204 </dl><a NAME="EricdocConfigDialog.on_addButton_clicked" ID="EricdocConfigDialog.on_addButton_clicked"></a> 263 </dl>
264 <a NAME="EricdocConfigDialog.on_addButton_clicked" ID="EricdocConfigDialog.on_addButton_clicked"></a>
205 <h4>EricdocConfigDialog.on_addButton_clicked</h4> 265 <h4>EricdocConfigDialog.on_addButton_clicked</h4>
206 <b>on_addButton_clicked</b>(<i></i>) 266 <b>on_addButton_clicked</b>(<i></i>)
267
207 <p> 268 <p>
208 Private slot to add the directory displayed to the listview. 269 Private slot to add the directory displayed to the listview.
209 </p><p> 270 </p>
271 <p>
210 The directory in the ignore directories 272 The directory in the ignore directories
211 line edit is moved to the listbox above and the edit is cleared. 273 line edit is moved to the listbox above and the edit is cleared.
212 </p><a NAME="EricdocConfigDialog.on_bodyBgButton_clicked" ID="EricdocConfigDialog.on_bodyBgButton_clicked"></a> 274 </p>
275 <a NAME="EricdocConfigDialog.on_bodyBgButton_clicked" ID="EricdocConfigDialog.on_bodyBgButton_clicked"></a>
213 <h4>EricdocConfigDialog.on_bodyBgButton_clicked</h4> 276 <h4>EricdocConfigDialog.on_bodyBgButton_clicked</h4>
214 <b>on_bodyBgButton_clicked</b>(<i></i>) 277 <b>on_bodyBgButton_clicked</b>(<i></i>)
278
215 <p> 279 <p>
216 Private slot to select the body background color. 280 Private slot to select the body background color.
217 </p><a NAME="EricdocConfigDialog.on_bodyFgButton_clicked" ID="EricdocConfigDialog.on_bodyFgButton_clicked"></a> 281 </p>
282 <a NAME="EricdocConfigDialog.on_bodyFgButton_clicked" ID="EricdocConfigDialog.on_bodyFgButton_clicked"></a>
218 <h4>EricdocConfigDialog.on_bodyFgButton_clicked</h4> 283 <h4>EricdocConfigDialog.on_bodyFgButton_clicked</h4>
219 <b>on_bodyFgButton_clicked</b>(<i></i>) 284 <b>on_bodyFgButton_clicked</b>(<i></i>)
285
220 <p> 286 <p>
221 Private slot to select the body foreground color. 287 Private slot to select the body foreground color.
222 </p><a NAME="EricdocConfigDialog.on_cfBgButton_clicked" ID="EricdocConfigDialog.on_cfBgButton_clicked"></a> 288 </p>
289 <a NAME="EricdocConfigDialog.on_cfBgButton_clicked" ID="EricdocConfigDialog.on_cfBgButton_clicked"></a>
223 <h4>EricdocConfigDialog.on_cfBgButton_clicked</h4> 290 <h4>EricdocConfigDialog.on_cfBgButton_clicked</h4>
224 <b>on_cfBgButton_clicked</b>(<i></i>) 291 <b>on_cfBgButton_clicked</b>(<i></i>)
292
225 <p> 293 <p>
226 Private slot to select the class/function header background color. 294 Private slot to select the class/function header background color.
227 </p><a NAME="EricdocConfigDialog.on_cfFgButton_clicked" ID="EricdocConfigDialog.on_cfFgButton_clicked"></a> 295 </p>
296 <a NAME="EricdocConfigDialog.on_cfFgButton_clicked" ID="EricdocConfigDialog.on_cfFgButton_clicked"></a>
228 <h4>EricdocConfigDialog.on_cfFgButton_clicked</h4> 297 <h4>EricdocConfigDialog.on_cfFgButton_clicked</h4>
229 <b>on_cfFgButton_clicked</b>(<i></i>) 298 <b>on_cfFgButton_clicked</b>(<i></i>)
299
230 <p> 300 <p>
231 Private slot to select the class/function header foreground color. 301 Private slot to select the class/function header foreground color.
232 </p><a NAME="EricdocConfigDialog.on_cssPicker_pathSelected" ID="EricdocConfigDialog.on_cssPicker_pathSelected"></a> 302 </p>
303 <a NAME="EricdocConfigDialog.on_cssPicker_pathSelected" ID="EricdocConfigDialog.on_cssPicker_pathSelected"></a>
233 <h4>EricdocConfigDialog.on_cssPicker_pathSelected</h4> 304 <h4>EricdocConfigDialog.on_cssPicker_pathSelected</h4>
234 <b>on_cssPicker_pathSelected</b>(<i>path</i>) 305 <b>on_cssPicker_pathSelected</b>(<i>path</i>)
306
235 <p> 307 <p>
236 Private slot handling the selection of a css style sheet. 308 Private slot handling the selection of a css style sheet.
237 </p><dl> 309 </p>
310 <dl>
311
238 <dt><i>path</i> (str)</dt> 312 <dt><i>path</i> (str)</dt>
239 <dd> 313 <dd>
240 path of the css style sheet 314 path of the css style sheet
241 </dd> 315 </dd>
242 </dl><a NAME="EricdocConfigDialog.on_deleteButton_clicked" ID="EricdocConfigDialog.on_deleteButton_clicked"></a> 316 </dl>
317 <a NAME="EricdocConfigDialog.on_deleteButton_clicked" ID="EricdocConfigDialog.on_deleteButton_clicked"></a>
243 <h4>EricdocConfigDialog.on_deleteButton_clicked</h4> 318 <h4>EricdocConfigDialog.on_deleteButton_clicked</h4>
244 <b>on_deleteButton_clicked</b>(<i></i>) 319 <b>on_deleteButton_clicked</b>(<i></i>)
320
245 <p> 321 <p>
246 Private slot to delete the currently selected directory of the listbox. 322 Private slot to delete the currently selected directory of the listbox.
247 </p><a NAME="EricdocConfigDialog.on_ignoreDirPicker_pathSelected" ID="EricdocConfigDialog.on_ignoreDirPicker_pathSelected"></a> 323 </p>
324 <a NAME="EricdocConfigDialog.on_ignoreDirPicker_pathSelected" ID="EricdocConfigDialog.on_ignoreDirPicker_pathSelected"></a>
248 <h4>EricdocConfigDialog.on_ignoreDirPicker_pathSelected</h4> 325 <h4>EricdocConfigDialog.on_ignoreDirPicker_pathSelected</h4>
249 <b>on_ignoreDirPicker_pathSelected</b>(<i>path</i>) 326 <b>on_ignoreDirPicker_pathSelected</b>(<i>path</i>)
327
250 <p> 328 <p>
251 Private slot handling the selection of a directory to be ignored. 329 Private slot handling the selection of a directory to be ignored.
252 </p><dl> 330 </p>
331 <dl>
332
253 <dt><i>path</i> (str)</dt> 333 <dt><i>path</i> (str)</dt>
254 <dd> 334 <dd>
255 path of the directory to be ignored 335 path of the directory to be ignored
256 </dd> 336 </dd>
257 </dl><a NAME="EricdocConfigDialog.on_l1BgButton_clicked" ID="EricdocConfigDialog.on_l1BgButton_clicked"></a> 337 </dl>
338 <a NAME="EricdocConfigDialog.on_l1BgButton_clicked" ID="EricdocConfigDialog.on_l1BgButton_clicked"></a>
258 <h4>EricdocConfigDialog.on_l1BgButton_clicked</h4> 339 <h4>EricdocConfigDialog.on_l1BgButton_clicked</h4>
259 <b>on_l1BgButton_clicked</b>(<i></i>) 340 <b>on_l1BgButton_clicked</b>(<i></i>)
341
260 <p> 342 <p>
261 Private slot to select the level 1 header background color. 343 Private slot to select the level 1 header background color.
262 </p><a NAME="EricdocConfigDialog.on_l1FgButton_clicked" ID="EricdocConfigDialog.on_l1FgButton_clicked"></a> 344 </p>
345 <a NAME="EricdocConfigDialog.on_l1FgButton_clicked" ID="EricdocConfigDialog.on_l1FgButton_clicked"></a>
263 <h4>EricdocConfigDialog.on_l1FgButton_clicked</h4> 346 <h4>EricdocConfigDialog.on_l1FgButton_clicked</h4>
264 <b>on_l1FgButton_clicked</b>(<i></i>) 347 <b>on_l1FgButton_clicked</b>(<i></i>)
348
265 <p> 349 <p>
266 Private slot to select the level 1 header foreground color. 350 Private slot to select the level 1 header foreground color.
267 </p><a NAME="EricdocConfigDialog.on_l2BgButton_clicked" ID="EricdocConfigDialog.on_l2BgButton_clicked"></a> 351 </p>
352 <a NAME="EricdocConfigDialog.on_l2BgButton_clicked" ID="EricdocConfigDialog.on_l2BgButton_clicked"></a>
268 <h4>EricdocConfigDialog.on_l2BgButton_clicked</h4> 353 <h4>EricdocConfigDialog.on_l2BgButton_clicked</h4>
269 <b>on_l2BgButton_clicked</b>(<i></i>) 354 <b>on_l2BgButton_clicked</b>(<i></i>)
355
270 <p> 356 <p>
271 Private slot to select the level 2 header background color. 357 Private slot to select the level 2 header background color.
272 </p><a NAME="EricdocConfigDialog.on_l2FgButton_clicked" ID="EricdocConfigDialog.on_l2FgButton_clicked"></a> 358 </p>
359 <a NAME="EricdocConfigDialog.on_l2FgButton_clicked" ID="EricdocConfigDialog.on_l2FgButton_clicked"></a>
273 <h4>EricdocConfigDialog.on_l2FgButton_clicked</h4> 360 <h4>EricdocConfigDialog.on_l2FgButton_clicked</h4>
274 <b>on_l2FgButton_clicked</b>(<i></i>) 361 <b>on_l2FgButton_clicked</b>(<i></i>)
362
275 <p> 363 <p>
276 Private slot to select the level 2 header foreground color. 364 Private slot to select the level 2 header foreground color.
277 </p><a NAME="EricdocConfigDialog.on_linkFgButton_clicked" ID="EricdocConfigDialog.on_linkFgButton_clicked"></a> 365 </p>
366 <a NAME="EricdocConfigDialog.on_linkFgButton_clicked" ID="EricdocConfigDialog.on_linkFgButton_clicked"></a>
278 <h4>EricdocConfigDialog.on_linkFgButton_clicked</h4> 367 <h4>EricdocConfigDialog.on_linkFgButton_clicked</h4>
279 <b>on_linkFgButton_clicked</b>(<i></i>) 368 <b>on_linkFgButton_clicked</b>(<i></i>)
369
280 <p> 370 <p>
281 Private slot to select the foreground color of links. 371 Private slot to select the foreground color of links.
282 </p><a NAME="EricdocConfigDialog.on_outputDirPicker_pathSelected" ID="EricdocConfigDialog.on_outputDirPicker_pathSelected"></a> 372 </p>
373 <a NAME="EricdocConfigDialog.on_outputDirPicker_pathSelected" ID="EricdocConfigDialog.on_outputDirPicker_pathSelected"></a>
283 <h4>EricdocConfigDialog.on_outputDirPicker_pathSelected</h4> 374 <h4>EricdocConfigDialog.on_outputDirPicker_pathSelected</h4>
284 <b>on_outputDirPicker_pathSelected</b>(<i>path</i>) 375 <b>on_outputDirPicker_pathSelected</b>(<i>path</i>)
376
285 <p> 377 <p>
286 Private slot handling the selection of an output directory. 378 Private slot handling the selection of an output directory.
287 </p><dl> 379 </p>
380 <dl>
381
288 <dt><i>path</i> (str)</dt> 382 <dt><i>path</i> (str)</dt>
289 <dd> 383 <dd>
290 path of the output directory 384 path of the output directory
291 </dd> 385 </dd>
292 </dl><a NAME="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected" ID="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected"></a> 386 </dl>
387 <a NAME="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected" ID="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected"></a>
293 <h4>EricdocConfigDialog.on_qtHelpDirPicker_pathSelected</h4> 388 <h4>EricdocConfigDialog.on_qtHelpDirPicker_pathSelected</h4>
294 <b>on_qtHelpDirPicker_pathSelected</b>(<i>path</i>) 389 <b>on_qtHelpDirPicker_pathSelected</b>(<i>path</i>)
390
295 <p> 391 <p>
296 Private slot handling the selection of the output directory for the 392 Private slot handling the selection of the output directory for the
297 QtHelp files. 393 QtHelp files.
298 </p><dl> 394 </p>
395 <dl>
396
299 <dt><i>path</i> (str)</dt> 397 <dt><i>path</i> (str)</dt>
300 <dd> 398 <dd>
301 path of the the output directory for the QtHelp files 399 path of the the output directory for the QtHelp files
302 </dd> 400 </dd>
303 </dl><a NAME="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged"></a> 401 </dl>
402 <a NAME="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged"></a>
304 <h4>EricdocConfigDialog.on_qtHelpFolderEdit_textChanged</h4> 403 <h4>EricdocConfigDialog.on_qtHelpFolderEdit_textChanged</h4>
305 <b>on_qtHelpFolderEdit_textChanged</b>(<i>txt</i>) 404 <b>on_qtHelpFolderEdit_textChanged</b>(<i>txt</i>)
405
306 <p> 406 <p>
307 Private slot to check the virtual folder. 407 Private slot to check the virtual folder.
308 </p><dl> 408 </p>
409 <dl>
410
309 <dt><i>txt</i></dt> 411 <dt><i>txt</i></dt>
310 <dd> 412 <dd>
311 text of the line edit (string) 413 text of the line edit (string)
312 </dd> 414 </dd>
313 </dl><a NAME="EricdocConfigDialog.on_qtHelpGroup_toggled" ID="EricdocConfigDialog.on_qtHelpGroup_toggled"></a> 415 </dl>
416 <a NAME="EricdocConfigDialog.on_qtHelpGroup_toggled" ID="EricdocConfigDialog.on_qtHelpGroup_toggled"></a>
314 <h4>EricdocConfigDialog.on_qtHelpGroup_toggled</h4> 417 <h4>EricdocConfigDialog.on_qtHelpGroup_toggled</h4>
315 <b>on_qtHelpGroup_toggled</b>(<i>enabled</i>) 418 <b>on_qtHelpGroup_toggled</b>(<i>enabled</i>)
419
316 <p> 420 <p>
317 Private slot to toggle the generation of QtHelp files. 421 Private slot to toggle the generation of QtHelp files.
318 </p><dl> 422 </p>
423 <dl>
424
319 <dt><i>enabled</i></dt> 425 <dt><i>enabled</i></dt>
320 <dd> 426 <dd>
321 flag indicating the state (boolean) 427 flag indicating the state (boolean)
322 </dd> 428 </dd>
323 </dl><a NAME="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged"></a> 429 </dl>
430 <a NAME="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged"></a>
324 <h4>EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged</h4> 431 <h4>EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged</h4>
325 <b>on_qtHelpNamespaceEdit_textChanged</b>(<i>txt</i>) 432 <b>on_qtHelpNamespaceEdit_textChanged</b>(<i>txt</i>)
433
326 <p> 434 <p>
327 Private slot to check the namespace. 435 Private slot to check the namespace.
328 </p><dl> 436 </p>
437 <dl>
438
329 <dt><i>txt</i></dt> 439 <dt><i>txt</i></dt>
330 <dd> 440 <dd>
331 text of the line edit (string) 441 text of the line edit (string)
332 </dd> 442 </dd>
333 </dl><a NAME="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged"></a> 443 </dl>
444 <a NAME="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged"></a>
334 <h4>EricdocConfigDialog.on_qtHelpTitleEdit_textChanged</h4> 445 <h4>EricdocConfigDialog.on_qtHelpTitleEdit_textChanged</h4>
335 <b>on_qtHelpTitleEdit_textChanged</b>(<i>txt</i>) 446 <b>on_qtHelpTitleEdit_textChanged</b>(<i>txt</i>)
447
336 <p> 448 <p>
337 Private slot to check the title. 449 Private slot to check the title.
338 </p><dl> 450 </p>
451 <dl>
452
339 <dt><i>txt</i></dt> 453 <dt><i>txt</i></dt>
340 <dd> 454 <dd>
341 text of the line edit (string) 455 text of the line edit (string)
342 </dd> 456 </dd>
343 </dl> 457 </dl>

Mercurial Repository: eric

eric ide

mercurial