src/eric7/Documentation/Source/eric7.EricWidgets.EricToolBarManager.html

branch
eric7
changeset 10423
299802979277
parent 10278
e26fa3b06f4f
child 10479
856476537696
diff -r e28b89693f37 -r 299802979277 src/eric7/Documentation/Source/eric7.EricWidgets.EricToolBarManager.html
--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricToolBarManager.html	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricToolBarManager.html	Tue Dec 19 19:57:08 2023 +0100
@@ -210,13 +210,13 @@
 </p>
 <dl>
 
-<dt><i>ui</i></dt>
+<dt><i>ui</i> (UI.UserInterface)</dt>
 <dd>
-reference to the user interface object (UI.UserInterface)
+reference to the user interface object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object
 </dd>
 </dl>
 <a NAME="EricToolBarManager.__findAction" ID="EricToolBarManager.__findAction"></a>
@@ -228,15 +228,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the action to search for (string)
+name of the action to search for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the action (QAction)
+reference to the action
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QAction
 </dd>
 </dl>
 <a NAME="EricToolBarManager.__findDefaultToolBar" ID="EricToolBarManager.__findDefaultToolBar"></a>
@@ -248,15 +254,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the default toolbar to search for (string)
+name of the default toolbar to search for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the default toolbar (QToolBar)
+reference to the default toolbar
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QToolBar
 </dd>
 </dl>
 <a NAME="EricToolBarManager.__toolBarByName" ID="EricToolBarManager.__toolBarByName"></a>
@@ -268,15 +280,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-object name of the toolbar (string)
+object name of the toolbar
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the toolbar (QToolBar)
+reference to the toolbar
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QToolBar
 </dd>
 </dl>
 <a NAME="EricToolBarManager.actionById" ID="EricToolBarManager.actionById"></a>
@@ -288,15 +306,21 @@
 </p>
 <dl>
 
-<dt><i>aID</i></dt>
+<dt><i>aID</i> (int)</dt>
 <dd>
-id of the action object (integer)
+id of the action object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the action (QAction)
+reference to the action
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QAction
 </dd>
 </dl>
 <a NAME="EricToolBarManager.addAction" ID="EricToolBarManager.addAction"></a>
@@ -308,13 +332,13 @@
 </p>
 <dl>
 
-<dt><i>action</i></dt>
+<dt><i>action</i> (QAction)</dt>
 <dd>
-reference to the action to be managed (QAction)
+reference to the action to be managed
 </dd>
-<dt><i>category</i></dt>
+<dt><i>category</i> (str)</dt>
 <dd>
-category for the toolbar (string)
+category for the toolbar
 </dd>
 </dl>
 <a NAME="EricToolBarManager.addActions" ID="EricToolBarManager.addActions"></a>
@@ -344,13 +368,13 @@
 </p>
 <dl>
 
-<dt><i>toolBar</i></dt>
+<dt><i>toolBar</i> (QToolBar)</dt>
 <dd>
-reference to the toolbar to be managed (QToolBar)
+reference to the toolbar to be managed
 </dd>
-<dt><i>category</i></dt>
+<dt><i>category</i> (str)</dt>
 <dd>
-category for the toolbar (string)
+category for the toolbar
 </dd>
 </dl>
 <a NAME="EricToolBarManager.categories" ID="EricToolBarManager.categories"></a>
@@ -363,7 +387,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of categories (list of string)
+list of categories
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="EricToolBarManager.categoryActions" ID="EricToolBarManager.categoryActions"></a>
@@ -375,15 +405,21 @@
 </p>
 <dl>
 
-<dt><i>category</i></dt>
+<dt><i>category</i> (str)</dt>
 <dd>
-category for the actions (string)
+category for the actions
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of actions (list of QAction)
+list of actions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QAction
 </dd>
 </dl>
 <a NAME="EricToolBarManager.createToolBar" ID="EricToolBarManager.createToolBar"></a>
@@ -395,19 +431,25 @@
 </p>
 <dl>
 
-<dt><i>title</i></dt>
+<dt><i>title</i> (str)</dt>
 <dd>
-title to be used for the toolbar (string)
+title to be used for the toolbar
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-optional name for the new toolbar (string)
+optional name for the new toolbar
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the created toolbar (QToolBar)
+reference to the created toolbar
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QToolBar
 </dd>
 </dl>
 <a NAME="EricToolBarManager.defaultToolBarActions" ID="EricToolBarManager.defaultToolBarActions"></a>
