Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.IconEditor.IconEditorGrid.html

src/eric7/Documentation/Source/eric7.IconEditor.IconEditorGrid.html

branch
eric7
changeset 10428
a071d4065202
parent 9209
b99e7fd55fd3
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.IconEditor.IconEditorGrid.html	Wed Dec 20 11:06:38 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.IconEditor.IconEditorGrid.html	Wed Dec 20 14:58:58 2023 +0100
@@ -94,22 +94,21 @@
 </p>
 <dl>
 
-<dt><i>grid</i></dt>
+<dt><i>grid</i> (IconEditorGrid)</dt>
 <dd>
-reference to the icon editor grid (IconEditorGrid)
+reference to the icon editor grid
 </dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text for the undo command (string)
+text for the undo command
 </dd>
-<dt><i>oldImage</i></dt>
+<dt><i>oldImage</i> (QImage)</dt>
 <dd>
 copy of the icon before the changes were applied
-            (QImage)
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QUndoCommand)</dt>
 <dd>
-reference to the parent command (QUndoCommand)
+reference to the parent command
 </dd>
 </dl>
 <a NAME="IconEditCommand.redo" ID="IconEditCommand.redo"></a>
@@ -128,9 +127,9 @@
 </p>
 <dl>
 
-<dt><i>image</i></dt>
+<dt><i>image</i> (QImage)</dt>
 <dd>
-copy of the icon after the changes were applied (QImage)
+copy of the icon after the changes were applied
 </dd>
 </dl>
 <a NAME="IconEditCommand.undo" ID="IconEditCommand.undo"></a>
@@ -448,9 +447,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__checkClipboard" ID="IconEditorGrid.__checkClipboard"></a>
@@ -470,9 +469,9 @@
 </p>
 <dl>
 
-<dt><i>clean</i></dt>
+<dt><i>clean</i> (bool)</dt>
 <dd>
-flag indicating the clean state (boolean)
+flag indicating the clean state
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__clipboardImage" ID="IconEditorGrid.__clipboardImage"></a>
@@ -486,7 +485,13 @@
 <dt>Return:</dt>
 <dd>
 tuple with the image (QImage) and a flag indicating a
-            valid image (boolean)
+            valid image
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__drawFlood" ID="IconEditorGrid.__drawFlood"></a>
@@ -498,21 +503,21 @@
 </p>
 <dl>
 
-<dt><i>i</i></dt>
+<dt><i>i</i> (int)</dt>
 <dd>
-x-value in image coordinates (integer)
+x-value in image coordinates
 </dd>
-<dt><i>j</i></dt>
+<dt><i>j</i> (int)</dt>
 <dd>
-y-value in image coordinates (integer)
+y-value in image coordinates
 </dd>
-<dt><i>oldColor</i></dt>
+<dt><i>oldColor</i> (QColor)</dt>
 <dd>
-reference to the color at position i, j (QColor)
+reference to the color at position i, j
 </dd>
-<dt><i>doUpdate</i></dt>
+<dt><i>doUpdate</i> (bool)</dt>
 <dd>
-flag indicating an update is requested (boolean)
+flag indicating an update is requested
             (used for speed optimizations)
 </dd>
 </dl>
@@ -525,9 +530,9 @@
 </p>
 <dl>
 
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
 <dd>
-widget position of the paste rectangle (QPoint)
+widget position of the paste rectangle
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__drawTool" ID="IconEditorGrid.__drawTool"></a>
@@ -540,19 +545,25 @@
 </p>
 <dl>
 
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
 <dd>
-widget coordinate to perform the draw operation at (QPoint)
+widget coordinate to perform the draw operation at
 </dd>
-<dt><i>mark</i></dt>
+<dt><i>mark</i> (bool)</dt>
 <dd>
-flag indicating a mark operation (boolean)
+flag indicating a mark operation
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a successful draw (boolean)
+flag indicating a successful draw
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__getSelectionImage" ID="IconEditorGrid.__getSelectionImage"></a>
@@ -564,15 +575,21 @@
 </p>
 <dl>
 
-<dt><i>cut</i></dt>
+<dt><i>cut</i> (bool)</dt>
 <dd>
-flag indicating to cut the selection (boolean)
+flag indicating to cut the selection
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-image of the selection (QImage)
+image of the selection
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QImage
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__imageCoordinates" ID="IconEditorGrid.__imageCoordinates"></a>
@@ -584,15 +601,21 @@
 </p>
 <dl>
 
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
 <dd>
-widget coordinate (QPoint)
+widget coordinate
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple with the image coordinates (tuple of two integers)
+tuple with the image coordinates
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int)
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__initCursors" ID="IconEditorGrid.__initCursors"></a>
@@ -619,19 +642,25 @@
 </p>
 <dl>
 
-<dt><i>i</i></dt>
+<dt><i>i</i> (int)</dt>
 <dd>
-x-value in image coordinates (integer)
+x-value in image coordinates
 </dd>
