Updated source documentation. eric7

Mon, 15 Nov 2021 19:58:18 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 15 Nov 2021 19:58:18 +0100
branch
eric7
changeset 8770
1b6e619bdaf5
parent 8769
142aea04a31b
child 8771
38d28ff97d4f

Updated source documentation.

eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.EricWidgets.EricIconBar.html file | annotate | diff | comparison | revisions
diff -r 142aea04a31b -r 1b6e619bdaf5 eric7/APIs/Python3/eric7.api
--- a/eric7/APIs/Python3/eric7.api	Mon Nov 15 19:57:33 2021 +0100
+++ b/eric7/APIs/Python3/eric7.api	Mon Nov 15 19:58:18 2021 +0100
@@ -1275,6 +1275,8 @@
 eric7.EricWidgets.EricIconBar.EricIconBar.BarSizes?7
 eric7.EricWidgets.EricIconBar.EricIconBar.DefaultBarSize?7
 eric7.EricWidgets.EricIconBar.EricIconBar.LabelStyleSheetTemplate?7
+eric7.EricWidgets.EricIconBar.EricIconBar.MenuStyleSheetTemplate?7
+eric7.EricWidgets.EricIconBar.EricIconBar.MoreLabelAspect?7
 eric7.EricWidgets.EricIconBar.EricIconBar.WidgetStyleSheetTemplate?7
 eric7.EricWidgets.EricIconBar.EricIconBar.addIcon?4(icon, label="")
 eric7.EricWidgets.EricIconBar.EricIconBar.barSize?4()
@@ -1288,6 +1290,7 @@
 eric7.EricWidgets.EricIconBar.EricIconBar.orientation?4()
 eric7.EricWidgets.EricIconBar.EricIconBar.previousIcon?4()
 eric7.EricWidgets.EricIconBar.EricIconBar.removeIcon?4(index)
+eric7.EricWidgets.EricIconBar.EricIconBar.resizeEvent?4(evt)
 eric7.EricWidgets.EricIconBar.EricIconBar.setBarSize?4(barSize)
 eric7.EricWidgets.EricIconBar.EricIconBar.setColor?4(color)
 eric7.EricWidgets.EricIconBar.EricIconBar.setCurrentIndex?4(index)
diff -r 142aea04a31b -r 1b6e619bdaf5 eric7/Documentation/Help/source.qch
Binary file eric7/Documentation/Help/source.qch has changed
diff -r 142aea04a31b -r 1b6e619bdaf5 eric7/Documentation/Help/source.qhp
--- a/eric7/Documentation/Help/source.qhp	Mon Nov 15 19:57:33 2021 +0100
+++ b/eric7/Documentation/Help/source.qhp	Mon Nov 15 19:58:18 2021 +0100
@@ -4916,8 +4916,11 @@
       <keyword name="EricIconBar" id="EricIconBar" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar" />
       <keyword name="EricIconBar (Constructor)" id="EricIconBar (Constructor)" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.__init__" />
       <keyword name="EricIconBar (Module)" id="EricIconBar (Module)" ref="eric7.EricWidgets.EricIconBar.html" />
+      <keyword name="EricIconBar.__adjustIconLabels" id="EricIconBar.__adjustIconLabels" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.__adjustIconLabels" />
       <keyword name="EricIconBar.__createIcon" id="EricIconBar.__createIcon" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.__createIcon" />
+      <keyword name="EricIconBar.__createMoreLabel" id="EricIconBar.__createMoreLabel" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.__createMoreLabel" />
       <keyword name="EricIconBar.__iconClicked" id="EricIconBar.__iconClicked" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.__iconClicked" />
+      <keyword name="EricIconBar.__moreLabelClicked" id="EricIconBar.__moreLabelClicked" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.__moreLabelClicked" />
       <keyword name="EricIconBar.addIcon" id="EricIconBar.addIcon" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.addIcon" />
       <keyword name="EricIconBar.barSize" id="EricIconBar.barSize" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.barSize" />
       <keyword name="EricIconBar.color" id="EricIconBar.color" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.color" />
@@ -4928,6 +4931,7 @@
       <keyword name="EricIconBar.orientation" id="EricIconBar.orientation" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.orientation" />
       <keyword name="EricIconBar.previousIcon" id="EricIconBar.previousIcon" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.previousIcon" />
       <keyword name="EricIconBar.removeIcon" id="EricIconBar.removeIcon" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.removeIcon" />
+      <keyword name="EricIconBar.resizeEvent" id="EricIconBar.resizeEvent" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.resizeEvent" />
       <keyword name="EricIconBar.setBarSize" id="EricIconBar.setBarSize" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.setBarSize" />
       <keyword name="EricIconBar.setColor" id="EricIconBar.setColor" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.setColor" />
       <keyword name="EricIconBar.setCurrentIndex" id="EricIconBar.setCurrentIndex" ref="eric7.EricWidgets.EricIconBar.html#EricIconBar.setCurrentIndex" />