@@ -419,15 +461,21 @@
 </p>
 <dl>
 
-<dt><i>tbID</i></dt>
+<dt><i>tbID</i> (int)</dt>
 <dd>
-id of the default toolbar object (integer)
+id of the default toolbar object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of actions (list of QAction)
+list of actions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QAction
 </dd>
 </dl>
 <a NAME="EricToolBarManager.defaultToolBars" ID="EricToolBarManager.defaultToolBars"></a>
@@ -440,7 +488,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of all default toolbars (list of QToolBar)
+list of all default toolbars
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QToolBar
 </dd>
 </dl>
 <a NAME="EricToolBarManager.deleteToolBar" ID="EricToolBarManager.deleteToolBar"></a>
@@ -452,9 +506,9 @@
 </p>
 <dl>
 
-<dt><i>toolBar</i></dt>
+<dt><i>toolBar</i> (QToolBar)</dt>
 <dd>
-reference to the toolbar to be managed (QToolBar)
+reference to the toolbar to be managed
 </dd>
 </dl>
 <a NAME="EricToolBarManager.isDefaultToolBar" ID="EricToolBarManager.isDefaultToolBar"></a>
@@ -466,15 +520,21 @@
 </p>
 <dl>
 
-<dt><i>toolBar</i></dt>
+<dt><i>toolBar</i> (QToolBar)</dt>
 <dd>
-reference to the toolbar to be checked (QToolBar)
+reference to the toolbar to be checked
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating an added toolbar (boolean)
+flag indicating an added toolbar
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="EricToolBarManager.isWidgetAction" ID="EricToolBarManager.isWidgetAction"></a>
@@ -486,15 +546,21 @@
 </p>
 <dl>
 
-<dt><i>action</i></dt>
+<dt><i>action</i> (QAction)</dt>
 <dd>
-reference to the action to be checked (QAction)
+reference to the action to be checked
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a widget action (boolean)
+flag indicating a widget action
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="EricToolBarManager.mainWindow" ID="EricToolBarManager.mainWindow"></a>
@@ -507,7 +573,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the main window (QMainWindow)
+reference to the main window
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMainWindow
 </dd>
 </dl>
 <a NAME="EricToolBarManager.preferencesChanged" ID="EricToolBarManager.preferencesChanged"></a>
@@ -526,9 +598,9 @@
 </p>
 <dl>
 
-<dt><i>action</i></dt>
+<dt><i>action</i> (QAction)</dt>
 <dd>
-reference to the action to be removed (QAction)
+reference to the action to be removed
 </dd>
 </dl>
 <a NAME="EricToolBarManager.removeCategoryActions" ID="EricToolBarManager.removeCategoryActions"></a>
@@ -540,9 +612,9 @@
 </p>
 <dl>
 
-<dt><i>category</i></dt>
+<dt><i>category</i> (str)</dt>
 <dd>
-category for the actions (string)
+category for the actions
 </dd>
 </dl>
 <a NAME="EricToolBarManager.removeToolBar" ID="EricToolBarManager.removeToolBar"></a>
@@ -554,9 +626,9 @@
 </p>
 <dl>
 
-<dt><i>toolBar</i></dt>
+<dt><i>toolBar</i> (QToolBar)</dt>
 <dd>
-reference to the toolbar to be removed (QToolBar)
+reference to the toolbar to be removed
 </dd>
 </dl>
 <a NAME="EricToolBarManager.removeWidgetActions" ID="EricToolBarManager.removeWidgetActions"></a>
@@ -568,7 +640,7 @@
 </p>
 <dl>
 
-<dt><i>actions</i></dt>
+<dt><i>actions</i> (dict)</dt>
 <dd>
 dictionary with toolbar id as key and
             a list of widget actions as value
@@ -583,13 +655,13 @@
 </p>
 <dl>
 
-<dt><i>toolBar</i></dt>
+<dt><i>toolBar</i> (QToolBar)</dt>
 <dd>
-reference to the toolbar to be managed (QToolBar)
+reference to the toolbar to be managed
 </dd>
-<dt><i>title</i></dt>
+<dt><i>title</i> (str)</dt>
 <dd>
-title to be used for the toolbar (string)
+title to be used for the toolbar
 </dd>
 </dl>
 <a NAME="EricToolBarManager.resetAllToolBars" ID="EricToolBarManager.resetAllToolBars"></a>
