|
1 # -*- coding: utf-8 -*- |
|
2 |
|
3 # Copyright (c) 2009 - 2016 Detlev Offenbach <detlev@die-offenbachs.de> |
|
4 # |
|
5 |
|
6 """ |
|
7 Module implementing a model for search engines. |
|
8 """ |
|
9 |
|
10 from __future__ import unicode_literals |
|
11 |
|
12 import re |
|
13 |
|
14 from PyQt5.QtCore import Qt, QUrl, QAbstractTableModel, QModelIndex |
|
15 from PyQt5.QtGui import QPixmap, QIcon |
|
16 |
|
17 |
|
18 class OpenSearchEngineModel(QAbstractTableModel): |
|
19 """ |
|
20 Class implementing a model for search engines. |
|
21 """ |
|
22 def __init__(self, manager, parent=None): |
|
23 """ |
|
24 Constructor |
|
25 |
|
26 @param manager reference to the search engine manager |
|
27 (OpenSearchManager) |
|
28 @param parent reference to the parent object (QObject) |
|
29 """ |
|
30 super(OpenSearchEngineModel, self).__init__(parent) |
|
31 |
|
32 self.__manager = manager |
|
33 manager.changed.connect(self.__enginesChanged) |
|
34 |
|
35 self.__headers = [ |
|
36 self.tr("Name"), |
|
37 self.tr("Keywords"), |
|
38 ] |
|
39 |
|
40 def removeRows(self, row, count, parent=QModelIndex()): |
|
41 """ |
|
42 Public method to remove entries from the model. |
|
43 |
|
44 @param row start row (integer) |
|
45 @param count number of rows to remove (integer) |
|
46 @param parent parent index (QModelIndex) |
|
47 @return flag indicating success (boolean) |
|
48 """ |
|
49 if parent.isValid(): |
|
50 return False |
|
51 |
|
52 if count <= 0: |
|
53 return False |
|
54 |
|
55 if self.rowCount() <= 1: |
|
56 return False |
|
57 |
|
58 lastRow = row + count - 1 |
|
59 |
|
60 self.beginRemoveRows(parent, row, lastRow) |
|
61 |
|
62 nameList = self.__manager.allEnginesNames() |
|
63 for index in range(row, lastRow + 1): |
|
64 self.__manager.removeEngine(nameList[index]) |
|
65 |
|
66 # removeEngine emits changed() |
|
67 #self.endRemoveRows() |
|
68 |
|
69 return True |
|
70 |
|
71 def rowCount(self, parent=QModelIndex()): |
|
72 """ |
|
73 Public method to get the number of rows of the model. |
|
74 |
|
75 @param parent parent index (QModelIndex) |
|
76 @return number of rows (integer) |
|
77 """ |
|
78 if parent.isValid(): |
|
79 return 0 |
|
80 else: |
|
81 return self.__manager.enginesCount() |
|
82 |
|
83 def columnCount(self, parent=QModelIndex()): |
|
84 """ |
|
85 Public method to get the number of columns of the model. |
|
86 |
|
87 @param parent parent index (QModelIndex) |
|
88 @return number of columns (integer) |
|
89 """ |
|
90 return 2 |
|
91 |
|
92 def flags(self, index): |
|
93 """ |
|
94 Public method to get flags for a model cell. |
|
95 |
|
96 @param index index of the model cell (QModelIndex) |
|
97 @return flags (Qt.ItemFlags) |
|
98 """ |
|
99 if index.column() == 1: |
|
100 return Qt.ItemIsEnabled | Qt.ItemIsSelectable | Qt.ItemIsEditable |
|
101 else: |
|
102 return Qt.ItemIsEnabled | Qt.ItemIsSelectable |
|
103 |
|
104 def data(self, index, role): |
|
105 """ |
|
106 Public method to get data from the model. |
|
107 |
|
108 @param index index to get data for (QModelIndex) |
|
109 @param role role of the data to retrieve (integer) |
|
110 @return requested data |
|
111 """ |
|
112 if index.row() >= self.__manager.enginesCount() or index.row() < 0: |
|
113 return None |
|
114 |
|
115 engine = self.__manager.engine( |
|
116 self.__manager.allEnginesNames()[index.row()]) |
|
117 |
|
118 if engine is None: |
|
119 return None |
|
120 |
|
121 if index.column() == 0: |
|
122 if role == Qt.DisplayRole: |
|
123 return engine.name() |
|
124 |
|
125 elif role == Qt.DecorationRole: |
|
126 image = engine.image() |
|
127 if image.isNull(): |
|
128 from WebBrowser.WebBrowserWindow import WebBrowserWindow |
|
129 icon = WebBrowserWindow.icon(QUrl(engine.imageUrl())) |
|
130 else: |
|
131 icon = QIcon(QPixmap.fromImage(image)) |
|
132 return icon |
|
133 |
|
134 elif role == Qt.ToolTipRole: |
|
135 description = self.tr("<strong>Description:</strong> {0}")\ |
|
136 .format(engine.description()) |
|
137 if engine.providesSuggestions(): |
|
138 description += "<br/>" |
|
139 description += self.tr( |
|
140 "<strong>Provides contextual suggestions</strong>") |
|
141 |
|
142 return description |
|
143 elif index.column() == 1: |
|
144 if role in [Qt.EditRole, Qt.DisplayRole]: |
|
145 return ",".join(self.__manager.keywordsForEngine(engine)) |
|
146 elif role == Qt.ToolTipRole: |
|
147 return self.tr( |
|
148 "Comma-separated list of keywords that may" |
|
149 " be entered in the location bar followed by search terms" |
|
150 " to search with this engine") |
|
151 |
|
152 return None |
|
153 |
|
154 def setData(self, index, value, role=Qt.EditRole): |
|
155 """ |
|
156 Public method to set the data of a model cell. |
|
157 |
|
158 @param index index of the model cell (QModelIndex) |
|
159 @param value value to be set |
|
160 @param role role of the data (integer) |
|
161 @return flag indicating success (boolean) |
|
162 """ |
|
163 if not index.isValid() or index.column() != 1: |
|
164 return False |
|
165 |
|
166 if index.row() >= self.rowCount() or index.row() < 0: |
|
167 return False |
|
168 |
|
169 if role != Qt.EditRole: |
|
170 return False |
|
171 |
|
172 engineName = self.__manager.allEnginesNames()[index.row()] |
|
173 keywords = re.split("[ ,]+", value) |
|
174 self.__manager.setKeywordsForEngine( |
|
175 self.__manager.engine(engineName), keywords) |
|
176 |
|
177 return True |
|
178 |
|
179 def headerData(self, section, orientation, role=Qt.DisplayRole): |
|
180 """ |
|
181 Public method to get the header data. |
|
182 |
|
183 @param section section number (integer) |
|
184 @param orientation header orientation (Qt.Orientation) |
|
185 @param role data role (integer) |
|
186 @return header data |
|
187 """ |
|
188 if orientation == Qt.Horizontal and role == Qt.DisplayRole: |
|
189 try: |
|
190 return self.__headers[section] |
|
191 except IndexError: |
|
192 pass |
|
193 |
|
194 return None |
|
195 |
|
196 def __enginesChanged(self): |
|
197 """ |
|
198 Private slot handling a change of the registered engines. |
|
199 """ |
|
200 self.beginResetModel() |
|
201 self.endResetModel() |