eric7/Documentation/Source/eric7.Preferences.ToolGroupConfigurationDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.Preferences.ToolGroupConfigurationDialog.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,230 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Preferences.ToolGroupConfigurationDialog</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Preferences.ToolGroupConfigurationDialog</h1>
+
+<p>
+Module implementing a configuration dialog for the tools menu.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#ToolGroupConfigurationDialog">ToolGroupConfigurationDialog</a></td>
+<td>Class implementing a configuration dialog for the tool groups.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="ToolGroupConfigurationDialog" ID="ToolGroupConfigurationDialog"></a>
+<h2>ToolGroupConfigurationDialog</h2>
+
+<p>
+    Class implementing a configuration dialog for the tool groups.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_ToolGroupConfigurationDialog
+<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="#ToolGroupConfigurationDialog.__init__">ToolGroupConfigurationDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#ToolGroupConfigurationDialog.__swap">__swap</a></td>
+<td>Private method used two swap two list entries given by their index.</td>
+</tr>
+<tr>
+<td><a href="#ToolGroupConfigurationDialog.getToolGroups">getToolGroups</a></td>
+<td>Public method to retrieve the tool groups.</td>
+</tr>
+<tr>
+<td><a href="#ToolGroupConfigurationDialog.on_addButton_clicked">on_addButton_clicked</a></td>
+<td>Private slot to add a new entry.</td>
+</tr>
+<tr>
+<td><a href="#ToolGroupConfigurationDialog.on_changeButton_clicked">on_changeButton_clicked</a></td>
+<td>Private slot to change an entry.</td>
+</tr>
+<tr>
+<td><a href="#ToolGroupConfigurationDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
+<td>Private slot to delete the selected entry.</td>
+</tr>
+<tr>
+<td><a href="#ToolGroupConfigurationDialog.on_downButton_clicked">on_downButton_clicked</a></td>
+<td>Private slot to move an entry down in the list.</td>
+</tr>
+<tr>
+<td><a href="#ToolGroupConfigurationDialog.on_groupsList_currentRowChanged">on_groupsList_currentRowChanged</a></td>
+<td>Private slot to set the lineedits depending on the selected entry.</td>
+</tr>
+<tr>
+<td><a href="#ToolGroupConfigurationDialog.on_newButton_clicked">on_newButton_clicked</a></td>
+<td>Private slot to clear all entry fields.</td>
+</tr>
+<tr>
+<td><a href="#ToolGroupConfigurationDialog.on_upButton_clicked">on_upButton_clicked</a></td>
+<td>Private slot to move an entry up in the list.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="ToolGroupConfigurationDialog.__init__" ID="ToolGroupConfigurationDialog.__init__"></a>
+<h4>ToolGroupConfigurationDialog (Constructor)</h4>
+<b>ToolGroupConfigurationDialog</b>(<i>toolGroups, currentGroup, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>toolGroups</i></dt>
+<dd>
+list of configured tool groups
+</dd>
+<dt><i>currentGroup</i></dt>
+<dd>
+number of the active group (integer)
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+parent widget (QWidget)
+</dd>
+</dl>
+<a NAME="ToolGroupConfigurationDialog.__swap" ID="ToolGroupConfigurationDialog.__swap"></a>
+<h4>ToolGroupConfigurationDialog.__swap</h4>
+<b>__swap</b>(<i>itm1, itm2</i>)
+
+<p>
+        Private method used two swap two list entries given by their index.
+</p>
+<dl>
+
+<dt><i>itm1</i></dt>
+<dd>
+index of first entry (int)
+</dd>
+<dt><i>itm2</i></dt>
+<dd>
+index of second entry (int)
+</dd>
+</dl>
+<a NAME="ToolGroupConfigurationDialog.getToolGroups" ID="ToolGroupConfigurationDialog.getToolGroups"></a>
+<h4>ToolGroupConfigurationDialog.getToolGroups</h4>
+<b>getToolGroups</b>(<i></i>)
+
+<p>
+        Public method to retrieve the tool groups.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+a list of lists containing the group name and the
+            tool group entries
+</dd>
+</dl>
+<a NAME="ToolGroupConfigurationDialog.on_addButton_clicked" ID="ToolGroupConfigurationDialog.on_addButton_clicked"></a>
+<h4>ToolGroupConfigurationDialog.on_addButton_clicked</h4>
+<b>on_addButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to add a new entry.
+</p>
+<a NAME="ToolGroupConfigurationDialog.on_changeButton_clicked" ID="ToolGroupConfigurationDialog.on_changeButton_clicked"></a>
+<h4>ToolGroupConfigurationDialog.on_changeButton_clicked</h4>
+<b>on_changeButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to change an entry.
+</p>
+<a NAME="ToolGroupConfigurationDialog.on_deleteButton_clicked" ID="ToolGroupConfigurationDialog.on_deleteButton_clicked"></a>
+<h4>ToolGroupConfigurationDialog.on_deleteButton_clicked</h4>
+<b>on_deleteButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to delete the selected entry.
+</p>
+<a NAME="ToolGroupConfigurationDialog.on_downButton_clicked" ID="ToolGroupConfigurationDialog.on_downButton_clicked"></a>
+<h4>ToolGroupConfigurationDialog.on_downButton_clicked</h4>
+<b>on_downButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to move an entry down in the list.
+</p>
+<a NAME="ToolGroupConfigurationDialog.on_groupsList_currentRowChanged" ID="ToolGroupConfigurationDialog.on_groupsList_currentRowChanged"></a>
+<h4>ToolGroupConfigurationDialog.on_groupsList_currentRowChanged</h4>
+<b>on_groupsList_currentRowChanged</b>(<i>row</i>)
+
+<p>
+        Private slot to set the lineedits depending on the selected entry.
+</p>
+<dl>
+
+<dt><i>row</i></dt>
+<dd>
+the row of the selected entry (integer)
+</dd>
+</dl>
+<a NAME="ToolGroupConfigurationDialog.on_newButton_clicked" ID="ToolGroupConfigurationDialog.on_newButton_clicked"></a>
+<h4>ToolGroupConfigurationDialog.on_newButton_clicked</h4>
+<b>on_newButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to clear all entry fields.
+</p>
+<a NAME="ToolGroupConfigurationDialog.on_upButton_clicked" ID="ToolGroupConfigurationDialog.on_upButton_clicked"></a>
+<h4>ToolGroupConfigurationDialog.on_upButton_clicked</h4>
+<b>on_upButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to move an entry up in the list.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial