Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html	Mon Jul 11 16:42:50 2022 +0200
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html	Mon Jul 11 16:47:57 2022 +0200
@@ -459,6 +459,10 @@
 <td>Private method to setup the eol context sub menu.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__initContextMenuFormatting">__initContextMenuFormatting</a></td>
+<td>Private method used to setup the Code Formatting context sub menu.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__initContextMenuGraphics">__initContextMenuGraphics</a></td>
 <td>Private method used to setup the diagrams context sub menu.</td>
 </tr>
@@ -595,6 +599,10 @@
 <td>Private slot to mark added and changed lines.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__performFormatWithBlack">__performFormatWithBlack</a></td>
+<td>Private method to format the source code using the 'Black' tool.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__popupDocstringMenu">__popupDocstringMenu</a></td>
 <td>Private slot to pop up a menu asking the user, if a docstring should be inserted.</td>
 </tr>
@@ -799,6 +807,10 @@
 <td>Private slot handling the aboutToShow signal of the eol context menu.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__showContextMenuFormatting">__showContextMenuFormatting</a></td>
+<td>Private slot handling the aboutToShow signal of the code formatting context menu.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__showContextMenuGraphics">__showContextMenuGraphics</a></td>
 <td>Private slot handling the aboutToShow signal of the diagrams context menu.</td>
 </tr>
@@ -2739,6 +2751,25 @@
 QMenu
 </dd>
 </dl>
+<a NAME="Editor.__initContextMenuFormatting" ID="Editor.__initContextMenuFormatting"></a>
+<h4>Editor.__initContextMenuFormatting</h4>
+<b>__initContextMenuFormatting</b>(<i></i>)
+
+<p>
+        Private method used to setup the Code Formatting context sub menu.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the generated menu
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu
+</dd>
+</dl>
 <a NAME="Editor.__initContextMenuGraphics" ID="Editor.__initContextMenuGraphics"></a>
 <h4>Editor.__initContextMenuGraphics</h4>
 <b>__initContextMenuGraphics</b>(<i></i>)
@@ -3245,6 +3276,30 @@
 <p>
         Private slot to mark added and changed lines.
 </p>
+<a NAME="Editor.__performFormatWithBlack" ID="Editor.__performFormatWithBlack"></a>
+<h4>Editor.__performFormatWithBlack</h4>
+<b>__performFormatWithBlack</b>(<i>action</i>)
+
+<p>
+        Private method to format the source code using the 'Black' tool.
+</p>
+<p>
+        Following actions are supported.
+        <ul>
+        <li>BlackFormattingAction.Format - the code reformatting is performed</li>
+        <li>BlackFormattingAction.Check - a check is performed, if code formatting
+            is necessary</li>
+        <li>BlackFormattingAction.Diff - a unified diff of potential code formatting
+            changes is generated</li>
+        </ul>
+</p>
+<dl>
+
+<dt><i>action</i> (BlackFormattingAction)</dt>
+<dd>
+formatting operation to be performed
+</dd>
+</dl>
 <a NAME="Editor.__popupDocstringMenu" ID="Editor.__popupDocstringMenu"></a>
 <h4>Editor.__popupDocstringMenu</h4>
 <b>__popupDocstringMenu</b>(<i>lastLineText, lastCursorPosition</i>)
@@ -3779,6 +3834,14 @@
 <p>
         Private slot handling the aboutToShow signal of the eol context menu.
 </p>
+<a NAME="Editor.__showContextMenuFormatting" ID="Editor.__showContextMenuFormatting"></a>
+<h4>Editor.__showContextMenuFormatting</h4>
+<b>__showContextMenuFormatting</b>(<i></i>)
+
+<p>
+        Private slot handling the aboutToShow signal of the code formatting context
+        menu.
+</p>
 <a NAME="Editor.__showContextMenuGraphics" ID="Editor.__showContextMenuGraphics"></a>
 <h4>Editor.__showContextMenuGraphics</h4>
 <b>__showContextMenuGraphics</b>(<i></i>)