--- a/src/eric7/WebBrowser/Bookmarks/BookmarksModel.py Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/Bookmarks/BookmarksModel.py Fri Dec 22 17:24:07 2023 +0100
@@ -42,9 +42,10 @@
"""
Constructor
- @param manager reference to the bookmark manager object
- (BookmarksManager)
- @param parent reference to the parent object (QObject)
+ @param manager reference to the bookmarks manager object
+ @type BookmarksManager
+ @param parent reference to the parent object
+ @type QObject
"""
super().__init__(parent)
@@ -64,7 +65,8 @@
"""
Public method to get a reference to the bookmarks manager.
- @return reference to the bookmarks manager object (BookmarksManager)
+ @return reference to the bookmarks manager object
+ @rtype BookmarksManager
"""
return self.__bookmarksManager
@@ -72,8 +74,10 @@
"""
Public method to get a model index.
- @param node reference to the node to get the index for (BookmarkNode)
- @return model index (QModelIndex)
+ @param node reference to the node to get the index for
+ @type BookmarkNode
+ @return model index
+ @rtype QModelIndex
"""
parent = node.parent()
if parent is None:
@@ -84,7 +88,8 @@
"""
Public slot to add a bookmark node.
- @param node reference to the bookmark node to add (BookmarkNode)
+ @param node reference to the bookmark node to add
+ @type BookmarkNode
"""
if node is None or node.parent() is None:
return
@@ -101,9 +106,12 @@
"""
Public slot to remove a bookmark node.
- @param parent reference to the parent bookmark node (BookmarkNode)
- @param row row number of the node (integer)
- @param node reference to the bookmark node to remove (BookmarkNode)
+ @param parent reference to the parent bookmark node
+ @type BookmarkNode
+ @param row row number of the node
+ @type int
+ @param node reference to the bookmark node to remove
+ @type BookmarkNode
"""
# node was already removed, re-add so beginRemoveRows works
parent.add(node, row)
@@ -115,7 +123,8 @@
"""
Public method to change a node.
- @param node reference to the bookmark node to change (BookmarkNode)
+ @param node reference to the bookmark node to change
+ @type BookmarkNode
"""
idx = self.nodeIndex(node)
self.dataChanged.emit(idx, idx)
@@ -124,10 +133,14 @@
"""
Public method to remove bookmarks from the model.
- @param row row of the first bookmark to remove (integer)
- @param count number of bookmarks to remove (integer)
- @param parent index of the parent bookmark node (QModelIndex)
- @return flag indicating successful removal (boolean)
+ @param row row of the first bookmark to remove
+ @type int
+ @param count number of bookmarks to remove
+ @type int
+ @param parent index of the parent bookmark node
+ @type QModelIndex
+ @return flag indicating successful removal
+ @rtype bool
"""
if parent is None:
parent = QModelIndex()
@@ -155,10 +168,14 @@
"""
Public method to get the header data.
- @param section section number (integer)
- @param orientation header orientation (Qt.Orientation)
- @param role data role (Qt.ItemDataRole)
+ @param section section number
+ @type int
+ @param orientation header orientation
+ @type Qt.Orientation
+ @param role data role
+ @type Qt.ItemDataRole
@return header data
+ @rtype Any
"""
if (
orientation == Qt.Orientation.Horizontal
@@ -172,9 +189,12 @@
"""
Public method to get data from the model.
- @param index index of bookmark to get data for (QModelIndex)
- @param role data role (integer)
+ @param index index of bookmark to get data for
+ @type QModelIndex
+ @param role data role
+ @type int
@return bookmark data
+ @rtype Any
"""
from .BookmarkNode import BookmarkNode
@@ -221,8 +241,10 @@
"""
Public method to get the number of columns.
- @param parent index of parent (QModelIndex)
- @return number of columns (integer)
+ @param parent index of parent
+ @type QModelIndex
+ @return number of columns
+ @rtype int
"""
if parent is None:
parent = QModelIndex()
@@ -236,8 +258,10 @@
"""
Public method to determine the number of rows.
- @param parent index of parent (QModelIndex)
- @return number of rows (integer)
+ @param parent index of parent
+ @type QModelIndex
+ @return number of rows
+ @rtype int
"""
if parent is None:
parent = QModelIndex()
@@ -255,10 +279,14 @@
"""
Public method to get a model index for a node cell.
- @param row row number (integer)
- @param column column number (integer)
- @param parent index of the parent (QModelIndex)
- @return index (QModelIndex)
+ @param row row number
+ @type int
+ @param column column number
+ @type int
+ @param parent index of the parent
+ @type QModelIndex
+ @return index
+ @rtype QModelIndex
"""
if parent is None:
parent = QModelIndex()
@@ -278,8 +306,10 @@
"""
Public method to get the index of the parent node.
- @param index index of the child node (QModelIndex)
- @return index of the parent node (QModelIndex)
+ @param index index of the child node
+ @type QModelIndex
+ @return index of the parent node
+ @rtype QModelIndex
"""
if index is None:
index = QModelIndex()
@@ -302,8 +332,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
"""
from .BookmarkNode import BookmarkNode
@@ -320,8 +352,10 @@
"""
Public method to get flags for a node cell.
- @param index index of the node cell (QModelIndex)
- @return flags (Qt.ItemFlags)
+ @param index index of the node cell
+ @type QModelIndex
+ @return flags
+ @rtype Qt.ItemFlags
"""
from .BookmarkNode import BookmarkNode
@@ -351,7 +385,8 @@
"""
Public method to report the supported drop actions.
- @return supported drop actions (Qt.DropAction)
+ @return supported drop actions
+ @rtype Qt.DropAction
"""
return Qt.DropAction.CopyAction | Qt.DropAction.MoveAction
@@ -359,7 +394,8 @@
"""
Public method to report the supported mime types.
- @return supported mime types (list of strings)
+ @return supported mime types
+ @rtype list of str
"""
return [self.MIMETYPE, "text/uri-list"]
@@ -367,8 +403,10 @@
"""
Public method to return the mime data.
- @param indexes list of indexes (QModelIndexList)
- @return mime data (QMimeData)
+ @param indexes list of indexes
+ @type QModelIndexList
+ @return mime data
+ @rtype QMimeData
"""
from .XbelWriter import XbelWriter
@@ -398,12 +436,18 @@
"""
Public method to accept the mime data of a drop action.
- @param data reference to the mime data (QMimeData)
- @param action drop action requested (Qt.DropAction)
- @param row row number (integer)
- @param column column number (integer)
- @param parent index of the parent node (QModelIndex)
- @return flag indicating successful acceptance of the data (boolean)
+ @param data reference to the mime data
+ @type QMimeData
+ @param action drop action requested
+ @type Qt.DropAction
+ @param row row number
+ @type int
+ @param column column number
+ @type int
+ @param parent index of the parent node
+ @type QModelIndex
+ @return flag indicating successful acceptance of the data
+ @rtype bool
"""
from .BookmarkNode import BookmarkNode
from .XbelReader import XbelReader
@@ -459,10 +503,14 @@
"""
Public method to set the data of a node cell.
- @param index index of the node cell (QModelIndex)
+ @param index index of the node cell
+ @type QModelIndex
@param value value to be set
- @param role role of the data (integer)
- @return flag indicating success (boolean)
+ @type Any
+ @param role role of the data
+ @type int
+ @return flag indicating success
+ @rtype bool
"""
if not index.isValid() or (self.flags(index) & Qt.ItemFlag.ItemIsEditable) == 0:
return False
@@ -495,8 +543,10 @@
"""
Public method to get a bookmark node given its index.
- @param index index of the node (QModelIndex)
- @return bookmark node (BookmarkNode)
+ @param index index of the node
+ @type QModelIndex
+ @return bookmark node
+ @rtype BookmarkNode
"""
itemNode = index.internalPointer()
if itemNode is None:
