--- a/src/eric7/WebBrowser/History/HistoryMenu.py Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/History/HistoryMenu.py Fri Dec 22 17:24:07 2023 +0100
@@ -42,8 +42,10 @@
"""
Constructor
- @param sourceModel reference to the source model (QAbstractItemModel)
- @param parent reference to the parent object (QObject)
+ @param sourceModel reference to the source model
+ @type QAbstractItemModel
+ @param parent reference to the parent object
+ @type QObject
"""
super().__init__(parent)
@@ -55,7 +57,8 @@
"""
Public method to determine the number of rows moved to the root.
- @return number of rows moved to the root (integer)
+ @return number of rows moved to the root
+ @rtype int
"""
first = self.__treeModel.index(0, 0)
if not first.isValid():
@@ -66,8 +69,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()
@@ -78,8 +83,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()
@@ -112,8 +119,10 @@
"""
Public method to map an index to the proxy model index.
- @param sourceIndex reference to a source model index (QModelIndex)
- @return proxy model index (QModelIndex)
+ @param sourceIndex reference to a source model index
+ @type QModelIndex
+ @return proxy model index
+ @rtype QModelIndex
"""
sourceRow = self.__treeModel.mapToSource(sourceIndex).row()
return self.createIndex(sourceIndex.row(), sourceIndex.column(), sourceRow)
@@ -122,8 +131,10 @@
"""
Public method to map an index to the source model index.
- @param proxyIndex reference to a proxy model index (QModelIndex)
- @return source model index (QModelIndex)
+ @param proxyIndex reference to a proxy model index
+ @type QModelIndex
+ @return source model index
+ @rtype QModelIndex
"""
if not proxyIndex.isValid():
return QModelIndex()
@@ -154,10 +165,14 @@
"""
Public method to create an index.
- @param row row number for the index (integer)
- @param column column number for the index (integer)
- @param parent index of the parent item (QModelIndex)
- @return requested index (QModelIndex)
+ @param row row number for the index
+ @type int
+ @param column column number for the index
+ @type int
+ @param parent index of the parent item
+ @type QModelIndex
+ @return requested index
+ @rtype QModelIndex
"""
if parent is None:
parent = QModelIndex()
@@ -189,8 +204,10 @@
"""
Public method to get the parent index.
- @param index index of item to get parent (QModelIndex)
- @return index of parent (QModelIndex)
+ @param index index of item to get parent
+ @type QModelIndex
+ @return index of parent
+ @rtype QModelIndex
"""
offset = index.internalId()
if offset == sys.maxsize or not index.isValid():
@@ -215,8 +232,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
"""
urls = []
for index in indexes:
@@ -237,8 +256,10 @@
"""
Constructor
- @param sourceModel reference to the source model (QAbstractItemModel)
- @param parent reference to the parent object (QObject)
+ @param sourceModel reference to the source model
+ @type QAbstractItemModel
+ @param parent reference to the parent object
+ @type QObject
"""
super().__init__(parent)
@@ -249,9 +270,12 @@
"""
Public method used to sort the displayed items.
- @param left index of left item (QModelIndex)
- @param right index of right item (QModelIndex)
- @return true, if left is less than right (boolean)
+ @param left index of left item
+ @type QModelIndex
+ @param right index of right item
+ @type QModelIndex
+ @return true, if left is less than right
+ @rtype bool
"""
from .HistoryFilterModel import HistoryFilterModel
@@ -291,9 +315,11 @@
"""
Constructor
- @param parent reference to the parent widget (QWidget)
+ @param parent reference to the parent widget
+ @type QWidget
@param tabWidget reference to the tab widget managing the browser
- tabs (HelpTabWidget
+ tabs
+ @type WebBrowserTabWidget
"""
EricModelMenu.__init__(self, parent)
@@ -320,7 +346,8 @@
"""
Private slot handling the activated signal.
- @param idx index of the activated item (QModelIndex)
+ @param idx index of the activated item
+ @type QModelIndex
"""
if self._keyboardModifiers & Qt.KeyboardModifier.ControlModifier:
self.newTab.emit(
@@ -339,7 +366,8 @@
"""
Public method to add any actions before the tree.
- @return flag indicating if any actions were added (boolean)
+ @return flag indicating if any actions were added
+ @rtype bool
"""
if self.__historyManager is None:
self.__historyManager = WebBrowserWindow.historyManager()
@@ -392,7 +420,8 @@
Public method to set the list of actions that should appear first in
the menu.
- @param actions list of initial actions (list of QAction)
+ @param actions list of initial actions
+ @type list of QAction
"""
self.__initialActions = actions[:]
for act in self.__initialActions:
@@ -453,7 +482,8 @@
"""
Private slot to handle changes of the availability of closed tabs.
- @param avail flag indicating the availability of closed tabs (boolean)
+ @param avail flag indicating the availability of closed tabs
+ @type bool
"""
self.__closedTabsMenu.setEnabled(avail)
@@ -481,8 +511,10 @@
"""
Constructor
- @param count maximum number of entries to be shown (integer)
- @param parent reference to the parent widget (QWidget)
+ @param count maximum number of entries to be shown
+ @type int
+ @param parent reference to the parent widget
+ @type QWidget
"""
EricModelMenu.__init__(self, parent)
@@ -496,7 +528,8 @@
"""
Private slot handling the activated signal.
- @param idx index of the activated item (QModelIndex)
+ @param idx index of the activated item
+ @type QModelIndex
"""
if self._keyboardModifiers & Qt.KeyboardModifier.ControlModifier:
self.newTab.emit(
@@ -515,7 +548,8 @@
"""
Public method to add any actions before the tree.
- @return flag indicating if any actions were added (boolean)
+ @return flag indicating if any actions were added
+ @rtype bool
"""
if self.__historyMenuModel is None:
historyManager = WebBrowserWindow.historyManager()
