eric: comparison src/eric7/WebBrowser/WebBrowserView.py

-:c712d09cc839
+:f6881d10e995
 def __init__(self, mainWindow, parent=None, name=""):
 """
 Constructor
-@param mainWindow reference to the main window (WebBrowserWindow)
+@param mainWindow reference to the main window
-@param parent parent widget of this window (QWidget)
+@type WebBrowserWindow
-@param name name of this window (string)
+@param parent parent widget of this window
+@type QWidget
+@param name name of this window
+@type str
 """
 super().__init__(parent)
 self.setObjectName(name)
 self.__rwhvqt = None
 def setSource(self, name, newTab=False):
 """
 Public method used to set the source to be displayed.
-@param name filename to be shown (QUrl)
+@param name filename to be shown
-@param newTab flag indicating to open the URL in a new tab (bool)
+@type QUrl
+@param newTab flag indicating to open the URL in a new tab
+@type bool
 """
 if name is None or not name.isValid():
 return
 if newTab:
 def source(self):
 """
 Public method to return the URL of the loaded page.
-@return URL loaded in the help browser (QUrl)
+@return URL loaded in the help browser
+@rtype QUrl
 """
 return self.url()
 def documentTitle(self):
 """
 Public method to return the title of the loaded page.
-@return title (string)
+@return title
+@rtype str
 """
 return self.title()
 def backward(self):
 """
 def isForwardAvailable(self):
 """
 Public method to determine, if a forward move in history is possible.
-@return flag indicating move forward is possible (boolean)
+@return flag indicating move forward is possible
+@rtype bool
 """
 return self.history().canGoForward()
 def isBackwardAvailable(self):
 """
 Public method to determine, if a backwards move in history is possible.
-@return flag indicating move backwards is possible (boolean)
+@return flag indicating move backwards is possible
+@rtype bool
 """
 return self.history().canGoBack()
 def __levelForZoom(self, zoom):
 """
 Private method determining the zoom level index given a zoom factor.
-@param zoom zoom factor (integer)
+@param zoom zoom factor
-@return index of zoom factor (integer)
+@type int
+@return index of zoom factor
+@rtype int
 """
 try:
 index = self.__zoomLevels.index(zoom)
 except ValueError:
 for index in range(len(self.__zoomLevels)):
 def setZoomValue(self, value, saveValue=True):
 """
 Public method to set the zoom value.
-@param value zoom value (integer)
+@param value zoom value
+@type int
 @param saveValue flag indicating to save the zoom value with the
 zoom manager
 @type bool
 """
 if value != self.__currentZoom:
 def zoomValue(self):
 """
 Public method to get the current zoom value.
-@return zoom value (integer)
+@return zoom value
+@rtype int
 """
 val = self.zoomFactor() * 100
 return int(val)
 def zoomIn(self):
 def hasSelection(self):
 """
 Public method to determine, if there is some text selected.
-@return flag indicating text has been selected (boolean)
+@return flag indicating text has been selected
+@rtype bool
 """
 return self.selectedText() != ""
 def findNextPrev(self, txt, case, backwards, callback):
 """
 Public slot to find the next occurrence of a text.
-@param txt text to search for (string)
+@param txt text to search for
-@param case flag indicating a case sensitive search (boolean)
+@type str
-@param backwards flag indicating a backwards search (boolean)
+@param case flag indicating a case sensitive search
+@type bool
+@param backwards flag indicating a backwards search
+@type bool
 @param callback reference to a function with a bool parameter
 @type function(bool) or None
 """
 findFlags = QWebEnginePage.FindFlag(0)
 if case:
 def __isUrlValid(self, url):
 """
 Private method to check a URL for validity.
-@param url URL to be checked (QUrl)
+@param url URL to be checked
-@return flag indicating a valid URL (boolean)
+@type QUrl
+@return flag indicating a valid URL
+@rtype bool
 """
 return (
 url.isValid()
 and bool(url.host())
 and bool(url.scheme())
 def __searchRequested(self, act):
 """
 Private slot to search for some text with a selected search engine.
-@param act reference to the action that triggered this slot (QAction)
+@param act reference to the action that triggered this slot
+@type QAction
 """
 searchText = self.selectedText()
 if not searchText:
 return
 def dragEnterEvent(self, evt):
 """
 Protected method called by a drag enter event.
-@param evt reference to the drag enter event (QDragEnterEvent)
+@param evt reference to the drag enter event
+@type QDragEnterEvent
 """
 evt.acceptProposedAction()
 def dragMoveEvent(self, evt):
 """
 Protected method called by a drag move event.
-@param evt reference to the drag move event (QDragMoveEvent)
+@param evt reference to the drag move event
+@type QDragMoveEvent
 """
 evt.ignore()
 if evt.source() != self:
 if len(evt.mimeData().urls()) > 0:
 evt.acceptProposedAction()
 def dropEvent(self, evt):
 """
 Protected method called by a drop event.