diff -r 142aea04a31b -r 1b6e619bdaf5 eric7/Documentation/Source/eric7.EricWidgets.EricIconBar.html
--- a/eric7/Documentation/Source/eric7.EricWidgets.EricIconBar.html	Mon Nov 15 19:57:33 2021 +0100
+++ b/eric7/Documentation/Source/eric7.EricWidgets.EricIconBar.html	Mon Nov 15 19:58:18 2021 +0100
@@ -57,7 +57,7 @@
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>BarSizes</td></tr><tr><td>DefaultBarSize</td></tr><tr><td>LabelStyleSheetTemplate</td></tr><tr><td>WidgetStyleSheetTemplate</td></tr>
+<tr><td>BarSizes</td></tr><tr><td>DefaultBarSize</td></tr><tr><td>LabelStyleSheetTemplate</td></tr><tr><td>MenuStyleSheetTemplate</td></tr><tr><td>MoreLabelAspect</td></tr><tr><td>WidgetStyleSheetTemplate</td></tr>
 </table>
 <h3>Class Methods</h3>
 
@@ -73,14 +73,26 @@
 <td>Constructor</td>
 </tr>
 <tr>
+<td><a href="#EricIconBar.__adjustIconLabels">__adjustIconLabels</a></td>
+<td>Private method to adjust the visibility of the icon labels.</td>
+</tr>
+<tr>
 <td><a href="#EricIconBar.__createIcon">__createIcon</a></td>
 <td>Private method to creat an icon label.</td>
 </tr>
 <tr>
+<td><a href="#EricIconBar.__createMoreLabel">__createMoreLabel</a></td>
+<td>Private method to create the label to be shown for too many icons.</td>
+</tr>
+<tr>
 <td><a href="#EricIconBar.__iconClicked">__iconClicked</a></td>
 <td>Private slot to handle an icon been clicked.</td>
 </tr>
 <tr>
+<td><a href="#EricIconBar.__moreLabelClicked">__moreLabelClicked</a></td>
+<td>Private slot to handle a click onto the 'More' label.</td>
+</tr>
+<tr>
 <td><a href="#EricIconBar.addIcon">addIcon</a></td>
 <td>Public method to add an icon to the bar.</td>
 </tr>
@@ -121,6 +133,10 @@
 <td>Public method to remove an icon from the bar.</td>
 </tr>
 <tr>
+<td><a href="#EricIconBar.resizeEvent">resizeEvent</a></td>
+<td>Protected method to handle resizing of the icon bar.</td>
+</tr>
+<tr>
 <td><a href="#EricIconBar.setBarSize">setBarSize</a></td>
 <td>Public method to set the icon bar size.</td>
 </tr>
@@ -170,6 +186,13 @@
 reference to the parent widget (defaults to None)
 </dd>
 </dl>
+<a NAME="EricIconBar.__adjustIconLabels" ID="EricIconBar.__adjustIconLabels"></a>
+<h4>EricIconBar.__adjustIconLabels</h4>
+<b>__adjustIconLabels</b>(<i></i>)
+
+<p>
+        Private method to adjust the visibility of the icon labels.
+</p>
 <a NAME="EricIconBar.__createIcon" ID="EricIconBar.__createIcon"></a>
 <h4>EricIconBar.__createIcon</h4>
 <b>__createIcon</b>(<i>icon, label=""</i>)
@@ -200,6 +223,13 @@
 EricClickableLabel
 </dd>
 </dl>
+<a NAME="EricIconBar.__createMoreLabel" ID="EricIconBar.__createMoreLabel"></a>
+<h4>EricIconBar.__createMoreLabel</h4>
+<b>__createMoreLabel</b>(<i></i>)
+
+<p>
+        Private method to create the label to be shown for too many icons.
+</p>
 <a NAME="EricIconBar.__iconClicked" ID="EricIconBar.__iconClicked"></a>
 <h4>EricIconBar.__iconClicked</h4>
 <b>__iconClicked</b>(<i>label</i>)
@@ -214,6 +244,13 @@
 reference to the clicked label
 </dd>
 </dl>
+<a NAME="EricIconBar.__moreLabelClicked" ID="EricIconBar.__moreLabelClicked"></a>
+<h4>EricIconBar.__moreLabelClicked</h4>
+<b>__moreLabelClicked</b>(<i></i>)
+
+<p>
+        Private slot to handle a click onto the 'More' label.
+</p>
 <a NAME="EricIconBar.addIcon" ID="EricIconBar.addIcon"></a>
 <h4>EricIconBar.addIcon</h4>
 <b>addIcon</b>(<i>icon, label=""</i>)
@@ -378,6 +415,20 @@
 index of the icon to be removed
 </dd>
 </dl>
+<a NAME="EricIconBar.resizeEvent" ID="EricIconBar.resizeEvent"></a>
+<h4>EricIconBar.resizeEvent</h4>
+<b>resizeEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method to handle resizing of the icon bar.
+</p>
+<dl>
+
+<dt><i>evt</i> (QResizeEvent)</dt>
+<dd>
+reference to the event object
+</dd>
+</dl>
 <a NAME="EricIconBar.setBarSize" ID="EricIconBar.setBarSize"></a>
 <h4>EricIconBar.setBarSize</h4>
 <b>setBarSize</b>(<i>barSize</i>)

eric ide

mercurial