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

-:c712d09cc839
+:f6881d10e995
 @classmethod
 def setIconDatabasePath(cls, enable=True):
 """
 Class method to set the favicons path.
-@param enable flag indicating to enabled icon storage (boolean)
+@param enable flag indicating to enabled icon storage
+@type bool
 """
 if enable:
 iconDatabasePath = os.path.join(
 Globals.getConfigDir(), "web_browser", "favicons"
 )
 def getActions(self):
 """
 Public method to get a list of all actions.
-@return list of all actions (list of EricAction)
+@return list of all actions
+@rtype list of EricAction
 """
 return self.__actions[:]
 def getActionsCategory(self):
 """
 @pyqtSlot()
 def newTab(self, link=None, addNextTo=None, background=False):
 """
 Public slot called to open a new web browser tab.
-@param link file to be displayed in the new window (string or QUrl)
+@param link file to be displayed in the new window
+@type str or QUrl
 @param addNextTo reference to the browser to open the tab after
-(WebBrowserView)
+@type WebBrowserView
-@param background flag indicating to open the tab in the
+@param background flag indicating to open the tab in the background
-background (bool)
+@type bool
 @return reference to the new browser
 @rtype WebBrowserView
 """
 if addNextTo:
 return self.__tabWidget.newBrowserAfter(
 def closeEvent(self, e):
 """
 Protected event handler for the close event.
-@param e the close event (QCloseEvent)
+@param e the close event
 <br />This event is simply accepted after the history has been
 saved and all window references have been deleted.
+@type QCloseEvent
 """
 res = self.__shutdownWindow()
 if res:
 e.accept()
 def __shutdownWindow(self):
 """
 Private method to shut down a web browser window.
-@return flag indicating successful shutdown (boolean)
+@return flag indicating successful shutdown
+@rtype bool
 """
 if (
 not WebBrowserWindow._performingShutdown
 and not self.__forcedClose
 and not self.__tabWidget.shallShutDown()
 def currentBrowser(self):
 """
 Public method to get a reference to the current web browser.
-@return reference to the current help browser (WebBrowserView)
+@return reference to the current help browser
+@rtype WebBrowserView
 """
 return self.__tabWidget.currentBrowser()
 def browserAt(self, index):
 """
 Public method to get a reference to the web browser with the given
 index.
-@param index index of the browser to get (integer)
+@param index index of the browser to get
-@return reference to the indexed web browser (WebBrowserView)
+@type int
+@return reference to the indexed web browser
+@rtype WebBrowserView
 """
 return self.__tabWidget.browserAt(index)
 def browsers(self):
 """
 Public method to get a list of references to all web browsers.
-@return list of references to web browsers (list of WebBrowserView)
+@return list of references to web browsers
+@rtype list of WebBrowserView
 """
 return self.__tabWidget.browsers()
 @pyqtSlot(int)
 def __currentChanged(self, index):
 @classmethod
 def setUseQtHelp(cls, use):
 """
 Class method to set the QtHelp usage.
-@param use flag indicating usage (boolean)
+@param use flag indicating usage
+@type bool
 """
 if use:
 cls._useQtHelp = use and QTHELP_AVAILABLE
 else:
 cls._useQtHelp = False
 @classmethod
 def helpEngine(cls):
 """
 Class method to get a reference to the help engine.
-@return reference to the help engine (QHelpEngine)
+@return reference to the help engine
+@rtype QHelpEngine
 """
 if cls._useQtHelp:
 if cls._helpEngine is None:
 cls._helpEngine = QHelpEngine(
 WebBrowserWindow.getQtHelpCollectionFileName()
 @classmethod
 def networkManager(cls):
 """
 Class method to get a reference to the network manager object.
-@return reference to the network access manager (NetworkManager)
+@return reference to the network access manager
+@rtype NetworkManager
 """
 from .Network.NetworkManager import NetworkManager
 if cls._networkManager is None:
 cls._networkManager = NetworkManager(cls.helpEngine())
 @classmethod
 def cookieJar(cls):
 """
 Class method to get a reference to the cookie jar.