-@param evt reference to the drop event (QDropEvent)
+@param evt reference to the drop event
+@type QDropEvent
 """
 super().dropEvent(evt)
 if (
 not evt.isAccepted()
 and evt.source() != self
 def _mousePressEvent(self, evt):
 """
 Protected method called by a mouse press event.
-@param evt reference to the mouse event (QMouseEvent)
+@param evt reference to the mouse event
+@type QMouseEvent
 """
 if WebBrowserWindow.autoScroller().mousePress(self, evt):
 evt.accept()
 return
 def _mouseReleaseEvent(self, evt):
 """
 Protected method called by a mouse release event.
-@param evt reference to the mouse event (QMouseEvent)
+@param evt reference to the mouse event
+@type QMouseEvent
 """
 if WebBrowserWindow.autoScroller().mouseRelease(evt):
 evt.accept()
 return
 def _mouseMoveEvent(self, evt):
 """
 Protected method to handle mouse move events.
-@param evt reference to the mouse event (QMouseEvent)
+@param evt reference to the mouse event
+@type QMouseEvent
 """
 if self.__mw and self.__mw.isFullScreen():
 if self.__mw.isFullScreenNavigationVisible():
 self.__mw.hideFullScreenNavigation()
 elif evt.y() < 10:
 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 WebBrowserWindow.autoScroller().wheel():
 evt.accept()
 return
 def _keyPressEvent(self, evt):
 """
 Protected method called by a key press.
-@param evt reference to the key event (QKeyEvent)
+@param evt reference to the key event
+@type QKeyEvent
 """
 if self.__mw.personalInformationManager().viewKeyPressEvent(self, evt):
 evt.accept()
 return
 def _keyReleaseEvent(self, evt):
 """
 Protected method called by a key release.
-@param evt reference to the key event (QKeyEvent)
+@param evt reference to the key event
+@type QKeyEvent
 """
 if evt.key() == Qt.Key.Key_Escape and self.isFullScreen():
 self.triggerPageAction(QWebEnginePage.WebAction.ExitFullScreen)
 evt.accept()
 self.requestFullScreen(False)
 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
 def __urlChanged(self, url):
 """
 Private slot to handle the urlChanged signal.
-@param url the new url (QUrl)
+@param url the new url
+@type QUrl
 """
 self.sourceChanged.emit(url)
 self.forwardAvailable.emit(self.isForwardAvailable())
 self.backwardAvailable.emit(self.isBackwardAvailable())
 def __linkHovered(self, link):
 """
 Private slot to handle the linkHovered signal.
-@param link the URL of the link (string)
+@param link the URL of the link
+@type str
 """
 self.highlighted.emit(link)
 ###########################################################################
 ## Signal handlers below
 def __loadProgress(self, progress):
 """
 Private method to handle the loadProgress signal.
-@param progress progress value (integer)
+@param progress progress value
+@type int
 """
 self.__progress = progress
 def __loadFinished(self, ok):
 """
 Private method to handle the loadFinished signal.
-@param ok flag indicating the result (boolean)
+@param ok flag indicating the result
+@type bool
 """
 self.__isLoading = False
 self.__progress = 0
 QApplication.processEvents()
 def isLoading(self):
 """
 Public method to get the loading state.
-@return flag indicating the loading state (boolean)
+@return flag indicating the loading state
+@rtype bool
 """
 return self.__isLoading
 def progress(self):
 """
 Public method to get the load progress.
-@return load progress (integer)
+@return load progress
+@rtype int
 """
 return self.__progress
 def __renderPreview(self):
 """
 def createWindow(self, windowType):
 """
 Public method called, when a new window should be created.
 @param windowType type of the requested window
-(QWebEnginePage.WebWindowType)
+@type QWebEnginePage.WebWindowType
-@return reference to the created browser window (WebBrowserView)
+@return reference to the created browser window
+@rtype WebBrowserView
 """
 if windowType in [
 QWebEnginePage.WebWindowType.WebBrowserTab,
 QWebEnginePage.WebWindowType.WebDialog,
 ]:
 def checkRSS(self):
 """
 Public method to check, if the loaded page contains feed links.
-@return flag indicating the existence of feed links (boolean)
+@return flag indicating the existence of feed links
+@rtype bool
 """
 self.__rss = []
 script = Scripts.getFeedLinks()
 feeds = self.page().execJavaScript(script)
 def getRSS(self):
 """
 Public method to get the extracted RSS feeds.
-@return list of RSS feeds (list of tuples of two strings)
+@return list of RSS feeds
+@rtype list of [(str, str)]
 """
 return self.__rss
 def hasRSS(self):
 """
 Public method to check, if the loaded page has RSS links.
-@return flag indicating the presence of RSS links (boolean)
+@return flag indicating the presence of RSS links
+@rtype bool
 """
 return len(self.__rss) > 0
 ###########################################################################
 ## Full Screen handling below

Mercurial Repositories > eric / file comparison

comparison: src/eric7/WebBrowser/WebBrowserView.py

src/eric7/WebBrowser/WebBrowserView.py