diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.IconEditor.IconEditorGrid.html --- a/src/eric7/Documentation/Source/eric7.IconEditor.IconEditorGrid.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.IconEditor.IconEditorGrid.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,19 +7,17 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.IconEditor.IconEditorGrid</h1> - <p> Module implementing the icon editor grid. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#IconEditCommand">IconEditCommand</a></td> <td>Class implementing an undo command for the icon editor.</td> @@ -33,35 +31,34 @@ <td>Class defining the edit tools.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="IconEditCommand" ID="IconEditCommand"></a> <h2>IconEditCommand</h2> - <p> Class implementing an undo command for the icon editor. </p> + <h3>Derived from</h3> QUndoCommand <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#IconEditCommand.__init__">IconEditCommand</a></td> <td>Constructor</td> @@ -79,19 +76,20 @@ <td>Public method to perform the undo.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="IconEditCommand.__init__" ID="IconEditCommand.__init__"></a> <h4>IconEditCommand (Constructor)</h4> <b>IconEditCommand</b>(<i>grid, text, oldImage, parent=None</i>) - <p> Constructor </p> + <dl> <dt><i>grid</i> (IconEditorGrid)</dt> @@ -114,17 +112,17 @@ <a NAME="IconEditCommand.redo" ID="IconEditCommand.redo"></a> <h4>IconEditCommand.redo</h4> <b>redo</b>(<i></i>) - <p> Public method to perform the redo. </p> + <a NAME="IconEditCommand.setAfterImage" ID="IconEditCommand.setAfterImage"></a> <h4>IconEditCommand.setAfterImage</h4> <b>setAfterImage</b>(<i>image</i>) - <p> Public method to set the image after the changes were applied. </p> + <dl> <dt><i>image</i> (QImage)</dt> @@ -135,19 +133,19 @@ <a NAME="IconEditCommand.undo" ID="IconEditCommand.undo"></a> <h4>IconEditCommand.undo</h4> <b>undo</b>(<i></i>) - <p> Public method to perform the undo. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="IconEditorGrid" ID="IconEditorGrid"></a> <h2>IconEditorGrid</h2> - <p> Class implementing the icon editor grid. </p> + <h3>Signals</h3> <dl> @@ -198,19 +196,23 @@ <h3>Derived from</h3> QWidget <h3>Class Attributes</h3> +<table> +<tr><td>MarkColor</td></tr> +<tr><td>NoMarkColor</td></tr> +<tr><td>ZoomDefault</td></tr> +<tr><td>ZoomMaximum</td></tr> +<tr><td>ZoomMinimum</td></tr> +<tr><td>ZoomPercent</td></tr> +<tr><td>ZoomStep</td></tr> +</table> -<table> -<tr><td>MarkColor</td></tr><tr><td>NoMarkColor</td></tr><tr><td>ZoomDefault</td></tr><tr><td>ZoomMaximum</td></tr><tr><td>ZoomMinimum</td></tr><tr><td>ZoomPercent</td></tr><tr><td>ZoomStep</td></tr> -</table> <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#IconEditorGrid.__init__">IconEditorGrid</a></td> <td>Constructor</td> @@ -432,19 +434,20 @@ <td>Public method to get the current zoom factor in percent.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="IconEditorGrid.__init__" ID="IconEditorGrid.__init__"></a> <h4>IconEditorGrid (Constructor)</h4> <b>IconEditorGrid</b>(<i>parent=None</i>) - <p> Constructor </p> + <dl> <dt><i>parent</i> (QWidget)</dt> @@ -455,18 +458,18 @@ <a NAME="IconEditorGrid.__checkClipboard" ID="IconEditorGrid.__checkClipboard"></a> <h4>IconEditorGrid.__checkClipboard</h4> <b>__checkClipboard</b>(<i></i>) - <p> Private slot to check, if the clipboard contains a valid image, and signal the result. </p> + <a NAME="IconEditorGrid.__cleanChanged" ID="IconEditorGrid.__cleanChanged"></a> <h4>IconEditorGrid.__cleanChanged</h4> <b>__cleanChanged</b>(<i>clean</i>) - <p> Private slot to handle the undo stack clean state change. </p> + <dl> <dt><i>clean</i> (bool)</dt> @@ -477,10 +480,10 @@ <a NAME="IconEditorGrid.__clipboardImage" ID="IconEditorGrid.__clipboardImage"></a> <h4>IconEditorGrid.__clipboardImage</h4> <b>__clipboardImage</b>(<i></i>) - <p> Private method to get an image from the clipboard. </p> + <dl> <dt>Return:</dt> <dd> @@ -497,10 +500,10 @@ <a NAME="IconEditorGrid.__drawFlood" ID="IconEditorGrid.__drawFlood"></a> <h4>IconEditorGrid.__drawFlood</h4> <b>__drawFlood</b>(<i>i, j, oldColor, doUpdate=True</i>) - <p> Private method to perform a flood fill operation. </p> + <dl> <dt><i>i</i> (int)</dt> @@ -524,10 +527,10 @@ <a NAME="IconEditorGrid.__drawPasteRect" ID="IconEditorGrid.__drawPasteRect"></a> <h4>IconEditorGrid.__drawPasteRect</h4> <b>__drawPasteRect</b>(<i>pos</i>) - <p> Private slot to draw a rectangle for signaling a paste operation. </p> + <dl> <dt><i>pos</i> (QPoint)</dt> @@ -538,11 +541,11 @@ <a NAME="IconEditorGrid.__drawTool" ID="IconEditorGrid.__drawTool"></a> <h4>IconEditorGrid.__drawTool</h4> <b>__drawTool</b>(<i>pos, mark</i>) - <p> Private method to perform a draw operation depending of the current tool. </p> + <dl> <dt><i>pos</i> (QPoint)</dt> @@ -569,10 +572,10 @@ <a NAME="IconEditorGrid.__getSelectionImage" ID="IconEditorGrid.__getSelectionImage"></a> <h4>IconEditorGrid.__getSelectionImage</h4> <b>__getSelectionImage</b>(<i>cut</i>) - <p> Private method to get an image from the selection. </p> + <dl> <dt><i>cut</i> (bool)</dt> @@ -595,10 +598,10 @@ <a NAME="IconEditorGrid.__imageCoordinates" ID="IconEditorGrid.__imageCoordinates"></a> <h4>IconEditorGrid.__imageCoordinates</h4> <b>__imageCoordinates</b>(<i>pos</i>) - <p> Private method to convert from widget to image coordinates. </p> + <dl> <dt><i>pos</i> (QPoint)</dt> @@ -621,25 +624,25 @@ <a NAME="IconEditorGrid.__initCursors" ID="IconEditorGrid.__initCursors"></a> <h4>IconEditorGrid.__initCursors</h4> <b>__initCursors</b>(<i></i>) - <p> Private method to initialize the various cursors. </p> + <a NAME="IconEditorGrid.__initUndoTexts" ID="IconEditorGrid.__initUndoTexts"></a> <h4>IconEditorGrid.__initUndoTexts</h4> <b>__initUndoTexts</b>(<i></i>) - <p> Private method to initialize texts to be associated with undo commands for the various drawing tools. </p> + <a NAME="IconEditorGrid.__isMarked" ID="IconEditorGrid.__isMarked"></a> <h4>IconEditorGrid.__isMarked</h4> <b>__isMarked</b>(<i>i, j</i>) - <p> Private method to check, if a pixel is marked. </p> + <dl> <dt><i>i</i> (int)</dt> @@ -666,10 +669,10 @@ <a NAME="IconEditorGrid.__pixelRect" ID="IconEditorGrid.__pixelRect"></a> <h4>IconEditorGrid.__pixelRect</h4> <b>__pixelRect</b>(<i>i, j</i>) - <p> Private method to determine the rectangle for a given pixel coordinate. </p> + <dl> <dt><i>i</i> (int)</dt> @@ -696,10 +699,10 @@ <a NAME="IconEditorGrid.__setImagePixel" ID="IconEditorGrid.__setImagePixel"></a> <h4>IconEditorGrid.__setImagePixel</h4> <b>__setImagePixel</b>(<i>pos, opaque</i>) - <p> Private slot to set or erase a pixel. </p> + <dl> <dt><i>pos</i> (QPoint)</dt> @@ -714,17 +717,17 @@ <a NAME="IconEditorGrid.__unMark" ID="IconEditorGrid.__unMark"></a> <h4>IconEditorGrid.__unMark</h4> <b>__unMark</b>(<i></i>) - <p> Private slot to remove the mark indicator. </p> + <a NAME="IconEditorGrid.__updateImageRect" ID="IconEditorGrid.__updateImageRect"></a> <h4>IconEditorGrid.__updateImageRect</h4> <b>__updateImageRect</b>(<i>ipos1, ipos2</i>) - <p> Private slot to update parts of the widget. </p> + <dl> <dt><i>ipos1</i> (QPoint)</dt> @@ -740,17 +743,17 @@ <a NAME="IconEditorGrid.__updatePreviewPixmap" ID="IconEditorGrid.__updatePreviewPixmap"></a> <h4>IconEditorGrid.__updatePreviewPixmap</h4> <b>__updatePreviewPixmap</b>(<i></i>) - <p> Private slot to generate and signal an updated preview pixmap. </p> + <a NAME="IconEditorGrid.__updateRect" ID="IconEditorGrid.__updateRect"></a> <h4>IconEditorGrid.__updateRect</h4> <b>__updateRect</b>(<i>pos1, pos2</i>) - <p> Private slot to update parts of the widget. </p> + <dl> <dt><i>pos1</i> (QPoint)</dt> @@ -766,10 +769,10 @@ <a NAME="IconEditorGrid.canPaste" ID="IconEditorGrid.canPaste"></a> <h4>IconEditorGrid.canPaste</h4> <b>canPaste</b>(<i></i>) - <p> Public slot to check the availability of the paste operation. </p> + <dl> <dt>Return:</dt> <dd> @@ -785,10 +788,10 @@ <a NAME="IconEditorGrid.canRedo" ID="IconEditorGrid.canRedo"></a> <h4>IconEditorGrid.canRedo</h4> <b>canRedo</b>(<i></i>) - <p> Public method to return the redo status. </p> + <dl> <dt>Return:</dt> <dd> @@ -804,10 +807,10 @@ <a NAME="IconEditorGrid.canUndo" ID="IconEditorGrid.canUndo"></a> <h4>IconEditorGrid.canUndo</h4> <b>canUndo</b>(<i></i>) - <p> Public method to return the undo status. </p> + <dl> <dt>Return:</dt> <dd> @@ -823,10 +826,10 @@ <a NAME="IconEditorGrid.compositingMode" ID="IconEditorGrid.compositingMode"></a> <h4>IconEditorGrid.compositingMode</h4> <b>compositingMode</b>(<i></i>) - <p> Public method to get the compositing mode. </p> + <dl> <dt>Return:</dt> <dd> @@ -842,38 +845,38 @@ <a NAME="IconEditorGrid.editClear" ID="IconEditorGrid.editClear"></a> <h4>IconEditorGrid.editClear</h4> <b>editClear</b>(<i></i>) - <p> Public slot to clear the image. </p> + <a NAME="IconEditorGrid.editCopy" ID="IconEditorGrid.editCopy"></a> <h4>IconEditorGrid.editCopy</h4> <b>editCopy</b>(<i></i>) - <p> Public slot to copy the selection. </p> + <a NAME="IconEditorGrid.editCut" ID="IconEditorGrid.editCut"></a> <h4>IconEditorGrid.editCut</h4> <b>editCut</b>(<i></i>) - <p> Public slot to cut the selection. </p> + <a NAME="IconEditorGrid.editNew" ID="IconEditorGrid.editNew"></a> <h4>IconEditorGrid.editNew</h4> <b>editNew</b>(<i></i>) - <p> Public slot to generate a new, empty image. </p> + <a NAME="IconEditorGrid.editPaste" ID="IconEditorGrid.editPaste"></a> <h4>IconEditorGrid.editPaste</h4> <b>editPaste</b>(<i>pasting=False</i>) - <p> Public slot to paste an image from the clipboard. </p> + <dl> <dt><i>pasting</i> (bool)</dt> @@ -884,52 +887,52 @@ <a NAME="IconEditorGrid.editPasteAsNew" ID="IconEditorGrid.editPasteAsNew"></a> <h4>IconEditorGrid.editPasteAsNew</h4> <b>editPasteAsNew</b>(<i></i>) - <p> Public slot to paste the clipboard as a new image. </p> + <a NAME="IconEditorGrid.editRedo" ID="IconEditorGrid.editRedo"></a> <h4>IconEditorGrid.editRedo</h4> <b>editRedo</b>(<i></i>) - <p> Public slot to perform a redo operation. </p> + <a NAME="IconEditorGrid.editResize" ID="IconEditorGrid.editResize"></a> <h4>IconEditorGrid.editResize</h4> <b>editResize</b>(<i></i>) - <p> Public slot to resize the image. </p> + <a NAME="IconEditorGrid.editSelectAll" ID="IconEditorGrid.editSelectAll"></a> <h4>IconEditorGrid.editSelectAll</h4> <b>editSelectAll</b>(<i></i>) - <p> Public slot to select the complete image. </p> + <a NAME="IconEditorGrid.editUndo" ID="IconEditorGrid.editUndo"></a> <h4>IconEditorGrid.editUndo</h4> <b>editUndo</b>(<i></i>) - <p> Public slot to perform an undo operation. </p> + <a NAME="IconEditorGrid.grayScale" ID="IconEditorGrid.grayScale"></a> <h4>IconEditorGrid.grayScale</h4> <b>grayScale</b>(<i></i>) - <p> Public slot to convert the image to gray preserving transparency. </p> + <a NAME="IconEditorGrid.iconImage" ID="IconEditorGrid.iconImage"></a> <h4>IconEditorGrid.iconImage</h4> <b>iconImage</b>(<i></i>) - <p> Public method to get a copy of the icon image. </p> + <dl> <dt>Return:</dt> <dd> @@ -945,10 +948,10 @@ <a NAME="IconEditorGrid.iconSize" ID="IconEditorGrid.iconSize"></a> <h4>IconEditorGrid.iconSize</h4> <b>iconSize</b>(<i></i>) - <p> Public method to get the size of the icon. </p> + <dl> <dt>Return:</dt> <dd> @@ -964,10 +967,10 @@ <a NAME="IconEditorGrid.isDirty" ID="IconEditorGrid.isDirty"></a> <h4>IconEditorGrid.isDirty</h4> <b>isDirty</b>(<i></i>) - <p> Public method to check the dirty status. </p> + <dl> <dt>Return:</dt> <dd> @@ -983,10 +986,10 @@ <a NAME="IconEditorGrid.isGridEnabled" ID="IconEditorGrid.isGridEnabled"></a> <h4>IconEditorGrid.isGridEnabled</h4> <b>isGridEnabled</b>(<i></i>) - <p> Public method to get the grid lines status. </p> + <dl> <dt>Return:</dt> <dd> @@ -1002,10 +1005,10 @@ <a NAME="IconEditorGrid.isSelectionAvailable" ID="IconEditorGrid.isSelectionAvailable"></a> <h4>IconEditorGrid.isSelectionAvailable</h4> <b>isSelectionAvailable</b>(<i></i>) - <p> Public method to check the availability of a selection. </p> + <dl> <dt>Return:</dt> <dd> @@ -1021,10 +1024,10 @@ <a NAME="IconEditorGrid.mouseMoveEvent" ID="IconEditorGrid.mouseMoveEvent"></a> <h4>IconEditorGrid.mouseMoveEvent</h4> <b>mouseMoveEvent</b>(<i>evt</i>) - <p> Protected method to handle mouse move events. </p> + <dl> <dt><i>evt</i> (QMouseEvent)</dt> @@ -1035,10 +1038,10 @@ <a NAME="IconEditorGrid.mousePressEvent" ID="IconEditorGrid.mousePressEvent"></a> <h4>IconEditorGrid.mousePressEvent</h4> <b>mousePressEvent</b>(<i>evt</i>) - <p> Protected method to handle mouse button press events. </p> + <dl> <dt><i>evt</i> (QMouseEvent)</dt> @@ -1049,10 +1052,10 @@ <a NAME="IconEditorGrid.mouseReleaseEvent" ID="IconEditorGrid.mouseReleaseEvent"></a> <h4>IconEditorGrid.mouseReleaseEvent</h4> <b>mouseReleaseEvent</b>(<i>evt</i>) - <p> Protected method to handle mouse button release events. </p> + <dl> <dt><i>evt</i> (QMouseEvent)</dt> @@ -1063,10 +1066,10 @@ <a NAME="IconEditorGrid.paintEvent" ID="IconEditorGrid.paintEvent"></a> <h4>IconEditorGrid.paintEvent</h4> <b>paintEvent</b>(<i>evt</i>) - <p> Protected method called to repaint some of the widget. </p> + <dl> <dt><i>evt</i> (QPaintEvent)</dt> @@ -1077,10 +1080,10 @@ <a NAME="IconEditorGrid.penColor" ID="IconEditorGrid.penColor"></a> <h4>IconEditorGrid.penColor</h4> <b>penColor</b>(<i></i>) - <p> Public method to get the current drawing color. </p> + <dl> <dt>Return:</dt> <dd> @@ -1096,10 +1099,10 @@ <a NAME="IconEditorGrid.previewPixmap" ID="IconEditorGrid.previewPixmap"></a> <h4>IconEditorGrid.previewPixmap</h4> <b>previewPixmap</b>(<i></i>) - <p> Public method to generate a preview pixmap. </p> + <dl> <dt>Return:</dt> <dd> @@ -1115,10 +1118,10 @@ <a NAME="IconEditorGrid.setCompositingMode" ID="IconEditorGrid.setCompositingMode"></a> <h4>IconEditorGrid.setCompositingMode</h4> <b>setCompositingMode</b>(<i>mode</i>) - <p> Public method to set the compositing mode. </p> + <dl> <dt><i>mode</i> (QPainter.CompositionMode)</dt> @@ -1129,10 +1132,10 @@ <a NAME="IconEditorGrid.setDirty" ID="IconEditorGrid.setDirty"></a> <h4>IconEditorGrid.setDirty</h4> <b>setDirty</b>(<i>dirty, setCleanState=False</i>) - <p> Public slot to set the dirty flag. </p> + <dl> <dt><i>dirty</i> (bool)</dt> @@ -1147,10 +1150,10 @@ <a NAME="IconEditorGrid.setGridEnabled" ID="IconEditorGrid.setGridEnabled"></a> <h4>IconEditorGrid.setGridEnabled</h4> <b>setGridEnabled</b>(<i>enable</i>) - <p> Public method to enable the display of grid lines. </p> + <dl> <dt><i>enable</i> (bool)</dt> @@ -1161,10 +1164,10 @@ <a NAME="IconEditorGrid.setIconImage" ID="IconEditorGrid.setIconImage"></a> <h4>IconEditorGrid.setIconImage</h4> <b>setIconImage</b>(<i>newImage, undoRedo=False, clearUndo=False</i>) - <p> Public method to set a new icon image. </p> + <dl> <dt><i>newImage</i> (QImage)</dt> @@ -1183,10 +1186,10 @@ <a NAME="IconEditorGrid.setPenColor" ID="IconEditorGrid.setPenColor"></a> <h4>IconEditorGrid.setPenColor</h4> <b>setPenColor</b>(<i>newColor</i>) - <p> Public method to set the drawing color. </p> + <dl> <dt><i>newColor</i> (QColor)</dt> @@ -1197,10 +1200,10 @@ <a NAME="IconEditorGrid.setTool" ID="IconEditorGrid.setTool"></a> <h4>IconEditorGrid.setTool</h4> <b>setTool</b>(<i>tool</i>) - <p> Public method to set the current drawing tool. </p> + <dl> <dt><i>tool</i> (IconEditorTool)</dt> @@ -1211,10 +1214,10 @@ <a NAME="IconEditorGrid.setZoomFactor" ID="IconEditorGrid.setZoomFactor"></a> <h4>IconEditorGrid.setZoomFactor</h4> <b>setZoomFactor</b>(<i>newZoom</i>) - <p> Public method to set the zoom factor in percent. </p> + <dl> <dt><i>newZoom</i> (int)</dt> @@ -1225,17 +1228,17 @@ <a NAME="IconEditorGrid.shutdown" ID="IconEditorGrid.shutdown"></a> <h4>IconEditorGrid.shutdown</h4> <b>shutdown</b>(<i></i>) - <p> Public slot to perform some shutdown actions. </p> + <a NAME="IconEditorGrid.sizeHint" ID="IconEditorGrid.sizeHint"></a> <h4>IconEditorGrid.sizeHint</h4> <b>sizeHint</b>(<i></i>) - <p> Public method to report the size hint. </p> + <dl> <dt>Return:</dt> <dd> @@ -1251,10 +1254,10 @@ <a NAME="IconEditorGrid.tool" ID="IconEditorGrid.tool"></a> <h4>IconEditorGrid.tool</h4> <b>tool</b>(<i></i>) - <p> Public method to get the current drawing tool. </p> + <dl> <dt>Return:</dt> <dd> @@ -1270,10 +1273,10 @@ <a NAME="IconEditorGrid.zoomFactor" ID="IconEditorGrid.zoomFactor"></a> <h4>IconEditorGrid.zoomFactor</h4> <b>zoomFactor</b>(<i></i>) - <p> Public method to get the current zoom factor in percent. </p> + <dl> <dt>Return:</dt> <dd> @@ -1291,33 +1294,45 @@ <hr /> <a NAME="IconEditorTool" ID="IconEditorTool"></a> <h2>IconEditorTool</h2> - <p> Class defining the edit tools. </p> + <h3>Derived from</h3> enum.IntEnum <h3>Class Attributes</h3> - <table> -<tr><td>CIRCLE</td></tr><tr><td>COLOR_PICKER</td></tr><tr><td>ELLIPSE</td></tr><tr><td>FILL</td></tr><tr><td>FILLED_CIRCLE</td></tr><tr><td>FILLED_ELLIPSE</td></tr><tr><td>FILLED_RECTANGLE</td></tr><tr><td>LINE</td></tr><tr><td>PENCIL</td></tr><tr><td>RECTANGLE</td></tr><tr><td>RUBBER</td></tr><tr><td>SELECT_CIRCLE</td></tr><tr><td>SELECT_RECTANGLE</td></tr> +<tr><td>CIRCLE</td></tr> +<tr><td>COLOR_PICKER</td></tr> +<tr><td>ELLIPSE</td></tr> +<tr><td>FILL</td></tr> +<tr><td>FILLED_CIRCLE</td></tr> +<tr><td>FILLED_ELLIPSE</td></tr> +<tr><td>FILLED_RECTANGLE</td></tr> +<tr><td>LINE</td></tr> +<tr><td>PENCIL</td></tr> +<tr><td>RECTANGLE</td></tr> +<tr><td>RUBBER</td></tr> +<tr><td>SELECT_CIRCLE</td></tr> +<tr><td>SELECT_RECTANGLE</td></tr> </table> -<h3>Class Methods</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Static Methods</h3> - +<h3>Class Methods</h3> <table> <tr><td>None</td></tr> </table> +<h3>Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>