@@ -608,9 +680,9 @@
 </p>
 <dl>
 
-<dt><i>toolBar</i></dt>
+<dt><i>toolBar</i> (QToolBar)</dt>
 <dd>
-reference to the toolbar to configure (QToolBar)
+reference to the toolbar to configure
 </dd>
 </dl>
 <a NAME="EricToolBarManager.restoreState" ID="EricToolBarManager.restoreState"></a>
@@ -622,19 +694,25 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (QByteArray)</dt>
 <dd>
-byte array containing the saved state (QByteArray)
+byte array containing the saved state
 </dd>
-<dt><i>version</i></dt>
+<dt><i>version</i> (int)</dt>
 <dd>
-version number stored with the data (integer)
+version number stored with the data
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="EricToolBarManager.saveState" ID="EricToolBarManager.saveState"></a>
@@ -646,15 +724,21 @@
 </p>
 <dl>
 
-<dt><i>version</i></dt>
+<dt><i>version</i> (int)</dt>
 <dd>
-version number stored with the data (integer)
+version number stored with the data
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-saved state as a byte array (QByteArray)
+saved state as a byte array
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QByteArray
 </dd>
 </dl>
 <a NAME="EricToolBarManager.setMainWindow" ID="EricToolBarManager.setMainWindow"></a>
@@ -666,9 +750,9 @@
 </p>
 <dl>
 
-<dt><i>mainWindow</i></dt>
+<dt><i>mainWindow</i> (QMainWindow)</dt>
 <dd>
-reference to the main window (QMainWindow)
+reference to the main window
 </dd>
 </dl>
 <a NAME="EricToolBarManager.setToolBar" ID="EricToolBarManager.setToolBar"></a>
@@ -680,13 +764,13 @@
 </p>
 <dl>
 
-<dt><i>toolBar</i></dt>
+<dt><i>toolBar</i> (QToolBar)</dt>
 <dd>
-reference to the toolbar to configure (QToolBar)
+reference to the toolbar to configure
 </dd>
-<dt><i>actions</i></dt>
+<dt><i>actions</i> (list of QAction)</dt>
 <dd>
-list of actions to be set (list of QAction)
+list of actions to be set
 </dd>
 </dl>
 <a NAME="EricToolBarManager.setToolBars" ID="EricToolBarManager.setToolBars"></a>
@@ -698,7 +782,7 @@
 </p>
 <dl>
 
-<dt><i>toolBars</i></dt>
+<dt><i>toolBars</i> (dict)</dt>
 <dd>
 dictionary with toolbar id as key and
             a list of actions as value
@@ -713,15 +797,21 @@
 </p>
 <dl>
 
-<dt><i>tbID</i></dt>
+<dt><i>tbID</i> (int)</dt>
 <dd>
-id of the toolbar object (integer)
+id of the toolbar object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of actions (list of QAction)
+list of actions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QAction
 </dd>
 </dl>
 <a NAME="EricToolBarManager.toolBarById" ID="EricToolBarManager.toolBarById"></a>
@@ -733,15 +823,21 @@
 </p>
 <dl>
 
-<dt><i>tbID</i></dt>
+<dt><i>tbID</i> (int)</dt>
 <dd>
-id of the toolbar object (integer)
+id of the toolbar object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the toolbar (QToolBar)
+reference to the toolbar
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QToolBar
 </dd>
 </dl>
 <a NAME="EricToolBarManager.toolBarWidgetAction" ID="EricToolBarManager.toolBarWidgetAction"></a>
@@ -753,15 +849,21 @@
 </p>
 <dl>
 
-<dt><i>action</i></dt>
+<dt><i>action</i> (QAction)</dt>
 <dd>
-widget action to check for (QAction)
+widget action to check for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the toolbar containing action (QToolBar)
+reference to the toolbar containing action
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QToolBar
 </dd>
 </dl>
 <a NAME="EricToolBarManager.toolBars" ID="EricToolBarManager.toolBars"></a>
@@ -774,7 +876,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of all toolbars (list of QToolBar)
+list of all toolbars
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QToolBar
 </dd>
 </dl>
 <a NAME="EricToolBarManager.toolBarsActions" ID="EricToolBarManager.toolBarsActions"></a>
@@ -791,6 +899,12 @@
             of actions as values
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial