Migrated the shortcuts handler to shortcuts reader.

Sun, 12 Sep 2010 18:19:34 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 12 Sep 2010 18:19:34 +0200
changeset 597
86d4732c5084
parent 595
7d2c8346021c
child 598
76c36b6ebbdb

Migrated the shortcuts handler to shortcuts reader.

E5XML/ShortcutsReader.py file | annotate | diff | comparison | revisions
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/E5XML/ShortcutsReader.py	Sun Sep 12 18:19:34 2010 +0200
@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2010 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a class for reading an XML shortcuts file.
+"""
+
+from .Config import shortcutsFileFormatVersion
+from .XMLStreamReaderBase import XMLStreamReaderBase
+
+class ShortcutsReader(XMLStreamReaderBase):
+    """
+    Class for reading an XML shortcuts file.
+    """
+    supportedVersions = ["3.6"]
+    
+    def __init__(self, device):
+        """
+        Constructor
+        
+        @param device reference to the I/O device to read from (QIODevice)
+        """
+        XMLStreamReaderBase.__init__(self, device)
+        
+        self.version = ""
+        self.shortcuts = {}
+    
+    def readXML(self, quiet = False):
+        """
+        Public method to read and parse the XML document.
+        
+        @param quiet flag indicating quiet operations.
+                If this flag is true, no errors are reported.
+        """
+        while not self.atEnd():
+            self.readNext()
+            if self.isStartElement():
+                if self.name() == "Shortcuts":
+                    self.version = self.attribute("version", shortcutsFileFormatVersion)
+                    if self.version not in self.supportedVersions:
+                        self.raiseUnsupportedFormatVersion(self.version)
+                elif self.name() == "Shortcut":
+                    self.__readShortCut()
+                else:
+                    self.raiseUnexpectedStartTag(self.name())
+        
+        if not quiet:
+            self.showErrorMessage()
+    
+    def __readShortCut(self):
+        """
+        Private method to read the shortcut data.
+        """
+        category = self.attribute("category")
+        name = ""
+        accel = ""
+        altAccel = ""
+        
+        while not self.atEnd():
+            self.readNext()
+            if self.isEndElement() and self.name() == "Shortcut":
+                if category:
+                    if category not in self.shortcuts:
+                        self.shortcuts[category] = {}
+                    self.shortcuts[category][name] = (accel, altAccel)
+                break
+            
+            if self.isStartElement():
+                if self.name() == "Name":
+                    name = self.readElementText()
+                elif self.name() == "Accel":
+                    accel = self.readElementText()
+                elif self.name() == "AltAccel":
+                    altAccel = self.readElementText()
+                else:
+                    self.raiseUnexpectedStartTag(self.name())
+    
+    def getShortcuts(self):
+        """
+        Public method to retrieve the shortcuts.
+        
+        @return Dictionary of dictionaries of shortcuts. The keys of the
+            dictionary are the categories, the values are dictionaries.
+            These dictionaries have the shortcut name as their key and
+            a tuple of accelerators as their value.
+        """
+        return self.shortcuts

eric ide

mercurial