-@return reference to the cookie jar (CookieJar)
+@return reference to the cookie jar
+@rtype CookieJar
 """
 from .CookieJar.CookieJar import CookieJar
 if cls._cookieJar is None:
 cls._cookieJar = CookieJar()
 def __activateDock(self, widget):
 """
 Private method to activate the dock widget of the given widget.
-@param widget reference to the widget to be activated (QWidget)
+@param widget reference to the widget to be activated
+@type QWidget
 """
 widget.parent().show()
 widget.parent().raise_()
 widget.setFocus()
 def getSourceFileList(self):
 """
 Public method to get a list of all opened source files.
 @return dictionary with tab id as key and host/namespace as value
+@rtype dict
 """
 return self.__tabWidget.getSourceFileList()
 @pyqtSlot()
 def __indexingStarted(self):
 def searchEnginesAction(self):
 """
 Public method to get a reference to the search engines configuration
 action.
-@return reference to the search engines configuration action (QAction)
+@return reference to the search engines configuration action
+@rtype QAction
 """
 return self.searchEnginesAct
 @pyqtSlot()
 def __showPasswordsDialog(self):
 @classmethod
 def icon(cls, url):
 """
 Class method to get the icon for an URL.
-@param url URL to get icon for (QUrl)
+@param url URL to get icon for
-@return icon for the URL (QIcon)
+@type QUrl
+@return icon for the URL
+@rtype QIcon
 """
 return WebIconProvider.instance().iconForUrl(url)
 @classmethod
 def bookmarksManager(cls):
 """
 Class method to get a reference to the bookmarks manager.
-@return reference to the bookmarks manager (BookmarksManager)
+@return reference to the bookmarks manager
+@rtype BookmarksManager
 """
 from .Bookmarks.BookmarksManager import BookmarksManager
 if cls._bookmarksManager is None:
 cls._bookmarksManager = BookmarksManager()
 @classmethod
 def historyManager(cls):
 """
 Class method to get a reference to the history manager.
-@return reference to the history manager (HistoryManager)
+@return reference to the history manager
+@rtype HistoryManager
 """
 from .History.HistoryManager import HistoryManager
 if cls._historyManager is None:
 cls._historyManager = HistoryManager()
 @classmethod
 def passwordManager(cls):
 """
 Class method to get a reference to the password manager.
-@return reference to the password manager (PasswordManager)
+@return reference to the password manager
+@rtype PasswordManager
 """
 from .Passwords.PasswordManager import PasswordManager
 if cls._passwordManager is None:
 cls._passwordManager = PasswordManager()
 @classmethod
 def adBlockManager(cls):
 """
 Class method to get a reference to the AdBlock manager.
-@return reference to the AdBlock manager (AdBlockManager)
+@return reference to the AdBlock manager
+@rtype AdBlockManager
 """
 from .AdBlock.AdBlockManager import AdBlockManager
 if cls._adblockManager is None:
 cls._adblockManager = AdBlockManager()
 def adBlockIcon(self):
 """
 Public method to get a reference to the AdBlock icon.
-@return reference to the AdBlock icon (AdBlockIcon)
+@return reference to the AdBlock icon
+@rtype AdBlockIcon
 """
 return self.__adBlockIcon
 @classmethod
 def downloadManager(cls):
 """
 Class method to get a reference to the download manager.
-@return reference to the download manager (DownloadManager)
+@return reference to the download manager
+@rtype DownloadManager
 """
 from .Download.DownloadManager import DownloadManager
 if cls._downloadManager is None:
 cls._downloadManager = DownloadManager()
 def personalInformationManager(cls):
 """
 Class method to get a reference to the personal information manager.
 @return reference to the personal information manager
-(PersonalInformationManager)
+@rtype PersonalInformationManager
 """
 from .PersonalInformationManager import PersonalInformationManager
 if cls._personalInformationManager is None:
 cls._personalInformationManager = (
 @classmethod
 def greaseMonkeyManager(cls):
 """
 Class method to get a reference to the GreaseMonkey manager.
