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

<!DOCTYPE html>
<html><head>
<title>eric7.Preferences.ConfigurationPages.IconsPage</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Preferences.ConfigurationPages.IconsPage</h1>
<p>
Module implementing the Icons configuration page.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#IconsPage">IconsPage</a></td>
<td>Class implementing the Icons 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 />
<a NAME="IconsPage" ID="IconsPage"></a>
<h2>IconsPage</h2>
<p>
    Class implementing the Icons configuration page.
</p>

<h3>Derived from</h3>
ConfigurationPageBase, Ui_IconsPage
<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="#IconsPage.__init__">IconsPage</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#IconsPage.__getSelectedDefaultIconsPath">__getSelectedDefaultIconsPath</a></td>
<td>Private method to determine the selected default icons path.</td>
</tr>
<tr>
<td><a href="#IconsPage.on_addIconDirectoryButton_clicked">on_addIconDirectoryButton_clicked</a></td>
<td>Private slot to add the icon directory displayed to the listbox.</td>
</tr>
<tr>
<td><a href="#IconsPage.on_deleteIconDirectoryButton_clicked">on_deleteIconDirectoryButton_clicked</a></td>
<td>Private slot to delete the currently selected directory of the listbox.</td>
</tr>
<tr>
<td><a href="#IconsPage.on_downButton_clicked">on_downButton_clicked</a></td>
<td>Private slot called to move the selected item down in the list.</td>
</tr>
<tr>
<td><a href="#IconsPage.on_iconDirectoryList_currentRowChanged">on_iconDirectoryList_currentRowChanged</a></td>
<td>Private slot to handle the currentRowChanged signal of the icons directory list.</td>
</tr>
<tr>
<td><a href="#IconsPage.on_iconDirectoryPicker_textChanged">on_iconDirectoryPicker_textChanged</a></td>
<td>Private slot to handle the textChanged signal of the directory picker.</td>
</tr>
<tr>
<td><a href="#IconsPage.on_showDefaultIconsButton_clicked">on_showDefaultIconsButton_clicked</a></td>
<td>Private slot to display a preview of the selected default icons.</td>
</tr>
<tr>
<td><a href="#IconsPage.on_showIconsButton_clicked">on_showIconsButton_clicked</a></td>
<td>Private slot to display a preview of an icons directory.</td>
</tr>
<tr>
<td><a href="#IconsPage.on_upButton_clicked">on_upButton_clicked</a></td>
<td>Private slot called to move the selected item up in the list.</td>
</tr>
<tr>
<td><a href="#IconsPage.save">save</a></td>
<td>Public slot to save the Icons configuration.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="IconsPage.__init__" ID="IconsPage.__init__"></a>
<h4>IconsPage (Constructor)</h4>
<b>IconsPage</b>(<i></i>)
<p>
        Constructor
</p>

<a NAME="IconsPage.__getSelectedDefaultIconsPath" ID="IconsPage.__getSelectedDefaultIconsPath"></a>
<h4>IconsPage.__getSelectedDefaultIconsPath</h4>
<b>__getSelectedDefaultIconsPath</b>(<i></i>)
<p>
        Private method to determine the selected default icons path.
</p>

<dl>
<dt>Return:</dt>
<dd>
selected default icons path
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="IconsPage.on_addIconDirectoryButton_clicked" ID="IconsPage.on_addIconDirectoryButton_clicked"></a>
<h4>IconsPage.on_addIconDirectoryButton_clicked</h4>
<b>on_addIconDirectoryButton_clicked</b>(<i></i>)
<p>
        Private slot to add the icon directory displayed to the listbox.
</p>

<a NAME="IconsPage.on_deleteIconDirectoryButton_clicked" ID="IconsPage.on_deleteIconDirectoryButton_clicked"></a>
<h4>IconsPage.on_deleteIconDirectoryButton_clicked</h4>
<b>on_deleteIconDirectoryButton_clicked</b>(<i></i>)
<p>
        Private slot to delete the currently selected directory of the listbox.
</p>

<a NAME="IconsPage.on_downButton_clicked" ID="IconsPage.on_downButton_clicked"></a>
<h4>IconsPage.on_downButton_clicked</h4>
<b>on_downButton_clicked</b>(<i></i>)
<p>
        Private slot called to move the selected item down in the list.
</p>

<a NAME="IconsPage.on_iconDirectoryList_currentRowChanged" ID="IconsPage.on_iconDirectoryList_currentRowChanged"></a>
<h4>IconsPage.on_iconDirectoryList_currentRowChanged</h4>
<b>on_iconDirectoryList_currentRowChanged</b>(<i>row</i>)
<p>
        Private slot to handle the currentRowChanged signal of the icons
        directory list.
</p>

<dl>

<dt><i>row</i> (int)</dt>
<dd>
the current row
</dd>
</dl>
<a NAME="IconsPage.on_iconDirectoryPicker_textChanged" ID="IconsPage.on_iconDirectoryPicker_textChanged"></a>
<h4>IconsPage.on_iconDirectoryPicker_textChanged</h4>
<b>on_iconDirectoryPicker_textChanged</b>(<i>txt</i>)
<p>
        Private slot to handle the textChanged signal of the directory picker.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
the text of the directory picker
</dd>
</dl>
<a NAME="IconsPage.on_showDefaultIconsButton_clicked" ID="IconsPage.on_showDefaultIconsButton_clicked"></a>
<h4>IconsPage.on_showDefaultIconsButton_clicked</h4>
<b>on_showDefaultIconsButton_clicked</b>(<i></i>)
<p>
        Private slot to display a preview of the selected default icons.
</p>

<a NAME="IconsPage.on_showIconsButton_clicked" ID="IconsPage.on_showIconsButton_clicked"></a>
<h4>IconsPage.on_showIconsButton_clicked</h4>
<b>on_showIconsButton_clicked</b>(<i></i>)
<p>
        Private slot to display a preview of an icons directory.
</p>

<a NAME="IconsPage.on_upButton_clicked" ID="IconsPage.on_upButton_clicked"></a>
<h4>IconsPage.on_upButton_clicked</h4>
<b>on_upButton_clicked</b>(<i></i>)
<p>
        Private slot called to move the selected item up in the list.
</p>

<a NAME="IconsPage.save" ID="IconsPage.save"></a>
<h4>IconsPage.save</h4>
<b>save</b>(<i></i>)
<p>
        Public slot to save the Icons configuration.
</p>

<div align="right"><a href="#top">Up</a></div>
<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>

<dt><i>_dlg</i> (ConfigurationDialog)</dt>
<dd>
reference to the configuration dialog (unused)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the instantiated page
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
ConfigurationPageBase
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>