--- a/src/eric7/WebBrowser/SpeedDial/SpeedDial.py Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/SpeedDial/SpeedDial.py Fri Dec 22 17:24:07 2023 +0100
@@ -46,7 +46,8 @@
"""
Constructor
- @param parent reference to the parent object (QObject)
+ @param parent reference to the parent object
+ @type QObject
"""
super().__init__(parent)
@@ -68,8 +69,10 @@
"""
Public method to add a page for the given data.
- @param url URL of the page (QUrl)
- @param title title of the page (string)
+ @param url URL of the page
+ @type QUrl
+ @param title title of the page
+ @type str
"""
if url.isEmpty():
return
@@ -84,7 +87,8 @@
"""
Public method to remove a page.
- @param url URL of the page (QUrl)
+ @param url URL of the page
+ @type QUrl
"""
page = self.pageForUrl(url)
if not page.isValid():
@@ -100,8 +104,10 @@
"""
Private method to generate the image file name for a URL.
- @param url URL to generate the file name from (string)
- @return name of the image file (string)
+ @param url URL to generate the file name from
+ @type str
+ @return name of the image file
+ @rtype str
"""
return os.path.join(
self.__thumbnailsDirectory,
@@ -118,7 +124,8 @@
"""
Public method to get the 'initial' JavaScript script.
- @return initial JavaScript script (string)
+ @return initial JavaScript script
+ @rtype str
"""
if self.__regenerateScript:
self.__regenerateScript = False
@@ -148,7 +155,8 @@
"""
Public method to get the file name of the user agents file.
- @return name of the user agents file (string)
+ @return name of the user agents file
+ @rtype str
"""
return os.path.join(Globals.getConfigDir(), "web_browser", "speedDial.xml")
@@ -255,8 +263,10 @@
"""
Public method to get the page for the given URL.
- @param url URL to be searched for (QUrl)
- @return page for the URL (Page)
+ @param url URL to be searched for
+ @type QUrl
+ @return page for the URL
+ @rtype Page
"""
urlString = url.toString()
if urlString.endswith("/"):
@@ -272,8 +282,10 @@
"""
Public method to get the URL for the given shortcut key.
- @param key shortcut key (integer)
- @return URL for the key (QUrl)
+ @param key shortcut key
+ @type int
+ @return URL for the key
+ @rtype QUrl
"""
if key < 0 or len(self.__webPages) <= key:
return QUrl()
@@ -285,7 +297,8 @@
"""
Public slot to react on changed pages.
- @param allPages string giving all pages (string)
+ @param allPages string giving all pages
+ @type str
"""
if not allPages:
return
@@ -350,7 +363,8 @@
"""
Public slot to remove the image for a URL.
- @param url URL to remove the image for (string)
+ @param url URL to remove the image for
+ @type str
"""
fileName = self.__imageFileName(url)
if os.path.exists(fileName):
@@ -361,8 +375,10 @@
"""
Public slot to get the URL from user input.
- @param url URL entered by the user (string)
- @return sanitized URL (string)
+ @param url URL entered by the user
+ @type str
+ @return sanitized URL
+ @rtype str
"""
return QUrl.fromUserInput(url).toString()
@@ -371,7 +387,8 @@
"""
Public slot to set the number of pages per row.
- @param count number of pages per row (integer)
+ @param count number of pages per row
+ @type int
"""
self.__pagesPerRow = count
self.__saveTimer.changeOccurred()
@@ -380,7 +397,8 @@
"""
Public method to get the number of dials per row.
- @return number of dials per row (integer)
+ @return number of dials per row
+ @rtype int
"""
return self.__pagesPerRow
@@ -389,7 +407,8 @@
"""
Public slot to set the size of the speed dial.
- @param size size of the speed dial (integer)
+ @param size size of the speed dial
+ @type int
"""
self.__speedDialSize = size
self.__saveTimer.changeOccurred()
@@ -398,7 +417,8 @@
"""
Public method to get the speed dial size.
- @return speed dial size (integer)
+ @return speed dial size
+ @rtype int
"""
return self.__speedDialSize
