Mercurial Repositories > eric / file comparison
comparison: Helpviewer/OpenSearch/OpenSearchWriter.py
Helpviewer/OpenSearch/OpenSearchWriter.py
- changeset 0
- de9c2efb9d02
- child 13
- 1af94a91f439
equal
deleted
inserted
replaced
| -1:000000000000 | 0:de9c2efb9d02 |
|---|---|
| 1 # -*- coding: utf-8 -*- | |
| 2 | |
| 3 # Copyright (c) 2009 Detlev Offenbach <detlev@die-offenbachs.de> | |
| 4 # | |
| 5 | |
| 6 """ | |
| 7 Module implementing a writer for open search engine descriptions. | |
| 8 """ | |
| 9 | |
| 10 from PyQt4.QtCore import * | |
| 11 | |
| 12 class OpenSearchWriter(QXmlStreamWriter): | |
| 13 """ | |
| 14 Class implementing a writer for open search engine descriptions. | |
| 15 """ | |
| 16 def __init__(self): | |
| 17 """ | |
| 18 Constructor | |
| 19 """ | |
| 20 QXmlStreamWriter.__init__(self) | |
| 21 | |
| 22 self.setAutoFormatting(True) | |
| 23 | |
| 24 def write(self, device, engine): | |
| 25 """ | |
| 26 Public method to write the description of an engine. | |
| 27 | |
| 28 @param device reference to the device to write to (QIODevice) | |
| 29 @param engine reference to the engine (OpenSearchEngine) | |
| 30 """ | |
| 31 if engine is None: | |
| 32 return False | |
| 33 | |
| 34 if not device.isOpen(): | |
| 35 if not device.open(QIODevice.WriteOnly): | |
| 36 return False | |
| 37 | |
| 38 self.setDevice(device) | |
| 39 self.__write(engine) | |
| 40 return True | |
| 41 | |
| 42 def __write(self, engine): | |
| 43 """ | |
| 44 Private method to write the description of an engine. | |
| 45 | |
| 46 @param engine reference to the engine (OpenSearchEngine) | |
| 47 """ | |
| 48 self.writeStartDocument() | |
| 49 self.writeStartElement("OpenSearchDescription") | |
| 50 self.writeDefaultNamespace("http://a9.com/-/spec/opensearch/1.1/") | |
| 51 | |
| 52 if engine.name(): | |
| 53 self.writeTextElement("ShortName", engine.name()) | |
| 54 | |
| 55 if engine.description(): | |
| 56 self.writeTextElement("Description", engine.description()) | |
| 57 | |
| 58 if engine.searchUrlTemplate(): | |
| 59 self.writeStartElement("Url") | |
| 60 self.writeAttribute("method", engine.searchMethod()) | |
| 61 self.writeAttribute("type", "text/html") | |
| 62 self.writeAttribute("template", engine.searchUrlTemplate()) | |
| 63 | |
| 64 if len(engine.searchParameters()) > 0: | |
| 65 self.writeNamespace( | |
| 66 "http://a9.com/-/spec/opensearch/extensions/parameters/1.0/", "p") | |
| 67 for parameter in engine.searchParameters(): | |
| 68 self.writeStartElement("p:Parameter") | |
| 69 self.writeAttribute("name", parameter[0]) | |
| 70 self.writeAttribute("value", parameter[1]) | |
| 71 | |
| 72 self.writeEndElement() | |
| 73 | |
| 74 if engine.suggestionsUrlTemplate(): | |
| 75 self.writeStartElement("Url") | |
| 76 self.writeAttribute("method", engine.suggestionsMethod()) | |
| 77 self.writeAttribute("type", "application/x-suggestions+json") | |
| 78 self.writeAttribute("template", engine.suggestionsUrlTemplate()) | |
| 79 | |
| 80 if len(engine.suggestionsParameters()) > 0: | |
| 81 self.writeNamespace( | |
| 82 "http://a9.com/-/spec/opensearch/extensions/parameters/1.0/", "p") | |
| 83 for parameter in engine.suggestionsParameters(): | |
| 84 self.writeStartElement("p:Parameter") | |
| 85 self.writeAttribute("name", parameter[0]) | |
| 86 self.writeAttribute("value", parameter[1]) | |
| 87 | |
| 88 self.writeEndElement() | |
| 89 | |
| 90 if engine.imageUrl(): | |
| 91 self.writeTextElement("Image", engine.imageUrl()) | |
| 92 | |
| 93 self.writeEndElement() | |
| 94 self.writeEndDocument() |