-<dt><i>j</i></dt>
+<dt><i>j</i> (int)</dt>
 <dd>
-y-value in image coordinates (integer)
+y-value in image coordinates
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a marked pixel (boolean)
+flag indicating a marked pixel
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__pixelRect" ID="IconEditorGrid.__pixelRect"></a>
@@ -643,19 +672,25 @@
 </p>
 <dl>
 
-<dt><i>i</i></dt>
+<dt><i>i</i> (int)</dt>
 <dd>
-x-coordinate of the pixel in the image (integer)
+x-coordinate of the pixel in the image
 </dd>
-<dt><i>j</i></dt>
+<dt><i>j</i> (int)</dt>
 <dd>
-y-coordinate of the pixel in the image (integer)
+y-coordinate of the pixel in the image
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-rectangle for the given pixel coordinates (QRect)
+rectangle for the given pixel coordinates
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QRect
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__setImagePixel" ID="IconEditorGrid.__setImagePixel"></a>
@@ -667,13 +702,13 @@
 </p>
 <dl>
 
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
 <dd>
-position of the pixel in the widget (QPoint)
+position of the pixel in the widget
 </dd>
-<dt><i>opaque</i></dt>
+<dt><i>opaque</i> (bool)</dt>
 <dd>
-flag indicating a set operation (boolean)
+flag indicating a set operation
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__unMark" ID="IconEditorGrid.__unMark"></a>
@@ -692,15 +727,14 @@
 </p>
 <dl>
 
-<dt><i>ipos1</i></dt>
+<dt><i>ipos1</i> (QPoint)</dt>
 <dd>
 top, left position for the update in image coordinates
-            (QPoint)
 </dd>
-<dt><i>ipos2</i></dt>
+<dt><i>ipos2</i> (QPoint)</dt>
 <dd>
 bottom, right position for the update in image
-            coordinates (QPoint)
+            coordinates
 </dd>
 </dl>
 <a NAME="IconEditorGrid.__updatePreviewPixmap" ID="IconEditorGrid.__updatePreviewPixmap"></a>
@@ -719,15 +753,14 @@
 </p>
 <dl>
 
-<dt><i>pos1</i></dt>
+<dt><i>pos1</i> (QPoint)</dt>
 <dd>
 top, left position for the update in widget coordinates
-            (QPoint)
 </dd>
-<dt><i>pos2</i></dt>
+<dt><i>pos2</i> (QPoint)</dt>
 <dd>
 bottom, right position for the update in widget
-            coordinates (QPoint)
+            coordinates
 </dd>
 </dl>
 <a NAME="IconEditorGrid.canPaste" ID="IconEditorGrid.canPaste"></a>
@@ -740,7 +773,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating availability of paste (boolean)
+flag indicating availability of paste
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IconEditorGrid.canRedo" ID="IconEditorGrid.canRedo"></a>
@@ -753,7 +792,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the availability of redo (boolean)
+flag indicating the availability of redo
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IconEditorGrid.canUndo" ID="IconEditorGrid.canUndo"></a>
@@ -766,7 +811,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the availability of undo (boolean)
+flag indicating the availability of undo
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IconEditorGrid.compositingMode" ID="IconEditorGrid.compositingMode"></a>
@@ -779,7 +830,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-compositing mode (QPainter.CompositionMode)
+compositing mode
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QPainter.CompositionMode
 </dd>
 </dl>
 <a NAME="IconEditorGrid.editClear" ID="IconEditorGrid.editClear"></a>
@@ -819,10 +876,9 @@
 </p>
 <dl>
 
-<dt><i>pasting</i></dt>
+<dt><i>pasting</i> (bool)</dt>
 <dd>
 flag indicating part two of the paste operation
-            (boolean)
 </dd>
 </dl>
 <a NAME="IconEditorGrid.editPasteAsNew" ID="IconEditorGrid.editPasteAsNew"></a>
@@ -877,7 +933,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-copy of the icon image (QImage)
+copy of the icon image
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QImage
 </dd>
 </dl>
 <a NAME="IconEditorGrid.iconSize" ID="IconEditorGrid.iconSize"></a>
@@ -890,7 +952,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-width and height of the image as a tuple (integer, integer)
+width and height of the image as a tuple
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int)
 </dd>
 </dl>
 <a NAME="IconEditorGrid.isDirty" ID="IconEditorGrid.isDirty"></a>
@@ -903,7 +971,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a modified status (boolean)
+flag indicating a modified status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IconEditorGrid.isGridEnabled" ID="IconEditorGrid.isGridEnabled"></a>
@@ -916,7 +990,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-enabled status of the grid lines (boolean)
+enabled status of the grid lines
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IconEditorGrid.isSelectionAvailable" ID="IconEditorGrid.isSelectionAvailable"></a>
@@ -929,7 +1009,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the availability of a selection (boolean)
+flag indicating the availability of a selection
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="IconEditorGrid.mouseMoveEvent" ID="IconEditorGrid.mouseMoveEvent"></a>
@@ -941,9 +1027,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QMouseEvent)</dt>
 <dd>
