WebBrowser/ClosedTabsManager.py

branch
QtWebEngine
changeset 4735
84e78ee0f361
parent 4631
5c1a96925da4
child 4788
7076adec8ddd
equal deleted inserted replaced
4734:ce0b1f024da9 4735:84e78ee0f361
1 # -*- coding: utf-8 -*-
2
3 # Copyright (c) 2012 - 2016 Detlev Offenbach <detlev@die-offenbachs.de>
4 #
5
6 """
7 Module implementing a class to manage closed tabs.
8 """
9
10 from __future__ import unicode_literals
11
12 from PyQt5.QtCore import pyqtSignal, QUrl, QObject
13
14
15 class ClosedTab(object):
16 """
17 Class implementing a structure to store data about a closed tab.
18 """
19 def __init__(self, url=QUrl(), title="", position=-1):
20 """
21 Constructor
22
23 @param url URL of the closed tab (QUrl)
24 @param title title of the closed tab (string)
25 @param position index of the closed tab (integer)
26 """
27 self.url = url
28 self.title = title
29 self.position = position
30
31 def __eq__(self, other):
32 """
33 Special method implementing the equality operator.
34
35 @param other reference to the object to compare against (ClosedTab)
36 @return flag indicating equality of the tabs (boolean)
37 """
38 return self.url == other.url and \
39 self.title == other.title and \
40 self.position == other.position
41
42
43 class ClosedTabsManager(QObject):
44 """
45 Class implementing a manager for closed tabs.
46
47 @signal closedTabAvailable(boolean) emitted to signal a change of
48 availability of closed tabs
49 """
50 closedTabAvailable = pyqtSignal(bool)
51
52 def __init__(self, parent=None):
53 """
54 Constructor
55
56 @param parent reference to the parent object (QObject)
57 """
58 super(ClosedTabsManager, self).__init__()
59
60 self.__closedTabs = []
61
62 def recordBrowser(self, browser, position):
63 """
64 Public method to record the data of a browser about to be closed.
65
66 @param browser reference to the browser to be closed (HelpBrowser)
67 @param position index of the tab to be closed (integer)
68 """
69 import WebBrowser.WebBrowserWindow
70 if WebBrowser.WebBrowserWindow.WebBrowserWindow\
71 .mainWindow().getWindow().isPrivate():
72 return
73
74 if browser.url().isEmpty():
75 return
76
77 tab = ClosedTab(browser.url(), browser.title(), position)
78 self.__closedTabs.insert(0, tab)
79 self.closedTabAvailable.emit(True)
80
81 def getClosedTabAt(self, index):
82 """
83 Public method to get the indexed closed tab.
84
85 @param index index of the tab to return (integer)
86 @return requested tab (ClosedTab)
87 """
88 if len(self.__closedTabs) > 0 and len(self.__closedTabs) > index:
89 tab = self.__closedTabs.pop(index)
90 else:
91 tab = ClosedTab()
92 self.closedTabAvailable.emit(len(self.__closedTabs) > 0)
93 return tab
94
95 def isClosedTabAvailable(self):
96 """
97 Public method to check for closed tabs.
98
99 @return flag indicating the availability of closed tab data (boolean)
100 """
101 return len(self.__closedTabs) > 0
102
103 def clearList(self):
104 """
105 Public method to clear the list of closed tabs.
106 """
107 self.__closedTabs = []
108 self.closedTabAvailable.emit(False)
109
110 def allClosedTabs(self):
111 """
112 Public method to get a list of all closed tabs.
113
114 @return list of closed tabs (list of ClosedTab)
115 """
116 return self.__closedTabs

eric ide

mercurial