src/eric7/Documentation/Source/eric7.MicroPython.UnknownDevicesDialog.html

Thu, 07 Jul 2022 11:23:56 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 07 Jul 2022 11:23:56 +0200
branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
eric7/Documentation/Source/eric7.MicroPython.UnknownDevicesDialog.html@d64760b2da50
child 10479
856476537696
permissions
-rw-r--r--

Reorganized the project structure to use the source layout in order to support up-to-date build systems with "pyproject.toml".

<!DOCTYPE html>
<html><head>
<title>eric7.MicroPython.UnknownDevicesDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.UnknownDevicesDialog</h1>

<p>
Module implementing a dialog to manage the list of unknown devices.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#UnknownDevicesDialog">UnknownDevicesDialog</a></td>
<td>Class implementing a dialog to manage the list of unknown devices.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="UnknownDevicesDialog" ID="UnknownDevicesDialog"></a>
<h2>UnknownDevicesDialog</h2>

<p>
    Class implementing a dialog to manage the list of unknown devices.
</p>
<h3>Derived from</h3>
QDialog, Ui_UnknownDevicesDialog
<h3>Class Attributes</h3>

<table>
<tr><td>DeviceDataRole</td></tr><tr><td>ModifiedRole</td></tr>
</table>
<h3>Class Methods</h3>

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

<table>

