src/eric7/WebBrowser/OpenSearch/OpenSearchEngineModel.py

branch
eric7
changeset 10436
f6881d10e995
parent 10069
435cc5875135
child 10439
21c28b0f9e41
--- a/src/eric7/WebBrowser/OpenSearch/OpenSearchEngineModel.py	Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/OpenSearch/OpenSearchEngineModel.py	Fri Dec 22 17:24:07 2023 +0100
@@ -26,8 +26,9 @@
         Constructor
 
         @param manager reference to the search engine manager
-            (OpenSearchManager)
-        @param parent reference to the parent object (QObject)
+        @type OpenSearchManager
+        @param parent reference to the parent object
+        @type QObject
         """
         super().__init__(parent)
 
@@ -43,10 +44,14 @@
         """
         Public method to remove entries from the model.
 
-        @param row start row (integer)
-        @param count number of rows to remove (integer)
-        @param parent parent index (QModelIndex)
-        @return flag indicating success (boolean)
+        @param row start row
+        @type int
+        @param count number of rows to remove
+        @type int
+        @param parent parent index
+        @type QModelIndex
+        @return flag indicating success
+        @rtype bool
         """
         if parent is None:
             parent = QModelIndex()
@@ -74,8 +79,10 @@
         """
         Public method to get the number of rows of the model.
 
-        @param parent parent index (QModelIndex)
-        @return number of rows (integer)
+        @param parent parent index
+        @type QModelIndex
+        @return number of rows
+        @rtype int
         """
         if parent is None:
             parent = QModelIndex()
@@ -89,8 +96,10 @@
         """
         Public method to get the number of columns of the model.
 
-        @param parent parent index (QModelIndex) (Unused)
-        @return number of columns (integer)
+        @param parent parent index (Unused)
+        @type QModelIndex
+        @return number of columns
+        @rtype int
         """
         return 2
 
@@ -98,8 +107,10 @@
         """
         Public method to get flags for a model cell.
 
-        @param index index of the model cell (QModelIndex)
-        @return flags (Qt.ItemFlags)
+        @param index index of the model cell
+        @type QModelIndex
+        @return flags
+        @rtype Qt.ItemFlags
         """
         if index.column() == 1:
             return (
@@ -114,9 +125,12 @@
         """
         Public method to get data from the model.
 
-        @param index index to get data for (QModelIndex)
-        @param role role of the data to retrieve (integer)
+        @param index index to get data for
+        @type QModelIndex
+        @param role role of the data to retrieve
+        @type int
         @return requested data
+        @rtype Any
         """
         if index.row() >= self.__manager.enginesCount() or index.row() < 0:
             return None
@@ -165,10 +179,14 @@
         """
         Public method to set the data of a model cell.
 
-        @param index index of the model cell (QModelIndex)
+        @param index index of the model 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 index.column() != 1:
             return False
@@ -189,10 +207,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

eric ide

mercurial