-@return reference to the GreaseMonkey manager (GreaseMonkeyManager)
+@return reference to the GreaseMonkey manager
+@rtype GreaseMonkeyManager
 """
 from .GreaseMonkey.GreaseMonkeyManager import GreaseMonkeyManager
 if cls._greaseMonkeyManager is None:
 cls._greaseMonkeyManager = GreaseMonkeyManager()
 @classmethod
 def mainWindow(cls):
 """
 Class method to get a reference to the main window.
-@return reference to the main window (WebBrowserWindow)
+@return reference to the main window
+@rtype WebBrowserWindow
 """
 if cls.BrowserWindows:
 return cls.BrowserWindows[0]
 else:
 return None
 @classmethod
 def mainWindows(cls):
 """
 Class method to get references to all main windows.
-@return references to all main window (list of WebBrowserWindow)
+@return references to all main window
+@rtype list of WebBrowserWindow
 """
 return cls.BrowserWindows
 @pyqtSlot()
 def __appFocusChanged(self):
 def openSearchManager(self):
 """
 Public method to get a reference to the opensearch manager object.
-@return reference to the opensearch manager object (OpenSearchManager)
+@return reference to the opensearch manager object
+@rtype OpenSearchManager
 """
 return self.__navigationBar.searchEdit().openSearchManager()
 def __createTextEncodingAction(self, codec, defaultCodec, parentMenu, name=None):
 """
 @classmethod
 def feedsManager(cls):
 """
 Class method to get a reference to the RSS feeds manager.
-@return reference to the RSS feeds manager (FeedsManager)
+@return reference to the RSS feeds manager
+@rtype FeedsManager
 """
 from .Feeds.FeedsManager import FeedsManager
 if cls._feedsManager is None:
 cls._feedsManager = FeedsManager()
 @classmethod
 def userAgentsManager(cls):
 """
 Class method to get a reference to the user agents manager.
-@return reference to the user agents manager (UserAgentManager)
+@return reference to the user agents manager
+@rtype UserAgentManager
 """
 from .UserAgent.UserAgentManager import UserAgentManager
 if cls._userAgentsManager is None:
 cls._userAgentsManager = UserAgentManager()
 @classmethod
 def syncManager(cls):
 """
 Class method to get a reference to the data synchronization manager.
-@return reference to the data synchronization manager (SyncManager)
+@return reference to the data synchronization manager
+@rtype SyncManager
 """
 from .Sync.SyncManager import SyncManager
 if cls._syncManager is None:
 cls._syncManager = SyncManager()
 @classmethod
 def speedDial(cls):
 """
 Class method to get a reference to the speed dial.
-@return reference to the speed dial (SpeedDial)
+@return reference to the speed dial
+@rtype SpeedDial
 """
 from .SpeedDial.SpeedDial import SpeedDial
 if cls._speedDial is None:
 cls._speedDial = SpeedDial()
 def keyPressEvent(self, evt):
 """
 Protected method to handle key presses.
-@param evt reference to the key press event (QKeyEvent)
+@param evt reference to the key press event
+@type QKeyEvent
 """
 number = -1
 key = evt.key()
 if key == Qt.Key.Key_1:
 def requestVirusTotalScan(self, url):
 """
 Public method to submit a request to scan an URL by VirusTotal.
-@param url URL to be scanned (QUrl)
+@param url URL to be scanned
+@type QUrl
 """
 self.__virusTotal.submitUrl(url)
 @pyqtSlot(str)
 def __virusTotalSubmitUrlError(self, msg):
 def __setUserStyleSheet(self, styleSheetFile):
 """
 Private method to set a user style sheet.
-@param styleSheetFile name of the user style sheet file (string)
+@param styleSheetFile name of the user style sheet file
+@type str
 """
 from .WebBrowserPage import WebBrowserPage
 name = "_eric_userstylesheet"
 userStyle = ""

Mercurial Repositories > eric / file comparison

comparison: src/eric7/WebBrowser/WebBrowserWindow.py

src/eric7/WebBrowser/WebBrowserWindow.py