diff -r c712d09cc839 -r f6881d10e995 src/eric7/WebBrowser/Bookmarks/AddBookmarkDialog.py
--- a/src/eric7/WebBrowser/Bookmarks/AddBookmarkDialog.py Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/Bookmarks/AddBookmarkDialog.py Fri Dec 22 17:24:07 2023 +0100
@@ -24,7 +24,8 @@
"""
Constructor
- @param parent reference to the parent object (QObject)
+ @param parent reference to the parent object
+ @type QObject
"""
super().__init__(parent)
@@ -32,8 +33,10 @@
"""
Public method to return the number of columns.
- @param parent index of the parent (QModelIndex)
- @return number of columns (integer)
+ @param parent index of the parent
+ @type QModelIndex
+ @return number of columns
+ @rtype int
"""
return min(1, QSortFilterProxyModel.columnCount(self, parent))
@@ -41,9 +44,12 @@
"""
Public method to determine, if the row is acceptable.
- @param sourceRow row number in the source model (integer)
- @param sourceParent index of the source item (QModelIndex)
- @return flag indicating acceptance (boolean)
+ @param sourceRow row number in the source model
+ @type int
+ @param sourceParent index of the source item
+ @type QModelIndex
+ @return flag indicating acceptance
+ @rtype bool
"""
idx = self.sourceModel().index(sourceRow, 0, sourceParent)
return self.sourceModel().hasChildren(idx)
@@ -52,9 +58,12 @@
"""
Public method to determine, if the column is acceptable.
- @param sourceColumn column number in the source model (integer)
- @param sourceParent index of the source item (QModelIndex)
- @return flag indicating acceptance (boolean)
+ @param sourceColumn column number in the source model
+ @type int
+ @param sourceParent index of the source item
+ @type QModelIndex
+ @return flag indicating acceptance
+ @rtype bool
"""
return sourceColumn == 0
@@ -62,8 +71,10 @@
"""
Public method to check, if a parent node has some children.
- @param parent index of the parent node (QModelIndex)
- @return flag indicating the presence of children (boolean)
+ @param parent index of the parent node
+ @type QModelIndex
+ @return flag indicating the presence of children
+ @rtype bool
"""
if parent is None:
parent = QModelIndex()
@@ -80,9 +91,10 @@
"""
Constructor
- @param parent reference to the parent widget (QWidget)
- @param bookmarksManager reference to the bookmarks manager
- object (BookmarksManager)
+ @param parent reference to the parent widget
+ @type QWidget
+ @param bookmarksManager reference to the bookmarks manager object
+ @type BookmarksManager
"""
super().__init__(parent)
self.setupUi(self)
@@ -117,7 +129,8 @@
"""
Public slot to set the URL of the new bookmark.
- @param url URL of the bookmark (string)
+ @param url URL of the bookmark
+ @type str
"""
self.addressEdit.setText(url)
self.resize(self.sizeHint())
@@ -126,7 +139,8 @@
"""
Public method to get the URL of the bookmark.
- @return URL of the bookmark (string)
+ @return URL of the bookmark
+ @rtype str
"""
return self.addressEdit.text()
@@ -134,7 +148,8 @@
"""
Public method to set the title of the new bookmark.
- @param title title of the bookmark (string)
+ @param title title of the bookmark
+ @type str
"""
self.nameEdit.setText(title)
@@ -142,7 +157,8 @@
"""
Public method to get the title of the bookmark.
- @return title of the bookmark (string)
+ @return title of the bookmark
+ @rtype str
"""
return self.nameEdit.text()
@@ -150,7 +166,8 @@
"""
Public method to set the description of the new bookmark.
- @param description description of the bookamrk (string)
+ @param description description of the bookamrk
+ @type str
"""
self.descriptionEdit.setPlainText(description)
@@ -158,7 +175,8 @@
"""
Public method to get the description of the bookmark.
- @return description of the bookamrk (string)
+ @return description of the bookamrk
+ @rtype str
"""
return self.descriptionEdit.toPlainText()
@@ -166,7 +184,8 @@
"""
Public method to set the current index.
- @param idx current index to be set (QModelIndex)
+ @param idx current index to be set
+ @type QModelIndex
"""
proxyIndex = self.__proxyModel.mapFromSource(idx)
self.__treeView.setCurrentIndex(proxyIndex)
@@ -176,7 +195,8 @@
"""
Public method to get the current index.
- @return current index (QModelIndex)
+ @return current index
+ @rtype QModelIndex
"""
idx = self.locationCombo.view().currentIndex()
idx = self.__proxyModel.mapToSource(idx)
@@ -186,7 +206,8 @@
"""
Public method to set the dialog to "Add Folder" mode.
- @param folder flag indicating "Add Folder" mode (boolean)
+ @param folder flag indicating "Add Folder" mode
+ @type bool
"""
self.__addFolder = folder
@@ -205,7 +226,8 @@
"""
Public method to test, if the dialog is in "Add Folder" mode.
- @return flag indicating "Add Folder" mode (boolean)
+ @return flag indicating "Add Folder" mode
+ @rtype bool
"""
return self.__addFolder
@@ -213,7 +235,8 @@
"""
Public method to get a reference to the added bookmark node.
- @return reference to the added bookmark node (BookmarkNode)
+ @return reference to the added bookmark node
+ @rtype BookmarkNode
"""
return self.__addedNode
