diff -r 31463df17fd5 -r b5c84934de9c Documentation/Source/eric5.E4Gui.E4ToolBarManager.html --- a/Documentation/Source/eric5.E4Gui.E4ToolBarManager.html Tue Jan 12 18:39:15 2010 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,558 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' -'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> -<html><head> -<title>eric5.E4Gui.E4ToolBarManager</title> -<style> -body { - background:white; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #4FA4FF; } -h2 { color: white; background: #4FA4FF; } -h3 { color: white; background: #00557F; } -h4 { color: white; background: #00557F; } - -a { color: #AA5500; } - -</style> -</head> -<body><a NAME="top" ID="top"></a> -<h1>eric5.E4Gui.E4ToolBarManager</h1> -<p> -Module implementing a toolbar manager class. -</p> -<h3>Global Attributes</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> -<table> -<tr> -<td><a href="#E4ToolBarManager">E4ToolBarManager</a></td> -<td>Class implementing a toolbar manager.</td> -</tr> -</table> -<h3>Functions</h3> -<table> -<tr><td>None</td></tr> -</table> -<hr /><hr /> -<a NAME="E4ToolBarManager" ID="E4ToolBarManager"></a> -<h2>E4ToolBarManager</h2> -<p> - Class implementing a toolbar manager. -</p> -<h3>Derived from</h3> -QObject -<h3>Class Attributes</h3> -<table> -<tr><td>CustomToolBarMarker</td></tr><tr><td>ToolBarMarker</td></tr><tr><td>VersionMarker</td></tr> -</table> -<h3>Methods</h3> -<table> -<tr> -<td><a href="#E4ToolBarManager.__init__">E4ToolBarManager</a></td> -<td>Constructor</td> -</tr><tr> -<td><a href="#E4ToolBarManager.__findAction">__findAction</a></td> -<td>Private method to find an action by name.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.__findDefaultToolBar">__findDefaultToolBar</a></td> -<td>Private method to find a default toolbar by name.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.__toolBarByName">__toolBarByName</a></td> -<td>Private slot to get a toolbar by it's object name.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.actionById">actionById</a></td> -<td>Public method to get an action given it's id.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.addAction">addAction</a></td> -<td>Public method to add an action to be managed.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.addToolBar">addToolBar</a></td> -<td>Public method to add a toolbar to be managed.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.categories">categories</a></td> -<td>Public method to get the list of categories.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.categoryActions">categoryActions</a></td> -<td>Public method to get the actions belonging to a category.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.createToolBar">createToolBar</a></td> -<td>Public method to create a custom toolbar.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.defaultToolBarActions">defaultToolBarActions</a></td> -<td>Public method to get a default toolbar's actions given it's id.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.defaultToolBars">defaultToolBars</a></td> -<td>Public method to get all toolbars added with addToolBar().</td> -</tr><tr> -<td><a href="#E4ToolBarManager.deleteToolBar">deleteToolBar</a></td> -<td>Public method to remove a custom toolbar created with createToolBar().</td> -</tr><tr> -<td><a href="#E4ToolBarManager.isDefaultToolBar">isDefaultToolBar</a></td> -<td>Public method to check, if a toolbar was added with addToolBar().</td> -</tr><tr> -<td><a href="#E4ToolBarManager.isWidgetAction">isWidgetAction</a></td> -<td>Public method to check, if action is a widget action.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.mainWindow">mainWindow</a></td> -<td>Public method to get the reference to the main window.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.removeAction">removeAction</a></td> -<td>Public method to remove an action from the manager.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.removeToolBar">removeToolBar</a></td> -<td>Public method to remove a toolbar added with addToolBar().</td> -</tr><tr> -<td><a href="#E4ToolBarManager.removeWidgetActions">removeWidgetActions</a></td> -<td>Public method to remove widget actions.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.renameToolBar">renameToolBar</a></td> -<td>Public method to give a toolbar a new title.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.resetAllToolBars">resetAllToolBars</a></td> -<td>Public method to reset all toolbars to their default state.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.resetToolBar">resetToolBar</a></td> -<td>Public method to reset a toolbar to it's default state.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.restoreState">restoreState</a></td> -<td>Public method to restore the state of the toolbar manager.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.saveState">saveState</a></td> -<td>Public method to save the state of the toolbar manager.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.setMainWindow">setMainWindow</a></td> -<td>Public method to set the reference to the main window.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.setToolBar">setToolBar</a></td> -<td>Public method to set the actions of a toolbar.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.setToolBars">setToolBars</a></td> -<td>Public method to set the actions of several toolbars.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.toolBarActions">toolBarActions</a></td> -<td>Public method to get a toolbar's actions given it's id.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.toolBarById">toolBarById</a></td> -<td>Public method to get a toolbar given it's id.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.toolBarWidgetAction">toolBarWidgetAction</a></td> -<td>Public method to get the toolbar for a widget action.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.toolBars">toolBars</a></td> -<td>Public method to get all toolbars.</td> -</tr><tr> -<td><a href="#E4ToolBarManager.toolBarsActions">toolBarsActions</a></td> -<td>Public method to get all toolbars and their actions.</td> -</tr> -</table> -<a NAME="E4ToolBarManager.__init__" ID="E4ToolBarManager.__init__"></a> -<h4>E4ToolBarManager (Constructor)</h4> -<b>E4ToolBarManager</b>(<i>ui = None, parent = None</i>) -<p> - Constructor -</p><dl> -<dt><i>ui</i></dt> -<dd> -reference to the user interface object (UI.UserInterface) -</dd><dt><i>parent</i></dt> -<dd> -reference to the parent object (QObject) -</dd> -</dl><a NAME="E4ToolBarManager.__findAction" ID="E4ToolBarManager.__findAction"></a> -<h4>E4ToolBarManager.__findAction</h4> -<b>__findAction</b>(<i>name</i>) -<p> - Private method to find an action by name. -</p><dl> -<dt><i>name</i></dt> -<dd> -name of the action to search for (string) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -reference to the action (QAction) -</dd> -</dl><a NAME="E4ToolBarManager.__findDefaultToolBar" ID="E4ToolBarManager.__findDefaultToolBar"></a> -<h4>E4ToolBarManager.__findDefaultToolBar</h4> -<b>__findDefaultToolBar</b>(<i>name</i>) -<p> - Private method to find a default toolbar by name. -</p><dl> -<dt><i>name</i></dt> -<dd> -name of the default toolbar to search for (string) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -reference to the default toolbar (QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.__toolBarByName" ID="E4ToolBarManager.__toolBarByName"></a> -<h4>E4ToolBarManager.__toolBarByName</h4> -<b>__toolBarByName</b>(<i>name</i>) -<p> - Private slot to get a toolbar by it's object name. -</p><dl> -<dt><i>name</i></dt> -<dd> -object name of the toolbar (string) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -reference to the toolbar (QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.actionById" ID="E4ToolBarManager.actionById"></a> -<h4>E4ToolBarManager.actionById</h4> -<b>actionById</b>(<i>aID</i>) -<p> - Public method to get an action given it's id. -</p><dl> -<dt><i>aID</i></dt> -<dd> -id of the action object (integer) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -reference to the action (QAction) -</dd> -</dl><a NAME="E4ToolBarManager.addAction" ID="E4ToolBarManager.addAction"></a> -<h4>E4ToolBarManager.addAction</h4> -<b>addAction</b>(<i>action, category</i>) -<p> - Public method to add an action to be managed. -</p><dl> -<dt><i>action</i></dt> -<dd> -reference to the action to be managed (QAction) -</dd><dt><i>category</i></dt> -<dd> -category for the toolbar (string) -</dd> -</dl><a NAME="E4ToolBarManager.addToolBar" ID="E4ToolBarManager.addToolBar"></a> -<h4>E4ToolBarManager.addToolBar</h4> -<b>addToolBar</b>(<i>toolBar, category</i>) -<p> - Public method to add a toolbar to be managed. -</p><dl> -<dt><i>toolBar</i></dt> -<dd> -reference to the toolbar to be managed (QToolBar) -</dd><dt><i>category</i></dt> -<dd> -category for the toolbar (string) -</dd> -</dl><a NAME="E4ToolBarManager.categories" ID="E4ToolBarManager.categories"></a> -<h4>E4ToolBarManager.categories</h4> -<b>categories</b>(<i></i>) -<p> - Public method to get the list of categories. -</p><dl> -<dt>Returns:</dt> -<dd> -list of categories (list of string) -</dd> -</dl><a NAME="E4ToolBarManager.categoryActions" ID="E4ToolBarManager.categoryActions"></a> -<h4>E4ToolBarManager.categoryActions</h4> -<b>categoryActions</b>(<i>category</i>) -<p> - Public method to get the actions belonging to a category. -</p><dl> -<dt><i>category</i></dt> -<dd> -category for the toolbar (string) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -list of actions (list of QAction) -</dd> -</dl><a NAME="E4ToolBarManager.createToolBar" ID="E4ToolBarManager.createToolBar"></a> -<h4>E4ToolBarManager.createToolBar</h4> -<b>createToolBar</b>(<i>title</i>) -<p> - Public method to create a custom toolbar. -</p><dl> -<dt><i>title</i></dt> -<dd> -title to be used for the toolbar (string) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -reference to the created toolbar (QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.defaultToolBarActions" ID="E4ToolBarManager.defaultToolBarActions"></a> -<h4>E4ToolBarManager.defaultToolBarActions</h4> -<b>defaultToolBarActions</b>(<i>tbID</i>) -<p> - Public method to get a default toolbar's actions given it's id. -</p><dl> -<dt><i>tbID</i></dt> -<dd> -id of the default toolbar object (integer) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -list of actions (list of QAction) -</dd> -</dl><a NAME="E4ToolBarManager.defaultToolBars" ID="E4ToolBarManager.defaultToolBars"></a> -<h4>E4ToolBarManager.defaultToolBars</h4> -<b>defaultToolBars</b>(<i></i>) -<p> - Public method to get all toolbars added with addToolBar(). -</p><dl> -<dt>Returns:</dt> -<dd> -list of all default toolbars (list of QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.deleteToolBar" ID="E4ToolBarManager.deleteToolBar"></a> -<h4>E4ToolBarManager.deleteToolBar</h4> -<b>deleteToolBar</b>(<i>toolBar</i>) -<p> - Public method to remove a custom toolbar created with createToolBar(). -</p><dl> -<dt><i>toolBar</i></dt> -<dd> -reference to the toolbar to be managed (QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.isDefaultToolBar" ID="E4ToolBarManager.isDefaultToolBar"></a> -<h4>E4ToolBarManager.isDefaultToolBar</h4> -<b>isDefaultToolBar</b>(<i>toolBar</i>) -<p> - Public method to check, if a toolbar was added with addToolBar(). -</p><dl> -<dt><i>toolBar</i></dt> -<dd> -reference to the toolbar to be checked (QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.isWidgetAction" ID="E4ToolBarManager.isWidgetAction"></a> -<h4>E4ToolBarManager.isWidgetAction</h4> -<b>isWidgetAction</b>(<i>action</i>) -<p> - Public method to check, if action is a widget action. -</p><dl> -<dt><i>action</i></dt> -<dd> -reference to the action to be checked (QAction) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -flag indicating a widget action (boolean) -</dd> -</dl><a NAME="E4ToolBarManager.mainWindow" ID="E4ToolBarManager.mainWindow"></a> -<h4>E4ToolBarManager.mainWindow</h4> -<b>mainWindow</b>(<i></i>) -<p> - Public method to get the reference to the main window. -</p><dl> -<dt>Returns:</dt> -<dd> -reference to the main window (QMainWindow) -</dd> -</dl><a NAME="E4ToolBarManager.removeAction" ID="E4ToolBarManager.removeAction"></a> -<h4>E4ToolBarManager.removeAction</h4> -<b>removeAction</b>(<i>action</i>) -<p> - Public method to remove an action from the manager. -</p><dl> -<dt><i>action</i></dt> -<dd> -reference to the action to be removed (QAction) -</dd> -</dl><a NAME="E4ToolBarManager.removeToolBar" ID="E4ToolBarManager.removeToolBar"></a> -<h4>E4ToolBarManager.removeToolBar</h4> -<b>removeToolBar</b>(<i>toolBar</i>) -<p> - Public method to remove a toolbar added with addToolBar(). -</p><dl> -<dt><i>toolBar</i></dt> -<dd> -reference to the toolbar to be removed (QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.removeWidgetActions" ID="E4ToolBarManager.removeWidgetActions"></a> -<h4>E4ToolBarManager.removeWidgetActions</h4> -<b>removeWidgetActions</b>(<i>actions</i>) -<p> - Public method to remove widget actions. -</p><dl> -<dt><i>actions</i></dt> -<dd> -dictionary with toolbar id as key and - a list of widget actions as value -</dd> -</dl><a NAME="E4ToolBarManager.renameToolBar" ID="E4ToolBarManager.renameToolBar"></a> -<h4>E4ToolBarManager.renameToolBar</h4> -<b>renameToolBar</b>(<i>toolBar, title</i>) -<p> - Public method to give a toolbar a new title. -</p><dl> -<dt><i>toolBar</i></dt> -<dd> -reference to the toolbar to be managed (QToolBar) -</dd><dt><i>title</i></dt> -<dd> -title to be used for the toolbar (string) -</dd> -</dl><a NAME="E4ToolBarManager.resetAllToolBars" ID="E4ToolBarManager.resetAllToolBars"></a> -<h4>E4ToolBarManager.resetAllToolBars</h4> -<b>resetAllToolBars</b>(<i></i>) -<p> - Public method to reset all toolbars to their default state. -</p><a NAME="E4ToolBarManager.resetToolBar" ID="E4ToolBarManager.resetToolBar"></a> -<h4>E4ToolBarManager.resetToolBar</h4> -<b>resetToolBar</b>(<i>toolBar</i>) -<p> - Public method to reset a toolbar to it's default state. -</p><dl> -<dt><i>toolBar</i></dt> -<dd> -reference to the toolbar to configure (QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.restoreState" ID="E4ToolBarManager.restoreState"></a> -<h4>E4ToolBarManager.restoreState</h4> -<b>restoreState</b>(<i>state, version = 0</i>) -<p> - Public method to restore the state of the toolbar manager. -</p><dl> -<dt><i>state</i></dt> -<dd> -byte array containing the saved state (QByteArray) -</dd><dt><i>version</i></dt> -<dd> -version number stored with the data (integer) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -flag indicating success (boolean) -</dd> -</dl><a NAME="E4ToolBarManager.saveState" ID="E4ToolBarManager.saveState"></a> -<h4>E4ToolBarManager.saveState</h4> -<b>saveState</b>(<i>version = 0</i>) -<p> - Public method to save the state of the toolbar manager. -</p><dl> -<dt><i>version</i></dt> -<dd> -version number stored with the data (integer) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -saved state as a byte array (QByteArray) -</dd> -</dl><a NAME="E4ToolBarManager.setMainWindow" ID="E4ToolBarManager.setMainWindow"></a> -<h4>E4ToolBarManager.setMainWindow</h4> -<b>setMainWindow</b>(<i>mainWindow</i>) -<p> - Public method to set the reference to the main window. -</p><dl> -<dt><i>mainWindow</i></dt> -<dd> -reference to the main window (QMainWindow) -</dd> -</dl><a NAME="E4ToolBarManager.setToolBar" ID="E4ToolBarManager.setToolBar"></a> -<h4>E4ToolBarManager.setToolBar</h4> -<b>setToolBar</b>(<i>toolBar, actions</i>) -<p> - Public method to set the actions of a toolbar. -</p><dl> -<dt><i>toolBar</i></dt> -<dd> -reference to the toolbar to configure (QToolBar) -</dd><dt><i>actions</i></dt> -<dd> -list of actions to be set (list of QAction) -</dd> -</dl><a NAME="E4ToolBarManager.setToolBars" ID="E4ToolBarManager.setToolBars"></a> -<h4>E4ToolBarManager.setToolBars</h4> -<b>setToolBars</b>(<i>toolBars</i>) -<p> - Public method to set the actions of several toolbars. -</p><dl> -<dt><i>toolBars</i></dt> -<dd> -dictionary with toolbar id as key and - a list of actions as value -</dd> -</dl><a NAME="E4ToolBarManager.toolBarActions" ID="E4ToolBarManager.toolBarActions"></a> -<h4>E4ToolBarManager.toolBarActions</h4> -<b>toolBarActions</b>(<i>tbID</i>) -<p> - Public method to get a toolbar's actions given it's id. -</p><dl> -<dt><i>tbID</i></dt> -<dd> -id of the toolbar object (integer) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -list of actions (list of QAction) -</dd> -</dl><a NAME="E4ToolBarManager.toolBarById" ID="E4ToolBarManager.toolBarById"></a> -<h4>E4ToolBarManager.toolBarById</h4> -<b>toolBarById</b>(<i>tbID</i>) -<p> - Public method to get a toolbar given it's id. -</p><dl> -<dt><i>tbID</i></dt> -<dd> -id of the toolbar object (integer) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -reference to the toolbar (QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.toolBarWidgetAction" ID="E4ToolBarManager.toolBarWidgetAction"></a> -<h4>E4ToolBarManager.toolBarWidgetAction</h4> -<b>toolBarWidgetAction</b>(<i>action</i>) -<p> - Public method to get the toolbar for a widget action. -</p><dl> -<dt><i>action</i></dt> -<dd> -widget action to check for (QAction) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -reference to the toolbar containing action (QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.toolBars" ID="E4ToolBarManager.toolBars"></a> -<h4>E4ToolBarManager.toolBars</h4> -<b>toolBars</b>(<i></i>) -<p> - Public method to get all toolbars. -</p><dl> -<dt>Returns:</dt> -<dd> -list of all toolbars (list of QToolBar) -</dd> -</dl><a NAME="E4ToolBarManager.toolBarsActions" ID="E4ToolBarManager.toolBarsActions"></a> -<h4>E4ToolBarManager.toolBarsActions</h4> -<b>toolBarsActions</b>(<i></i>) -<p> - Public method to get all toolbars and their actions. -</p><dl> -<dt>Returns:</dt> -<dd> -reference to dictionary of toolbar IDs as key and list - of actions as values -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file