--- a/Helpviewer/Bookmarks/BookmarksManager.py Tue Oct 15 22:03:54 2013 +0200
+++ b/Helpviewer/Bookmarks/BookmarksManager.py Fri Oct 18 23:00:41 2013 +0200
@@ -11,8 +11,9 @@
import os
-from PyQt4.QtCore import pyqtSignal, Qt, QT_TRANSLATE_NOOP, QObject, QFile, QByteArray, \
- QBuffer, QIODevice, QXmlStreamReader, QDate, QDateTime, QFileInfo, QUrl
+from PyQt4.QtCore import pyqtSignal, Qt, QT_TRANSLATE_NOOP, QObject, QFile, \
+ QByteArray, QBuffer, QIODevice, QXmlStreamReader, QDate, QDateTime, \
+ QFileInfo, QUrl
from PyQt4.QtGui import QUndoStack, QUndoCommand, QApplication, QDialog
from E5Gui import E5MessageBox, E5FileDialog
@@ -35,10 +36,12 @@
"""
Class implementing the bookmarks manager.
- @signal entryAdded(BookmarkNode) emitted after a bookmark node has been added
- @signal entryRemoved(BookmarkNode, int, BookmarkNode) emitted after a bookmark
- node has been removed
- @signal entryChanged(BookmarkNode) emitted after a bookmark node has been changed
+ @signal entryAdded(BookmarkNode) emitted after a bookmark node has been
+ added
+ @signal entryRemoved(BookmarkNode, int, BookmarkNode) emitted after a
+ bookmark node has been removed
+ @signal entryChanged(BookmarkNode) emitted after a bookmark node has been
+ changed
@signal bookmarksSaved() emitted after the bookmarks were saved
@signal bookmarksReloaded() emitted after the bookmarks were reloaded
"""
@@ -81,7 +84,8 @@
@return name of the bookmark file (string)
"""
- return os.path.join(Utilities.getConfigDir(), "browser", "bookmarks.xbel")
+ return os.path.join(Utilities.getConfigDir(), "browser",
+ "bookmarks.xbel")
def close(self):
"""
@@ -114,6 +118,9 @@
def load(self):
"""
Public method to load the bookmarks.
+
+ @exception RuntimeError raised to indicate an error loading the
+ bookmarks
"""
if self.__loaded:
return
@@ -133,14 +140,16 @@
if reader.error() != QXmlStreamReader.NoError:
E5MessageBox.warning(None,
self.trUtf8("Loading Bookmarks"),
- self.trUtf8("""Error when loading bookmarks on line {0}, column {1}:\n"""
- """{2}""")\
+ self.trUtf8(
+ """Error when loading bookmarks on line {0},"""
+ """ column {1}:\n {2}""")\
.format(reader.lineNumber(),
reader.columnNumber(),
reader.errorString()))
others = []
- for index in range(len(self.__bookmarkRootNode.children()) - 1, -1, -1):
+ for index in range(
+ len(self.__bookmarkRootNode.children()) - 1, -1, -1):
node = self.__bookmarkRootNode.children()[index]
if node.type() == BookmarkNode.Folder:
if (node.title == self.trUtf8("Toolbar Bookmarks") or \
@@ -162,13 +171,15 @@
raise RuntimeError("Error loading bookmarks.")
if self.__toolbar is None:
- self.__toolbar = BookmarkNode(BookmarkNode.Folder, self.__bookmarkRootNode)
+ self.__toolbar = BookmarkNode(BookmarkNode.Folder,
+ self.__bookmarkRootNode)
self.__toolbar.title = self.trUtf8(BOOKMARKBAR)
else:
self.__bookmarkRootNode.add(self.__toolbar)
if self.__menu is None:
- self.__menu = BookmarkNode(BookmarkNode.Folder, self.__bookmarkRootNode)
+ self.__menu = BookmarkNode(BookmarkNode.Folder,
+ self.__bookmarkRootNode)
self.__menu.title = self.trUtf8(BOOKMARKMENU)
else:
self.__bookmarkRootNode.add(self.__menu)
@@ -215,7 +226,8 @@
if not self.__loaded:
return
- self.setTimestamp(node, BookmarkNode.TsAdded, QDateTime.currentDateTime())
+ self.setTimestamp(node, BookmarkNode.TsAdded,
+ QDateTime.currentDateTime())
command = InsertBookmarksCommand(self, parent, node, row)
self.__commands.push(command)
@@ -262,7 +274,10 @@
def setNodeChanged(self, node):
"""
- Public method to signal changes of bookmarks other than title, URL or timestamp.
+ Public method to signal changes of bookmarks other than title, URL
+ or timestamp.
+
+ @param node reference to the bookmark (BookmarkNode)
"""
self.__saveTimer.changeOccurred()
@@ -271,8 +286,9 @@
Public method to set the URL of a bookmark.
@param node reference to the node to be changed (BookmarkNode)
- @param timestampType type of the timestamp to set (BookmarkNode.TsAdded,
- BookmarkNode.TsModified, BookmarkNode.TsVisited)
+ @param timestampType type of the timestamp to set
+ (BookmarkNode.TsAdded, BookmarkNode.TsModified,
+ BookmarkNode.TsVisited)
@param timestamp timestamp to set (QDateTime)
"""
if not self.__loaded:
@@ -389,9 +405,11 @@
if len(bmNames) == len(bmFiles):
convertedRootNode = BookmarkNode(BookmarkNode.Folder)
convertedRootNode.title = self.trUtf8("Converted {0}")\
- .format(QDate.currentDate().toString(Qt.SystemLocaleShortDate))
+ .format(QDate.currentDate().toString(
+ Qt.SystemLocaleShortDate))
for i in range(len(bmNames)):
- node = BookmarkNode(BookmarkNode.Bookmark, convertedRootNode)
+ node = BookmarkNode(BookmarkNode.Bookmark,
+ convertedRootNode)
node.title = bmNames[i]
url = QUrl(bmFiles[i])
if not url.scheme():
@@ -441,7 +459,8 @@
Private method get a bookmark node for a given URL.
@param url URL of the bookmark to search for (string)
- @param startNode reference to the node to start searching (BookmarkNode)
+ @param startNode reference to the node to start searching
+ (BookmarkNode)
@return bookmark node for the given url (BookmarkNode)
"""
bm = None
@@ -483,7 +502,8 @@
Private method get a list of bookmark nodes for a given URL.
@param url URL of the bookmarks to search for (string)
- @param startNode reference to the node to start searching (BookmarkNode)
+ @param startNode reference to the node to start searching
+ (BookmarkNode)
@return list of bookmark nodes for the given url (list of BookmarkNode)
"""
bm = []
@@ -504,7 +524,8 @@
"""
Constructor
- @param bookmarksManager reference to the bookmarks manager (BookmarksManager)
+ @param bookmarksManager reference to the bookmarks manager
+ (BookmarksManager)
@param parent reference to the parent node (BookmarkNode)
@param row row number of bookmark (integer)
"""
@@ -531,7 +552,8 @@
Public slot to perform the redo action.
"""
self._parent.remove(self._node)
- self._bookmarksManager.entryRemoved.emit(self._parent, self._row, self._node)
+ self._bookmarksManager.entryRemoved.emit(
+ self._parent, self._row, self._node)
class InsertBookmarksCommand(RemoveBookmarksCommand):
@@ -542,13 +564,15 @@
"""
Constructor
- @param bookmarksManager reference to the bookmarks manager (BookmarksManager)
+ @param bookmarksManager reference to the bookmarks manager
+ (BookmarksManager)
@param parent reference to the parent node (BookmarkNode)
@param node reference to the node to be inserted (BookmarkNode)
@param row row number of bookmark (integer)
"""
RemoveBookmarksCommand.__init__(self, bookmarksManager, parent, row)
- self.setText(QApplication.translate("BookmarksManager", "Insert Bookmark"))
+ self.setText(QApplication.translate(
+ "BookmarksManager", "Insert Bookmark"))
self._node = node
def undo(self):
@@ -572,7 +596,8 @@
"""
Constructor
- @param bookmarksManager reference to the bookmarks manager (BookmarksManager)
+ @param bookmarksManager reference to the bookmarks manager
+ (BookmarksManager)
@param node reference to the node to be changed (BookmarkNode)
@param newValue new value to be set (string)
@param title flag indicating a change of the title (True) or
@@ -587,10 +612,12 @@
if self._title:
self._oldValue = self._node.title
- self.setText(QApplication.translate("BookmarksManager", "Name Change"))
+ self.setText(QApplication.translate(
+ "BookmarksManager", "Name Change"))
else:
self._oldValue = self._node.url
- self.setText(QApplication.translate("BookmarksManager", "Address Change"))
+ self.setText(QApplication.translate(
+ "BookmarksManager", "Address Change"))
def undo(self):
"""