<tr>
<td><a href="#UnknownDevicesDialog.__init__">UnknownDevicesDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.__checkButtons">__checkButtons</a></td>
<td>Private slot to set the enabled state of the buttons.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.__editItem">__editItem</a></td>
<td>Private method to edit the given item.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.__isDirty">__isDirty</a></td>
<td>Private method to check, if the dialog contains unsaved data.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.__loadDevices">__loadDevices</a></td>
<td>Private method to load the list of unknown devices.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.__saveDeviceData">__saveDeviceData</a></td>
<td>Private method to save the device data.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
<td>Private slot to handle the OK button press.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td>
<td>Private slot handling the cancellation of the dialog.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.on_deleteAllButton_clicked">on_deleteAllButton_clicked</a></td>
<td>Private slot to delete all devices.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
<td>Private slot to delete the selected entries.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.on_deviceList_itemActivated">on_deviceList_itemActivated</a></td>
<td>Private slot to edit the data of the activated item.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.on_deviceList_itemSelectionChanged">on_deviceList_itemSelectionChanged</a></td>
<td>Private slot to handle a change of selected items.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.on_editButton_clicked">on_editButton_clicked</a></td>
<td>Private slot to edit the selected item.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.on_reportButton_clicked">on_reportButton_clicked</a></td>
<td>Private slot to report the data of all boards to the eric-bugs email address.</td>
</tr>
<tr>
<td><a href="#UnknownDevicesDialog.on_restoreButton_clicked">on_restoreButton_clicked</a></td>
<td>Private slot to restore the list of unknown devices.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="UnknownDevicesDialog.__init__" ID="UnknownDevicesDialog.__init__"></a>
<h4>UnknownDevicesDialog (Constructor)</h4>
<b>UnknownDevicesDialog</b>(<i>parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="UnknownDevicesDialog.__checkButtons" ID="UnknownDevicesDialog.__checkButtons"></a>
<h4>UnknownDevicesDialog.__checkButtons</h4>
<b>__checkButtons</b>(<i></i>)

<p>
        Private slot to set the enabled state of the buttons.
</p>
<a NAME="UnknownDevicesDialog.__editItem" ID="UnknownDevicesDialog.__editItem"></a>
<h4>UnknownDevicesDialog.__editItem</h4>
<b>__editItem</b>(<i>item</i>)

<p>
        Private method to edit the given item.
</p>
<dl>

<dt><i>item</i> (QListWidgetItem)</dt>
<dd>
reference to the item to be edited
</dd>
</dl>
<a NAME="UnknownDevicesDialog.__isDirty" ID="UnknownDevicesDialog.__isDirty"></a>
<h4>UnknownDevicesDialog.__isDirty</h4>
<b>__isDirty</b>(<i></i>)

<p>
        Private method to check, if the dialog contains unsaved data.
</p>
<dl>
<dt>Return:</dt>
<dd>
flag indicating the presence of unsaved data
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="UnknownDevicesDialog.__loadDevices" ID="UnknownDevicesDialog.__loadDevices"></a>
<h4>UnknownDevicesDialog.__loadDevices</h4>
<b>__loadDevices</b>(<i></i>)

<p>
        Private method to load the list of unknown devices.
</p>
<a NAME="UnknownDevicesDialog.__saveDeviceData" ID="UnknownDevicesDialog.__saveDeviceData"></a>
<h4>UnknownDevicesDialog.__saveDeviceData</h4>
<b>__saveDeviceData</b>(<i></i>)

<p>
        Private method to save the device data.
</p>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a successful save
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="UnknownDevicesDialog.on_buttonBox_accepted" ID="UnknownDevicesDialog.on_buttonBox_accepted"></a>
<h4>UnknownDevicesDialog.on_buttonBox_accepted</h4>
<b>on_buttonBox_accepted</b>(<i></i>)

<p>
        Private slot to handle the OK button press.
</p>
<p>
        This action saves the edited list to the preferences store.
</p>
<a NAME="UnknownDevicesDialog.on_buttonBox_rejected" ID="UnknownDevicesDialog.on_buttonBox_rejected"></a>
<h4>UnknownDevicesDialog.on_buttonBox_rejected</h4>
<b>on_buttonBox_rejected</b>(<i></i>)

<p>
        Private slot handling the cancellation of the dialog.
</p>
<a NAME="UnknownDevicesDialog.on_deleteAllButton_clicked" ID="UnknownDevicesDialog.on_deleteAllButton_clicked"></a>
<h4>UnknownDevicesDialog.on_deleteAllButton_clicked</h4>
<b>on_deleteAllButton_clicked</b>(<i></i>)

<p>
        Private slot to delete all devices.
</p>
<a NAME="UnknownDevicesDialog.on_deleteButton_clicked" ID="UnknownDevicesDialog.on_deleteButton_clicked"></a>
<h4>UnknownDevicesDialog.on_deleteButton_clicked</h4>
<b>on_deleteButton_clicked</b>(<i></i>)

<p>
        Private slot to delete the selected entries.
</p>
<a NAME="UnknownDevicesDialog.on_deviceList_itemActivated" ID="UnknownDevicesDialog.on_deviceList_itemActivated"></a>
<h4>UnknownDevicesDialog.on_deviceList_itemActivated</h4>
<b>on_deviceList_itemActivated</b>(<i>item</i>)

<p>
        Private slot to edit the data of the activated item.
</p>
<dl>

<dt><i>item</i> (QListWidgetItem)</dt>
<dd>
reference to the activated item
</dd>
</dl>
<a NAME="UnknownDevicesDialog.on_deviceList_itemSelectionChanged" ID="UnknownDevicesDialog.on_deviceList_itemSelectionChanged"></a>
<h4>UnknownDevicesDialog.on_deviceList_itemSelectionChanged</h4>
<b>on_deviceList_itemSelectionChanged</b>(<i></i>)

<p>
        Private slot to handle a change of selected items.
</p>
<a NAME="UnknownDevicesDialog.on_editButton_clicked" ID="UnknownDevicesDialog.on_editButton_clicked"></a>
<h4>UnknownDevicesDialog.on_editButton_clicked</h4>
<b>on_editButton_clicked</b>(<i></i>)

<p>
        Private slot to edit the selected item.
</p>
<a NAME="UnknownDevicesDialog.on_reportButton_clicked" ID="UnknownDevicesDialog.on_reportButton_clicked"></a>
<h4>UnknownDevicesDialog.on_reportButton_clicked</h4>
<b>on_reportButton_clicked</b>(<i></i>)

<p>
        Private slot to report the data of all boards to the eric-bugs email
        address.
</p>
<a NAME="UnknownDevicesDialog.on_restoreButton_clicked" ID="UnknownDevicesDialog.on_restoreButton_clicked"></a>
<h4>UnknownDevicesDialog.on_restoreButton_clicked</h4>
<b>on_restoreButton_clicked</b>(<i></i>)

<p>
        Private slot to restore the list of unknown devices.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial