Updated source documentation.

Sat, 15 Aug 2020 19:17:47 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 15 Aug 2020 19:17:47 +0200
changeset 7669
9a89687a081e
parent 7668
75b64f9e517c
child 7670
aefd888a2b93

Updated source documentation.

eric6/APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.UI.UserInterface.html file | annotate | diff | comparison | revisions
--- a/eric6/APIs/Python3/eric6.api	Sat Aug 15 19:16:26 2020 +0200
+++ b/eric6/APIs/Python3/eric6.api	Sat Aug 15 19:17:47 2020 +0200
@@ -9067,6 +9067,7 @@
 eric6.UI.UserInterface.UserInterface.getOriginalPathString?4()
 eric6.UI.UserInterface.UserInterface.getToolBarIconSize?4()
 eric6.UI.UserInterface.UserInterface.getToolbar?4(name)
+eric6.UI.UserInterface.UserInterface.getToolbarsByCategory?4(category)
 eric6.UI.UserInterface.UserInterface.getViewProfile?4()
 eric6.UI.UserInterface.UserInterface.handleUrl?4(url)
 eric6.UI.UserInterface.UserInterface.isOnline?4()
@@ -9080,11 +9081,11 @@
 eric6.UI.UserInterface.UserInterface.performVersionCheck?4(manual=True, alternative=0, showVersions=False)
 eric6.UI.UserInterface.UserInterface.preferencesChanged?7
 eric6.UI.UserInterface.UserInterface.processArgs?4(args)
-eric6.UI.UserInterface.UserInterface.registerToolbar?4(name, text, toolbar)
+eric6.UI.UserInterface.UserInterface.registerToolbar?4(name, text, toolbar, category="")
 eric6.UI.UserInterface.UserInterface.reloadAPIs?7
 eric6.UI.UserInterface.UserInterface.removeE5Actions?4(actions, actionType='ui')
 eric6.UI.UserInterface.UserInterface.removeSideWidget?4(widget)
-eric6.UI.UserInterface.UserInterface.reregisterToolbar?4(name, text)
+eric6.UI.UserInterface.UserInterface.reregisterToolbar?4(name, text, category="")
 eric6.UI.UserInterface.UserInterface.setDebugProfile?4(save=True)
 eric6.UI.UserInterface.UserInterface.showAvailableVersionsInfo?4()
 eric6.UI.UserInterface.UserInterface.showEmailDialog?4(mode, attachFile=None, deleteAttachFile=False)
Binary file eric6/Documentation/Help/source.qch has changed
--- a/eric6/Documentation/Help/source.qhp	Sat Aug 15 19:16:26 2020 +0200
+++ b/eric6/Documentation/Help/source.qhp	Sat Aug 15 19:17:47 2020 +0200
@@ -15452,6 +15452,7 @@
       <keyword name="UserInterface.getOriginalPathString" id="UserInterface.getOriginalPathString" ref="eric6.UI.UserInterface.html#UserInterface.getOriginalPathString" />
       <keyword name="UserInterface.getToolBarIconSize" id="UserInterface.getToolBarIconSize" ref="eric6.UI.UserInterface.html#UserInterface.getToolBarIconSize" />
       <keyword name="UserInterface.getToolbar" id="UserInterface.getToolbar" ref="eric6.UI.UserInterface.html#UserInterface.getToolbar" />
+      <keyword name="UserInterface.getToolbarsByCategory" id="UserInterface.getToolbarsByCategory" ref="eric6.UI.UserInterface.html#UserInterface.getToolbarsByCategory" />
       <keyword name="UserInterface.getViewProfile" id="UserInterface.getViewProfile" ref="eric6.UI.UserInterface.html#UserInterface.getViewProfile" />
       <keyword name="UserInterface.handleUrl" id="UserInterface.handleUrl" ref="eric6.UI.UserInterface.html#UserInterface.handleUrl" />
       <keyword name="UserInterface.isOnline" id="UserInterface.isOnline" ref="eric6.UI.UserInterface.html#UserInterface.isOnline" />
--- a/eric6/Documentation/Source/eric6.UI.UserInterface.html	Sat Aug 15 19:16:26 2020 +0200
+++ b/eric6/Documentation/Source/eric6.UI.UserInterface.html	Sat Aug 15 19:17:47 2020 +0200
@@ -999,6 +999,10 @@
 <td>Public method to get a reference to a specific toolbar.</td>
 </tr>
 <tr>
+<td><a href="#UserInterface.getToolbarsByCategory">getToolbarsByCategory</a></td>
+<td>Public method to get a list of toolbars belonging to a given toolbar category.</td>
+</tr>
+<tr>
 <td><a href="#UserInterface.getViewProfile">getViewProfile</a></td>
 <td>Public method to get the current view profile.</td>
 </tr>
@@ -3278,6 +3282,33 @@
 reference to the toolbar entry (tuple of string and QToolBar)
 </dd>
 </dl>
+<a NAME="UserInterface.getToolbarsByCategory" ID="UserInterface.getToolbarsByCategory"></a>
+<h4>UserInterface.getToolbarsByCategory</h4>
+<b>getToolbarsByCategory</b>(<i>category</i>)
+
+<p>
+        Public method to get a list of toolbars belonging to a given toolbar
+        category.
+</p>
+<dl>
+
+<dt><i>category</i> (str)</dt>
+<dd>
+toolbar category
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+list of toolbars
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QToolBar
+</dd>
+</dl>
 <a NAME="UserInterface.getViewProfile" ID="UserInterface.getViewProfile"></a>
 <h4>UserInterface.getViewProfile</h4>
 <b>getViewProfile</b>(<i></i>)
@@ -3422,7 +3453,7 @@
 </dl>
 <a NAME="UserInterface.registerToolbar" ID="UserInterface.registerToolbar"></a>
 <h4>UserInterface.registerToolbar</h4>
-<b>registerToolbar</b>(<i>name, text, toolbar</i>)
+<b>registerToolbar</b>(<i>name, text, toolbar, category=""</i>)
 
 <p>
         Public method to register a toolbar.
@@ -3433,18 +3464,22 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the toolbar (string). This is used as the key into
+name of the toolbar. This is used as the key into
             the dictionary of toolbar references.
 </dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-user visible text for the toolbar entry (string)
+user visible text for the toolbar entry
 </dd>
-<dt><i>toolbar</i></dt>
+<dt><i>toolbar</i> (QToolBar)</dt>
 <dd>
-reference to the toolbar to be registered (QToolBar)
+reference to the toolbar to be registered
+</dd>
+<dt><i>category</i> (str)</dt>
+<dd>
+toolbar category
 </dd>
 </dl>
 <dl>
@@ -3490,20 +3525,24 @@
 </dl>
 <a NAME="UserInterface.reregisterToolbar" ID="UserInterface.reregisterToolbar"></a>
 <h4>UserInterface.reregisterToolbar</h4>
-<b>reregisterToolbar</b>(<i>name, text</i>)
+<b>reregisterToolbar</b>(<i>name, text, category=""</i>)
 
 <p>
         Public method to change the visible text for the named toolbar.
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the toolbar to be changed (string)
+name of the toolbar to be changed
 </dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-new user visible text for the toolbar entry (string)
+new user visible text for the toolbar entry
+</dd>
+<dt><i>category</i> (str)</dt>
+<dd>
+new toolbar category for the toolbar entry
 </dd>
 </dl>
 <a NAME="UserInterface.setDebugProfile" ID="UserInterface.setDebugProfile"></a>

eric ide

mercurial