Helpviewer/SpeedDial/SpeedDialWriter.py

changeset 1699
10706f6ad9d2
child 1704
02ae6c55b35b
equal deleted inserted replaced
1698:dba994e19891 1699:10706f6ad9d2
1 # -*- coding: utf-8 -*-
2
3 # Copyright (c) 2012 Detlev Offenbach <detlev@die-offenbachs.de>
4 #
5
6 """
7 Module implementing a class to write speed dial data files.
8 """
9
10 from PyQt4.QtCore import QXmlStreamWriter, QIODevice, QFile
11
12
13 class SpeedDialWriter(QXmlStreamWriter):
14 """
15 Class implementing a writer object to generate speed dial data files.
16 """
17 def __init__(self):
18 """
19 Constructor
20 """
21 super().__init__()
22
23 self.setAutoFormatting(True)
24
25 def write(self, fileNameOrDevice, pages, pagesPerRow, speedDialSize):
26 """
27 Public method to write a speed dial data file.
28
29 @param fileNameOrDevice name of the file to write (string)
30 or device to write to (QIODevice)
31 @param pages list of speed dial pages (list of Page)
32 @param pagesPerRow number of pages per row (integer)
33 @param speedDialSize size of the speed dial pages (integer)
34 """
35 if isinstance(fileNameOrDevice, QIODevice):
36 f = fileNameOrDevice
37 else:
38 f = QFile(fileNameOrDevice)
39 if not pages or not f.open(QFile.WriteOnly):
40 return False
41
42 self.setDevice(f)
43 return self.__write(pages, pagesPerRow, speedDialSize)
44
45 def __write(self, pages, pagesPerRow, speedDialSize):
46 """
47 Private method to write a speed dial file.
48
49 @param pages list of speed dial pages (list of Page)
50 @param pagesPerRow number of pages per row (integer)
51 @param speedDialSize size of the speed dial pages (integer)
52 @return flag indicating success (boolean)
53 """
54 self.writeStartDocument()
55 self.writeDTD("<!DOCTYPE speeddial>")
56 self.writeStartElement("SpeedDial")
57 self.writeAttribute("version", "1.0")
58
59 self.writeStartElement("Pages")
60 self.writeAttribute("row", str(pagesPerRow))
61 self.writeAttribute("size", str(speedDialSize))
62
63 for page in pages:
64 self.writeEmptyElement("Page")
65 self.writeAttribute("url", page.url)
66 self.writeAttribute("title", page.title)
67
68 self.writeEndDocument()
69 return True

eric ide

mercurial