-reference to the mouse event object (QMouseEvent)
+reference to the mouse event object
 </dd>
 </dl>
 <a NAME="IconEditorGrid.mousePressEvent" ID="IconEditorGrid.mousePressEvent"></a>
@@ -955,9 +1041,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QMouseEvent)</dt>
 <dd>
-reference to the mouse event object (QMouseEvent)
+reference to the mouse event object
 </dd>
 </dl>
 <a NAME="IconEditorGrid.mouseReleaseEvent" ID="IconEditorGrid.mouseReleaseEvent"></a>
@@ -969,9 +1055,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QMouseEvent)</dt>
 <dd>
-reference to the mouse event object (QMouseEvent)
+reference to the mouse event object
 </dd>
 </dl>
 <a NAME="IconEditorGrid.paintEvent" ID="IconEditorGrid.paintEvent"></a>
@@ -983,9 +1069,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QPaintEvent)</dt>
 <dd>
-reference to the paint event object (QPaintEvent)
+reference to the paint event object
 </dd>
 </dl>
 <a NAME="IconEditorGrid.penColor" ID="IconEditorGrid.penColor"></a>
@@ -998,7 +1084,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-current drawing color (QColor)
+current drawing color
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QColor
 </dd>
 </dl>
 <a NAME="IconEditorGrid.previewPixmap" ID="IconEditorGrid.previewPixmap"></a>
@@ -1011,7 +1103,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-preview pixmap (QPixmap)
+preview pixmap
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QPixmap
 </dd>
 </dl>
 <a NAME="IconEditorGrid.setCompositingMode" ID="IconEditorGrid.setCompositingMode"></a>
@@ -1023,9 +1121,9 @@
 </p>
 <dl>
 
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (QPainter.CompositionMode)</dt>
 <dd>
-compositing mode to set (QPainter.CompositionMode)
+compositing mode to set
 </dd>
 </dl>
 <a NAME="IconEditorGrid.setDirty" ID="IconEditorGrid.setDirty"></a>
@@ -1037,14 +1135,13 @@
 </p>
 <dl>
 
-<dt><i>dirty</i></dt>
+<dt><i>dirty</i> (bool)</dt>
 <dd>
-flag indicating the new modification status (boolean)
+flag indicating the new modification status
 </dd>
-<dt><i>setCleanState</i></dt>
+<dt><i>setCleanState</i> (bool)</dt>
 <dd>
 flag indicating to set the undo stack to clean
-            (boolean)
 </dd>
 </dl>
 <a NAME="IconEditorGrid.setGridEnabled" ID="IconEditorGrid.setGridEnabled"></a>
@@ -1056,9 +1153,9 @@
 </p>
 <dl>
 
-<dt><i>enable</i></dt>
+<dt><i>enable</i> (bool)</dt>
 <dd>
-enabled status of the grid lines (boolean)
+enabled status of the grid lines
 </dd>
 </dl>
 <a NAME="IconEditorGrid.setIconImage" ID="IconEditorGrid.setIconImage"></a>
@@ -1070,17 +1167,17 @@
 </p>
 <dl>
 
-<dt><i>newImage</i></dt>
+<dt><i>newImage</i> (QImage)</dt>
 <dd>
-reference to the new image (QImage)
+reference to the new image
 </dd>
-<dt><i>undoRedo</i></dt>
+<dt><i>undoRedo</i> (bool)</dt>
 <dd>
-flag indicating an undo or redo operation (boolean)
+flag indicating an undo or redo operation
 </dd>
-<dt><i>clearUndo</i></dt>
+<dt><i>clearUndo</i> (bool)</dt>
 <dd>
-flag indicating to clear the undo stack (boolean)
+flag indicating to clear the undo stack
 </dd>
 </dl>
 <a NAME="IconEditorGrid.setPenColor" ID="IconEditorGrid.setPenColor"></a>
@@ -1092,9 +1189,9 @@
 </p>
 <dl>
 
-<dt><i>newColor</i></dt>
+<dt><i>newColor</i> (QColor)</dt>
 <dd>
-reference to the new color (QColor)
+reference to the new color
 </dd>
 </dl>
 <a NAME="IconEditorGrid.setTool" ID="IconEditorGrid.setTool"></a>
@@ -1120,9 +1217,9 @@
 </p>
 <dl>
 
-<dt><i>newZoom</i></dt>
+<dt><i>newZoom</i> (int)</dt>
 <dd>
-zoom factor (integer >= 100)
+zoom factor (>= 100)
 </dd>
 </dl>
 <a NAME="IconEditorGrid.shutdown" ID="IconEditorGrid.shutdown"></a>
@@ -1142,7 +1239,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-size hint (QSize)
+size hint
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QSize
 </dd>
 </dl>
 <a NAME="IconEditorGrid.tool" ID="IconEditorGrid.tool"></a>
@@ -1174,7 +1277,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-zoom factor (integer)
+zoom factor
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial