tip/src/eric7/Documentation/Source/eric7.Project.FiletypeAssociationDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Project.FiletypeAssociationDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Project.FiletypeAssociationDialog</h1>
<p>
Module implementing a dialog to enter filetype associations for the project.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#FiletypeAssociationDialog">FiletypeAssociationDialog</a></td>
<td>Class implementing a dialog to enter filetype associations for the project.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="FiletypeAssociationDialog" ID="FiletypeAssociationDialog"></a>
<h2>FiletypeAssociationDialog</h2>
<p>
    Class implementing a dialog to enter filetype associations for the project.
</p>

<h3>Derived from</h3>
QDialog, Ui_FiletypeAssociationDialog
<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="#FiletypeAssociationDialog.__init__">FiletypeAssociationDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#FiletypeAssociationDialog.__createItem">__createItem</a></td>
<td>Private slot to create a new entry in the association list.</td>
</tr>
<tr>
<td><a href="#FiletypeAssociationDialog.__reformat">__reformat</a></td>
<td>Private method to reformat the tree.</td>
</tr>
<tr>
<td><a href="#FiletypeAssociationDialog.__resort">__resort</a></td>
<td>Private method to resort the tree.</td>
</tr>
<tr>
<td><a href="#FiletypeAssociationDialog.__updateAddButton">__updateAddButton</a></td>
<td>Private method to update the enabled state of the 'add' button.</td>
</tr>
<tr>
<td><a href="#FiletypeAssociationDialog.getData">getData</a></td>
<td>Public method to get the entered associations into.</td>
</tr>
<tr>
<td><a href="#FiletypeAssociationDialog.on_addAssociationButton_clicked">on_addAssociationButton_clicked</a></td>
<td>Private slot to add the association displayed to the list.</td>
</tr>
<tr>
<td><a href="#FiletypeAssociationDialog.on_deleteAssociationButton_clicked">on_deleteAssociationButton_clicked</a></td>
<td>Private slot to delete the currently selected association of the listbox.</td>
</tr>
<tr>
<td><a href="#FiletypeAssociationDialog.on_filePatternEdit_textChanged">on_filePatternEdit_textChanged</a></td>
<td>Private slot to handle the textChanged signal of the pattern lineedit.</td>
</tr>
<tr>
<td><a href="#FiletypeAssociationDialog.on_filetypeAssociationList_itemSelectionChanged">on_filetypeAssociationList_itemSelectionChanged</a></td>
<td>Private slot to handle a change of the selected item.</td>
</tr>
<tr>
<td><a href="#FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged">on_filetypeCombo_currentIndexChanged</a></td>
<td>Private slot handling the selection of a file type.</td>
</tr>
</table>

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


<a NAME="FiletypeAssociationDialog.__init__" ID="FiletypeAssociationDialog.__init__"></a>
<h4>FiletypeAssociationDialog (Constructor)</h4>
<b>FiletypeAssociationDialog</b>(<i>project, fileTypesDict, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
<dt><i>fileTypesDict</i> (dict)</dt>
<dd>
dictionary containing the file type associations
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="FiletypeAssociationDialog.__createItem" ID="FiletypeAssociationDialog.__createItem"></a>
<h4>FiletypeAssociationDialog.__createItem</h4>
<b>__createItem</b>(<i>pattern, filetypeStr, fileCategory</i>)
<p>
        Private slot to create a new entry in the association list.
</p>

<dl>

<dt><i>pattern</i> (str)</dt>
<dd>
pattern of the entry
</dd>
<dt><i>filetypeStr</i> (str)</dt>
<dd>
file type user string of the entry
</dd>
<dt><i>fileCategory</i> (str)</dt>
<dd>
category of the file
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the newly generated entry
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QTreeWidgetItem
</dd>
</dl>
<a NAME="FiletypeAssociationDialog.__reformat" ID="FiletypeAssociationDialog.__reformat"></a>
<h4>FiletypeAssociationDialog.__reformat</h4>
<b>__reformat</b>(<i></i>)
<p>
        Private method to reformat the tree.
</p>

<a NAME="FiletypeAssociationDialog.__resort" ID="FiletypeAssociationDialog.__resort"></a>
<h4>FiletypeAssociationDialog.__resort</h4>
<b>__resort</b>(<i></i>)
<p>
        Private method to resort the tree.
</p>

<a NAME="FiletypeAssociationDialog.__updateAddButton" ID="FiletypeAssociationDialog.__updateAddButton"></a>
<h4>FiletypeAssociationDialog.__updateAddButton</h4>
<b>__updateAddButton</b>(<i></i>)
<p>
        Private method to update the enabled state of the 'add' button.
</p>

<a NAME="FiletypeAssociationDialog.getData" ID="FiletypeAssociationDialog.getData"></a>
<h4>FiletypeAssociationDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to get the entered associations into.
</p>

<dl>
<dt>Return:</dt>
<dd>
dictionary containing the defined file type associations
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="FiletypeAssociationDialog.on_addAssociationButton_clicked" ID="FiletypeAssociationDialog.on_addAssociationButton_clicked"></a>
<h4>FiletypeAssociationDialog.on_addAssociationButton_clicked</h4>
<b>on_addAssociationButton_clicked</b>(<i></i>)
<p>
        Private slot to add the association displayed to the list.
</p>

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

<a NAME="FiletypeAssociationDialog.on_filePatternEdit_textChanged" ID="FiletypeAssociationDialog.on_filePatternEdit_textChanged"></a>
<h4>FiletypeAssociationDialog.on_filePatternEdit_textChanged</h4>
<b>on_filePatternEdit_textChanged</b>(<i>txt</i>)
<p>
        Private slot to handle the textChanged signal of the pattern lineedit.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text of the line edit
</dd>
</dl>
<a NAME="FiletypeAssociationDialog.on_filetypeAssociationList_itemSelectionChanged" ID="FiletypeAssociationDialog.on_filetypeAssociationList_itemSelectionChanged"></a>
<h4>FiletypeAssociationDialog.on_filetypeAssociationList_itemSelectionChanged</h4>
<b>on_filetypeAssociationList_itemSelectionChanged</b>(<i></i>)
<p>
        Private slot to handle a change of the selected item.
</p>

<a NAME="FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged" ID="FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged"></a>
<h4>FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged</h4>
<b>on_filetypeCombo_currentIndexChanged</b>(<i>index</i>)
<p>
        Private slot handling the selection of a file type.
</p>

<dl>

<dt><i>index</i> (int)</dt>
<dd>
index of the selected entry
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>