--- a/src/eric7/WebBrowser/WebBrowserWindow.py Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/WebBrowserWindow.py Fri Dec 22 17:24:07 2023 +0100
@@ -529,7 +529,8 @@
"""
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(
@@ -2302,7 +2303,8 @@
"""
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[:]
@@ -2806,11 +2808,12 @@
"""
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)
- @param background flag indicating to open the tab in the
- background (bool)
+ @type WebBrowserView
+ @param background flag indicating to open the tab in the background
+ @type bool
@return reference to the new browser
@rtype WebBrowserView
"""
@@ -3187,9 +3190,10 @@
"""
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()
@@ -3212,7 +3216,8 @@
"""
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
@@ -3596,7 +3601,8 @@
"""
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()
@@ -3605,8 +3611,10 @@
Public method to get a reference to the web browser with the given
index.
- @param index index of the browser to get (integer)
- @return reference to the indexed web browser (WebBrowserView)
+ @param index index of the browser to get
+ @type int
+ @return reference to the indexed web browser
+ @rtype WebBrowserView
"""
return self.__tabWidget.browserAt(index)
@@ -3614,7 +3622,8 @@
"""
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()
@@ -3770,7 +3779,8 @@
"""
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
@@ -3782,7 +3792,8 @@
"""
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:
@@ -3812,7 +3823,8 @@
"""
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
@@ -3826,7 +3838,8 @@
"""
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
@@ -3922,7 +3935,8 @@
"""
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_()
@@ -3976,6 +3990,7 @@
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()
@@ -4180,7 +4195,8 @@
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
@@ -4291,8 +4307,10 @@
"""
Class method to get the icon for an URL.
- @param url URL to get icon for (QUrl)
- @return icon for the URL (QIcon)
+ @param url URL to get icon for
+ @type QUrl
+ @return icon for the URL
+ @rtype QIcon
"""
return WebIconProvider.instance().iconForUrl(url)
@@ -4301,7 +4319,8 @@
"""
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
@@ -4390,7 +4409,8 @@
"""
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
@@ -4404,7 +4424,8 @@
"""
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
@@ -4418,7 +4439,8 @@
"""
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
@@ -4431,7 +4453,8 @@
"""
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
@@ -4440,7 +4463,8 @@
"""
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
@@ -4455,7 +4479,7 @@
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
@@ -4471,7 +4495,8 @@
"""
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
@@ -4562,7 +4587,8 @@
"""
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]
@@ -4574,7 +4600,8 @@
"""
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
@@ -4605,7 +4632,8 @@
"""
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()
@@ -4867,7 +4895,8 @@
"""
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
@@ -4919,7 +4948,8 @@
"""
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
@@ -4943,7 +4973,8 @@
"""
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
@@ -4964,7 +4995,8 @@
"""
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
@@ -4977,7 +5009,8 @@
"""
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()
@@ -5085,7 +5118,8 @@
"""
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)
@@ -5179,7 +5213,8 @@
"""
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
