diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.EditorFilePage.html --- a/eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.EditorFilePage.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.EditorFilePage.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,176 +18,234 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Preferences.ConfigurationPages.EditorFilePage</h1> + <p> Module implementing the Editor File Handling configuration page. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#EditorFilePage">EditorFilePage</a></td> <td>Class implementing the Editor File Handling configuration page.</td> </tr> </table> <h3>Functions</h3> + <table> + <tr> <td><a href="#create">create</a></td> <td>Module function to create the configuration page.</td> </tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="EditorFilePage" ID="EditorFilePage"></a> <h2>EditorFilePage</h2> + <p> Class implementing the Editor File Handling configuration page. </p> <h3>Derived from</h3> ConfigurationPageBase, Ui_EditorFilePage <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#EditorFilePage.__init__">EditorFilePage</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditorFilePage.__checkFileFilter">__checkFileFilter</a></td> <td>Private method to check a file filter for validity.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditorFilePage.__extractFileFilters">__extractFileFilters</a></td> <td>Private method to extract the file filters.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditorFilePage.__setDefaultFiltersLists">__setDefaultFiltersLists</a></td> <td>Private slot to set the default file filter combo boxes.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditorFilePage.on_addFileFilterButton_clicked">on_addFileFilterButton_clicked</a></td> <td>Private slot to add a file filter to the list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditorFilePage.on_deleteFileFilterButton_clicked">on_deleteFileFilterButton_clicked</a></td> <td>Private slot called to delete a file filter entry.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditorFilePage.on_editFileFilterButton_clicked">on_editFileFilterButton_clicked</a></td> <td>Private slot called to edit a file filter entry.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditorFilePage.on_fileFiltersList_currentItemChanged">on_fileFiltersList_currentItemChanged</a></td> <td>Private slot to set the state of the edit and delete buttons.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditorFilePage.on_openFiltersButton_toggled">on_openFiltersButton_toggled</a></td> <td>Private slot to switch the list of file filters.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditorFilePage.save">save</a></td> <td>Public slot to save the Editor File Handling configuration.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="EditorFilePage.__init__" ID="EditorFilePage.__init__"></a> <h4>EditorFilePage (Constructor)</h4> <b>EditorFilePage</b>(<i></i>) + <p> Constructor -</p><a NAME="EditorFilePage.__checkFileFilter" ID="EditorFilePage.__checkFileFilter"></a> +</p> +<a NAME="EditorFilePage.__checkFileFilter" ID="EditorFilePage.__checkFileFilter"></a> <h4>EditorFilePage.__checkFileFilter</h4> <b>__checkFileFilter</b>(<i>fileFilter</i>) + <p> Private method to check a file filter for validity. -</p><dl> +</p> +<dl> + <dt><i>fileFilter</i></dt> <dd> file filter pattern to check (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating validity (boolean) </dd> -</dl><a NAME="EditorFilePage.__extractFileFilters" ID="EditorFilePage.__extractFileFilters"></a> +</dl> +<a NAME="EditorFilePage.__extractFileFilters" ID="EditorFilePage.__extractFileFilters"></a> <h4>EditorFilePage.__extractFileFilters</h4> <b>__extractFileFilters</b>(<i></i>) + <p> Private method to extract the file filters. -</p><a NAME="EditorFilePage.__setDefaultFiltersLists" ID="EditorFilePage.__setDefaultFiltersLists"></a> +</p> +<a NAME="EditorFilePage.__setDefaultFiltersLists" ID="EditorFilePage.__setDefaultFiltersLists"></a> <h4>EditorFilePage.__setDefaultFiltersLists</h4> <b>__setDefaultFiltersLists</b>(<i>keepSelection=False</i>) + <p> Private slot to set the default file filter combo boxes. -</p><dl> +</p> +<dl> + <dt><i>keepSelection</i></dt> <dd> flag indicating to keep the current selection if possible (boolean) </dd> -</dl><a NAME="EditorFilePage.on_addFileFilterButton_clicked" ID="EditorFilePage.on_addFileFilterButton_clicked"></a> +</dl> +<a NAME="EditorFilePage.on_addFileFilterButton_clicked" ID="EditorFilePage.on_addFileFilterButton_clicked"></a> <h4>EditorFilePage.on_addFileFilterButton_clicked</h4> <b>on_addFileFilterButton_clicked</b>(<i></i>) + <p> Private slot to add a file filter to the list. -</p><a NAME="EditorFilePage.on_deleteFileFilterButton_clicked" ID="EditorFilePage.on_deleteFileFilterButton_clicked"></a> +</p> +<a NAME="EditorFilePage.on_deleteFileFilterButton_clicked" ID="EditorFilePage.on_deleteFileFilterButton_clicked"></a> <h4>EditorFilePage.on_deleteFileFilterButton_clicked</h4> <b>on_deleteFileFilterButton_clicked</b>(<i></i>) + <p> Private slot called to delete a file filter entry. -</p><a NAME="EditorFilePage.on_editFileFilterButton_clicked" ID="EditorFilePage.on_editFileFilterButton_clicked"></a> +</p> +<a NAME="EditorFilePage.on_editFileFilterButton_clicked" ID="EditorFilePage.on_editFileFilterButton_clicked"></a> <h4>EditorFilePage.on_editFileFilterButton_clicked</h4> <b>on_editFileFilterButton_clicked</b>(<i></i>) + <p> Private slot called to edit a file filter entry. -</p><a NAME="EditorFilePage.on_fileFiltersList_currentItemChanged" ID="EditorFilePage.on_fileFiltersList_currentItemChanged"></a> +</p> +<a NAME="EditorFilePage.on_fileFiltersList_currentItemChanged" ID="EditorFilePage.on_fileFiltersList_currentItemChanged"></a> <h4>EditorFilePage.on_fileFiltersList_currentItemChanged</h4> <b>on_fileFiltersList_currentItemChanged</b>(<i>current, previous</i>) + <p> Private slot to set the state of the edit and delete buttons. -</p><dl> +</p> +<dl> + <dt><i>current</i></dt> <dd> new current item (QListWidgetItem) -</dd><dt><i>previous</i></dt> +</dd> +<dt><i>previous</i></dt> <dd> previous current item (QListWidgetItem) </dd> -</dl><a NAME="EditorFilePage.on_openFiltersButton_toggled" ID="EditorFilePage.on_openFiltersButton_toggled"></a> +</dl> +<a NAME="EditorFilePage.on_openFiltersButton_toggled" ID="EditorFilePage.on_openFiltersButton_toggled"></a> <h4>EditorFilePage.on_openFiltersButton_toggled</h4> <b>on_openFiltersButton_toggled</b>(<i>checked</i>) + <p> Private slot to switch the list of file filters. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> flag indicating the check state of the button (boolean) </dd> -</dl><a NAME="EditorFilePage.save" ID="EditorFilePage.save"></a> +</dl> +<a NAME="EditorFilePage.save" ID="EditorFilePage.save"></a> <h4>EditorFilePage.save</h4> <b>save</b>(<i></i>) + <p> Public slot to save the Editor File Handling configuration. </p> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="create" ID="create"></a> <h2>create</h2> <b>create</b>(<i>dlg</i>) + <p> Module function to create the configuration page. -</p><dl> +</p> +<dl> + <dt><i>dlg</i></dt> <dd> reference to the configuration dialog </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> reference to the instantiated page (ConfigurationPageBase)