eric: comparison src/eric7/IconEditor/IconEditorWindow.py

-:3733e2b23cf7
+:a071d4065202
 project=None,
 ):
 """
 Constructor
-@param fileName name of a file to load on startup (string)
+@param fileName name of a file to load on startup
-@param parent parent widget of this window (QWidget)
+@type str
+@param parent parent widget of this window
+@type QWidget
 @param fromEric flag indicating whether it was called from within
-eric (boolean)
+eric
+@type bool
 @param initShortcutsOnly flag indicating to just initialize the
-keyboard shortcuts (boolean)
+keyboard shortcuts
-@param project reference to the project object (Project)
+@type bool
+@param project reference to the project object
+@type Project
 """
 super().__init__(parent)
 self.setObjectName("eric7_icon_editor")
 self.fromEric = fromEric
 def closeEvent(self, evt):
 """
 Protected event handler for the close event.
-@param evt the close event (QCloseEvent)
+@param evt the close event
-<br />This event is simply accepted after the history has been
+@type QCloseEvent
-saved and all window references have been deleted.
+<br />This event is simply accepted after the history has been
+saved and all window references have been deleted.
 """
 if self.__maybeSave():
 self.__editor.shutdown()
 state = self.saveState()
 def __saveIcon(self):
 """
 Private slot to save the icon.
-@return flag indicating success (boolean)
+@return flag indicating success
+@rtype bool
 """
 if not self.__fileName:
 return self.__saveIconAs()
 else:
 return self.__saveIconFile(self.__fileName)
 def __saveIconAs(self):
 """
 Private slot to save the icon with a new name.
-@return flag indicating success (boolean)
+@return flag indicating success
+@rtype bool
 """
 if (
 not self.__lastSavePath
 and self.__project is not None
 and self.__project.isOpen()
 def __loadIconFile(self, fileName):
 """
 Private method to load an icon file.
-@param fileName name of the icon file to load (string).
+@param fileName name of the icon file to load
+@type str
 """
 img = QImage(fileName)
 if img.isNull():
 EricMessageBox.warning(
 self,
 def __saveIconFile(self, fileName):
 """
 Private method to save to the given file.
-@param fileName name of the file to save to (string)
+@param fileName name of the file to save to
-@return flag indicating success (boolean)
+@type str
+@return flag indicating success
+@rtype bool
 """
 img = self.__editor.iconImage()
 res = img.save(fileName)
 if not res:
 def __setCurrentFile(self, fileName):
 """
 Private method to register the file name of the current file.
-@param fileName name of the file to register (string)
+@param fileName name of the file to register
+@type str
 """
 self.__fileName = fileName
 shownName = (
 self.__strippedName(self.__fileName)
 def __strippedName(self, fullFileName):
 """
 Private method to return the filename part of the given path.
-@param fullFileName full pathname of the given file (string)
+@param fullFileName full pathname of the given file
-@return filename part (string)
+@type str
+@return filename part
+@rtype str
 """
 return pathlib.Path(fullFileName).name
 def __maybeSave(self):
 """
 Private method to ask the user to save the file, if it was modified.
-@return flag indicating, if it is ok to continue (boolean)
+@return flag indicating, if it is ok to continue
+@rtype bool
 """
 if self.__editor.isDirty():
 ret = EricMessageBox.okToClearData(
 self,
 self.tr("eric Icon Editor"),
 def setRecentPaths(self, openPath, savePath):
 """
 Public method to set the last open and save paths.
-@param openPath least recently used open path (string)
+@param openPath least recently used open path
-@param savePath least recently used save path (string)
+@type str
+@param savePath least recently used save path
+@type str
 """
 if openPath:
 self.__lastOpenPath = openPath
 if savePath:
 self.__lastSavePath = savePath
 def __modificationChanged(self, m):
 """
 Private slot to handle the modificationChanged signal.
 @param m modification status
+@type bool
 """
 self.setWindowModified(m)
 self.__checkActions()
 def __updatePosition(self, x, y):
 """
 Private slot to show the current cursor position.
-@param x x-coordinate (integer)
+@param x x-coordinate
-@param y y-coordinate (integer)
+@type int
+@param y y-coordinate
+@type int
 """
 self.__sbPos.setText("X: {0:d} Y: {1:d}".format(x + 1, y + 1))
 def __updateSize(self, w, h):
 """
 Private slot to show the current icon size.
-@param w width of the icon (integer)
+@param w width of the icon
-@param h height of the icon (integer)
+@type int
+@param h height of the icon
+@type int
 """
 self.__sbSize.setText("Size: {0:d} x {1:d}".format(w, h))
 def __updateZoom(self):
 """
 def wheelEvent(self, evt):
 """
 Protected method to handle wheel events.
-@param evt reference to the wheel event (QWheelEvent)
+@param evt reference to the wheel event
+@type QWheelEvent
 """
 if evt.modifiers() & Qt.KeyboardModifier.ControlModifier:
 delta = evt.angleDelta().y()
 if delta < 0:
 self.__zoomOut()
 def event(self, evt):
 """
 Public method handling events.
-@param evt reference to the event (QEvent)
+@param evt reference to the event
-@return flag indicating, if the event was handled (boolean)
+@type QEvent
+@return flag indicating, if the event was handled
+@rtype bool
 """
 if evt.type() == QEvent.Type.Gesture:
 self.gestureEvent(evt)
 return True

Mercurial Repositories > eric / file comparison

comparison: src/eric7/IconEditor/IconEditorWindow.py

src/eric7/IconEditor/IconEditorWindow.py