QXmlStreamWriter Class Reference · PyQt4 中文文檔

# QXmlStreamWriter Class Reference ## [[QtCore](index.htm) module] 該QXmlStreamWriter類提供了一個XML編寫一個簡單的流API 。[More...](#details) ### Methods * `__init__ (self)` * `__init__ (self, QIODevice?device)` * `__init__ (self, QByteArray?array)` * `__init__ (self, QString?string)` * `bool autoFormatting (self)` * `int autoFormattingIndent (self)` * `QTextCodec codec (self)` * `QIODevice device (self)` * `bool hasError (self)` * `setAutoFormatting (self, bool)` * `setAutoFormattingIndent (self, int?spaces)` * `setCodec (self, QTextCodec?codec)` * `setCodec (self, str?codecName)` * `setDevice (self, QIODevice?device)` * `writeAttribute (self, QString?qualifiedName, QString?value)` * `writeAttribute (self, QString?namespaceUri, QString?name, QString?value)` * `writeAttribute (self, QXmlStreamAttribute?attribute)` * `writeAttributes (self, QXmlStreamAttributes?attributes)` * `writeCDATA (self, QString?text)` * `writeCharacters (self, QString?text)` * `writeComment (self, QString?text)` * `writeCurrentToken (self, QXmlStreamReader?reader)` * `writeDefaultNamespace (self, QString?namespaceUri)` * `writeDTD (self, QString?dtd)` * `writeEmptyElement (self, QString?qualifiedName)` * `writeEmptyElement (self, QString?namespaceUri, QString?name)` * `writeEndDocument (self)` * `writeEndElement (self)` * `writeEntityReference (self, QString?name)` * `writeNamespace (self, QString?namespaceUri, QString?prefix?=?QString())` * `writeProcessingInstruction (self, QString?target, QString?data?=?QString())` * `writeStartDocument (self)` * `writeStartDocument (self, QString?version)` * `writeStartDocument (self, QString?version, bool?standalone)` * `writeStartElement (self, QString?qualifiedName)` * `writeStartElement (self, QString?namespaceUri, QString?name)` * `writeTextElement (self, QString?qualifiedName, QString?text)` * `writeTextElement (self, QString?namespaceUri, QString?name, QString?text)` * * * ## Detailed Description 該QXmlStreamWriter類提供了一個XML編寫一個簡單的流API 。 QXmlStreamWriter是對口[QXmlStreamReader](qxmlstreamreader.html)用于編寫XML 。像它的相關的類，它運行在一個[QIODevice](qiodevice.html)與指定[setDevice](qxmlstreamwriter.html#setDevice)（）。該API是??簡單而直接：為每個XML標記或你想要寫的事件，筆者提供了一個專門的功能。開始時你有一個文件[writeStartDocument](qxmlstreamwriter.html#writeStartDocument)（）和結束它[writeEndDocument](qxmlstreamwriter.html#writeEndDocument)（）。這將隱式關閉所有剩馀的開放標籤。元素標記開[writeStartElement](qxmlstreamwriter.html#writeStartElement)（），隨后[writeAttribute](qxmlstreamwriter.html#writeAttribute)（）或[writeAttributes](qxmlstreamwriter.html#writeAttributes)（），元素的內容，然后[writeEndElement](qxmlstreamwriter.html#writeEndElement)（）。較短的形式[writeEmptyElement](qxmlstreamwriter.html#writeEmptyElement)（）可以用來寫空元素，其次是[writeAttributes](qxmlstreamwriter.html#writeAttributes)（）。元素含量由兩種字符，實體引用或嵌套元素。這是用[writeCharacters](qxmlstreamwriter.html#writeCharacters)（），這也需要轉義禁止所有字符和字符序列的照顧，[writeEntityReference](qxmlstreamwriter.html#writeEntityReference)（），或后續調用[writeStartElement](qxmlstreamwriter.html#writeStartElement)（）。一種簡便方法[writeTextElement](qxmlstreamwriter.html#writeTextElement)（）可用于編寫僅僅包含文本終端元素。下面簡略的代碼片段顯示了基本使用的類來寫格式化的XML縮進： ``` QXmlStreamWriter stream(&output); stream.setAutoFormatting(true); stream.writeStartDocument(); ... stream.writeStartElement("bookmark"); stream.writeAttribute("href", "http://qt.nokia.com/"); stream.writeTextElement("title", "Qt Home"); stream.writeEndElement(); // bookmark ... stream.writeEndDocument(); ``` QXmlStreamWriter采用前綴命名空間的照顧，你需要做的就是指定`namespaceUri`寫元素或屬性的時候。如果您必須符合一定的前綴，你可以強制筆者通過手動聲明的命名空間使用它們[writeNamespace](qxmlstreamwriter.html#writeNamespace)（）或[writeDefaultNamespace](qxmlstreamwriter.html#writeDefaultNamespace)（）。或者，您可以繞過流作家的命名空間支持，并使用該采取一個合格的名稱，而不是重載方法。命名空間_http://www.w3.org/XML/1998/namespace_是隱式映射到前綴_xml_。流作家可以通過添加換行符和縮進到元素之間的空白部分，使XML數據的可讀性更強的人類和更容易使用的大部分源代碼管理系統自動格式化生成的XML數據。該功能可以被打開以[autoFormatting](qxmlstreamwriter.html#autoFormatting-prop)物業和定制與[autoFormattingIndent](qxmlstreamwriter.html#autoFormattingIndent-prop)屬性。其它功能[writeCDATA](qxmlstreamwriter.html#writeCDATA)（）[writeComment](qxmlstreamwriter.html#writeComment)（）[writeProcessingInstruction](qxmlstreamwriter.html#writeProcessingInstruction)（）和[writeDTD](qxmlstreamwriter.html#writeDTD)（）。 XML流的鏈接時支持[writeCurrentToken](qxmlstreamwriter.html#writeCurrentToken)（）。默認情況下， QXmlStreamWriter XML編碼為UTF -8 。不同的編碼可以通過強制執行[setCodec](qxmlstreamwriter.html#setCodec)（）。如果在寫入到底層設備發生錯誤，[hasError](qxmlstreamwriter.html#hasError)（）開始返回真和隨后的寫入被忽略。該[QXmlStream Bookmarks Example](index.htm)說明如何使用流作家寫一個XML書籤文件（ XBEL ），是由以前在讀[QXmlStreamReader](qxmlstreamreader.html)。 * * * ## Method Documentation ``` QXmlStreamWriter.__init__ (self) ``` 構造一個流作家。 **See also** [setDevice](qxmlstreamwriter.html#setDevice)（）。 ``` QXmlStreamWriter.__init__ (self, QIODevice?device) ``` 構造一個流作家寫入到_device_; ``` QXmlStreamWriter.__init__ (self, QByteArray?array) ``` 構造一個流作家寫入到_array_。這是一樣的創建XML編寫器運行在一個[QBuffer](qbuffer.html)裝置，該裝置反過來作用于_array_。 ``` QXmlStreamWriter.__init__ (self, QString?string) ``` 構造一個流作家寫入到_string_。 ``` bool QXmlStreamWriter.autoFormatting (self) ``` ``` int QXmlStreamWriter.autoFormattingIndent (self) ``` ``` QTextCodec QXmlStreamWriter.codec (self) ``` [ 返回當前分配給流的編解碼器。 ](qtextcodec.html) [**See also**](qtextcodec.html) [setCodec](qxmlstreamwriter.html#setCodec)（）。 ``` QIODevice QXmlStreamWriter.device (self) ``` [](qiodevice.html) [返回與關聯的當前設備](qiodevice.html)[QXmlStreamWriter](qxmlstreamwriter.html)，或者0，如果沒有設備已經被分配。 **See also** [setDevice](qxmlstreamwriter.html#setDevice)（）。 ``` bool QXmlStreamWriter.hasError (self) ``` 返回True如果流無法寫入到基礎設備，否則返回False 。錯誤狀態永遠不會復位。發生寫入錯誤發生后會被忽略，即使錯誤條件被清除。此功能被引入Qt的4.8 。 ``` QXmlStreamWriter.setAutoFormatting (self, bool) ``` ``` QXmlStreamWriter.setAutoFormattingIndent (self, int?spaces) ``` ``` QXmlStreamWriter.setCodec (self, QTextCodec?codec) ``` 設置編解碼器，該流_codec_。編解碼器是用于編碼被寫入任何數據。默認情況下，[QXmlStreamWriter](qxmlstreamwriter.html)使用UTF-8 。該編碼信息存儲在其中，當你調用將會寫入初始XML標記[writeStartDocument](qxmlstreamwriter.html#writeStartDocument)（）。在調用之前調用此函數[writeStartDocument](qxmlstreamwriter.html#writeStartDocument)（）。 **See also** [codec](qxmlstreamwriter.html#codec)（）。 ``` QXmlStreamWriter.setCodec (self, str?codecName) ``` 設置編解碼器，該數據流的[QTextCodec](qtextcodec.html)對于由指定的編碼_codecName_。為共同的價值觀`codecName`包括“ ISO 8859 ”，“ UTF-8” ，和“UTF- 16” 。如果編碼不被識別，沒有任何反應。 **See also** [QTextCodec.codecForName](qtextcodec.html#codecForName)（）。 ``` QXmlStreamWriter.setDevice (self, QIODevice?device) ``` 設置當前設備_device_。如果你想流寫入到一個[QByteArray](qbytearray.html)，你可以創建一個[QBuffer](qbuffer.html)設備。 **See also** [device](qxmlstreamwriter.html#device)（）。 ``` QXmlStreamWriter.writeAttribute (self, QString?qualifiedName, QString?value) ``` 寫與屬性_name_和_value_，前綴為指定_namespaceUri_。如果命名空間還沒有被宣布的是，[QXmlStreamWriter](qxmlstreamwriter.html)將生成一個命名空間聲明它。此功能后，才可以稱為[writeStartElement](qxmlstreamwriter.html#writeStartElement)（）任何內容被寫入之前，或之后[writeEmptyElement](qxmlstreamwriter.html#writeEmptyElement)（）。 ``` QXmlStreamWriter.writeAttribute (self, QString?namespaceUri, QString?name, QString?value) ``` 這是一個重載函數。寫與屬性_qualifiedName_和_value_。此功能后，才可以稱為[writeStartElement](qxmlstreamwriter.html#writeStartElement)（）任何內容被寫入之前，或之后[writeEmptyElement](qxmlstreamwriter.html#writeEmptyElement)（）。 ``` QXmlStreamWriter.writeAttribute (self, QXmlStreamAttribute?attribute) ``` 這是一個重載函數。寫_attribute_。此功能后，才可以稱為[writeStartElement](qxmlstreamwriter.html#writeStartElement)（）任何內容被寫入之前，或之后[writeEmptyElement](qxmlstreamwriter.html#writeEmptyElement)（）。 ``` QXmlStreamWriter.writeAttributes (self, QXmlStreamAttributes?attributes) ``` 寫入屬性向量_attributes_。如果在屬性中引用的命名空間沒有被宣布的是，[QXmlStreamWriter](qxmlstreamwriter.html)將生成一個命名空間聲明它。此功能后，才可以稱為[writeStartElement](qxmlstreamwriter.html#writeStartElement)（）任何內容被寫入之前，或之后[writeEmptyElement](qxmlstreamwriter.html#writeEmptyElement)（）。 **See also** [writeAttribute](qxmlstreamwriter.html#writeAttribute)（）和[writeNamespace](qxmlstreamwriter.html#writeNamespace)（）。 ``` QXmlStreamWriter.writeCDATA (self, QString?text) ``` Writes _text_作為CDATA節。如果_text_包含禁止字符序列“ ]]\u003e ” ，它被分成不同的CDATA節。此功能主要存在的完整性。通常你應該不需要使用它，因為[writeCharacters](qxmlstreamwriter.html#writeCharacters)（）自動轉義所有非內容的字符。 ``` QXmlStreamWriter.writeCharacters (self, QString?text) ``` Writes _text_。字符“ \u003c ” ， “＆ ”和“ ” “被轉義為實體引用”\u003c“ ， ”＆，和“”“ 。為了避免禁止序列“ ]]\u003e ” ， “ \u003e ”也轉義為“ \u003e ” 。 **See also** [writeEntityReference](qxmlstreamwriter.html#writeEntityReference)（）。 ``` QXmlStreamWriter.writeComment (self, QString?text) ``` Writes _text_作為XML注釋，其中_text_不得含有禁序列“ - ”或終結“ - ” 。在注釋 - 請注意， XML不提供任何方式來逃避“ ” 。 ``` QXmlStreamWriter.writeCurrentToken (self, QXmlStreamReader?reader) ``` 寫入的當前狀態_reader_。所有可能的有效狀態的支持。此功能的目的是為了支持XML數據的鏈接的處理。 **See also** [QXmlStreamReader.tokenType](qxmlstreamreader.html#tokenType)（）。 ``` QXmlStreamWriter.writeDefaultNamespace (self, QString?namespaceUri) ``` 寫一個默認的命名空間聲明_namespaceUri_。 If [writeStartElement](qxmlstreamwriter.html#writeStartElement)（）或[writeEmptyElement](qxmlstreamwriter.html#writeEmptyElement)（）被調用，該聲明適用于當前元素，否則它適用于下一個子元素。請注意，命名空間_http://www.w3.org/XML/1998/namespace_（綁定到_xmlns_）和_http://www.w3.org/2000/xmlns/_（綁定到_xml_）由定義不能被聲明為默認值。 ``` QXmlStreamWriter.writeDTD (self, QString?dtd) ``` 寫一個DTD部分。該_dtd_表示從XML 1.0規范整個doctypedecl產品。 ``` QXmlStreamWriter.writeEmptyElement (self, QString?qualifiedName) ``` 寫一個空元素與_name_，前綴為指定_namespaceUri_。如果命名空間還沒有被宣布，[QXmlStreamWriter](qxmlstreamwriter.html)將生成一個命名空間聲明它。后續調用[writeAttribute](qxmlstreamwriter.html#writeAttribute)（）將屬性添加到這個元素。 **See also** [writeNamespace](qxmlstreamwriter.html#writeNamespace)（）。 ``` QXmlStreamWriter.writeEmptyElement (self, QString?namespaceUri, QString?name) ``` 這是一個重載函數。寫一個空元素與限定名_qualifiedName_。后續調用[writeAttribute](qxmlstreamwriter.html#writeAttribute)（）將屬性添加到這個元素。 ``` QXmlStreamWriter.writeEndDocument (self) ``` 關閉所有剩馀的開放開始元素和寫入一個換行符。 **See also** [writeStartDocument](qxmlstreamwriter.html#writeStartDocument)（）。 ``` QXmlStreamWriter.writeEndElement (self) ``` 關閉以前開始元素。 **See also** [writeStartElement](qxmlstreamwriter.html#writeStartElement)（）。 ``` QXmlStreamWriter.writeEntityReference (self, QString?name) ``` 寫實體引用_name_到流中，如“與_name_; “ 。 ``` QXmlStreamWriter.writeNamespace (self, QString?namespaceUri, QString?prefix?=?QString()) ``` 寫一個命名空間聲明_namespaceUri_同_prefix_。如果_prefix_是空的，[QXmlStreamWriter](qxmlstreamwriter.html)指定由字母' N'后跟一個數字的唯一的前綴。 If [writeStartElement](qxmlstreamwriter.html#writeStartElement)（）或[writeEmptyElement](qxmlstreamwriter.html#writeEmptyElement)（）被調用，該聲明適用于當前元素，否則它適用于下一個子元素。注意，前綴_xml_是預定義的和保留的_http://www.w3.org/XML/1998/namespace_，這反過來又不能綁定到任何其他前綴。前綴_xmlns_和它的URI_http://www.w3.org/2000/xmlns/_用于命名空間機制本身，因此在聲明中完全禁止的。 ``` QXmlStreamWriter.writeProcessingInstruction (self, QString?target, QString?data?=?QString()) ``` 寫一個XML處理指令_target_和_data_，其中_data_不得包含序列“ ？ \u003e ” 。 ``` QXmlStreamWriter.writeStartDocument (self) ``` 寫入一個文件的開始與XML版本號_version_。 **See also** [writeEndDocument](qxmlstreamwriter.html#writeEndDocument)（）。 ``` QXmlStreamWriter.writeStartDocument (self, QString?version) ``` 寫入一個文件的開始與XML版本號_version_和一個獨立的屬性_standalone_。此功能被引入Qt的4.5 。 **See also** [writeEndDocument](qxmlstreamwriter.html#writeEndDocument)（）。 ``` QXmlStreamWriter.writeStartDocument (self, QString?version, bool?standalone) ``` 這是一個重載函數。寫入一個文件開始的XML版本號“1.0” 。這也寫入編碼信息。此功能被引入Qt的4.5 。 **See also** [writeEndDocument](qxmlstreamwriter.html#writeEndDocument)（）和[setCodec](qxmlstreamwriter.html#setCodec)（）。 ``` QXmlStreamWriter.writeStartElement (self, QString?qualifiedName) ``` 寫一個開始元素與_name_，前綴為指定_namespaceUri_。如果命名空間還沒有被宣布的是，[QXmlStreamWriter](qxmlstreamwriter.html)將生成一個命名空間聲明它。后續調用[writeAttribute](qxmlstreamwriter.html#writeAttribute)（）將屬性添加到這個元素。 **See also** [writeNamespace](qxmlstreamwriter.html#writeNamespace)（）[writeEndElement](qxmlstreamwriter.html#writeEndElement)（）和[writeEmptyElement](qxmlstreamwriter.html#writeEmptyElement)（）。 ``` QXmlStreamWriter.writeStartElement (self, QString?namespaceUri, QString?name) ``` 這是一個重載函數。寫一個開始元素與_qualifiedName_。后續調用[writeAttribute](qxmlstreamwriter.html#writeAttribute)（）將屬性添加到這個元素。 **See also** [writeEndElement](qxmlstreamwriter.html#writeEndElement)（）和[writeEmptyElement](qxmlstreamwriter.html#writeEmptyElement)（）。 ``` QXmlStreamWriter.writeTextElement (self, QString?qualifiedName, QString?text) ``` 寫入一個文本元素與_name_，前綴為指定_namespaceUri_和_text_。如果命名空間還沒有被宣布，[QXmlStreamWriter](qxmlstreamwriter.html)將生成一個命名空間聲明它。這是一個方便的功能等同于： ``` writeStartElement(namespaceUri, name); writeCharacters(text); writeEndElement(); ``` ``` QXmlStreamWriter.writeTextElement (self, QString?namespaceUri, QString?name, QString?text) ``` 這是一個重載函數。寫入一個文本元素與_qualifiedName_和_text_。這是一個方便的功能等同于： ``` writeStartElement(qualifiedName); writeCharacters(text); writeEndElement(); ```