This is the documentation for Enlighten.
class Enlighten XmlWriter
- William Joseph
class Enlighten::XmlWriter
Exports pretty-printed XML to a file.
Functions
| Name | Description |
|---|---|
| Close() | Closes the file stream and flushes the stream to disk. |
| CloseElement(const char *) | Close the element previously opened. Call exactly once for each call to OpenElement, in reverse order. |
| Failed() | Returns true if outputting the XML file failed. |
| OpenElement(const char *) | Open an element with the specified name. |
| WriteAttribute(bool, const char *, const char *) | Writes an attribute with a value. |
| WriteAttribute(bool, const char *, Geo::s32) | Writes an attribute with a value. |
| WriteAttribute(bool, const char *, Geo::u32) | Writes an attribute with a value. |
| WriteAttribute(bool, const char *, bool) | Writes an attribute with a value. |
| WriteAttribute(bool, const char *, float) | Writes an attribute with a value. |
| WriteAttribute(bool, const char *, const Geo::GeoVector3 &) | Writes an attribute with a value. |
| WriteAttribute(bool, const char *, const Geo::GeoVector4 &) | Writes an attribute with a value. |
| WriteAttribute(bool, const char *, const LinearColor &) | Writes an attribute with a value. |
| WriteAttribute(bool, const char *, const Geo::Matrix &) | Writes an attribute with a value. |
| WriteAttribute(bool, const char *, const Geo::GeoGuid &) | Writes an attribute with a value. |
| WriteAttribute(const char *, const T &) | Writes an attribute on the current line. |
| WriteAttributeNewLine(const char *, const T &) | Writes an attribute on a new line. |
| WriteComment(bool, const char *) | Writes a comment. |
| WriteComment(const char *) | Writes the supplied text as a comment on the current line. |
| WriteCommentNewLine(const char *) | Writes the supplied text as a comment on a new line. |
| WriteEmptyLine() | Writes an empty line to the output. |
| WriteText(const char *) | Writes content text on the current line. |
| WriteText(bool, const char *) | Writes content text. |
| WriteTextNewLine(const char *) | Writes content text on a new line. |
| XmlWriter(Geo::GeoFileString) | Constructs an XmlWriter object for writing to "filename" and initializes the output stream. |
void Enlighten::XmlWriter::Close
public: void Close()
Closes the file stream and flushes the stream to disk.
void Enlighten::XmlWriter::CloseElement
public: void CloseElement
(
  const char * name
)
Close the element previously opened. Call exactly once for each call to OpenElement, in reverse order.
bool Enlighten::XmlWriter::Failed
public: bool Failed()
Returns true if outputting the XML file failed.
void Enlighten::XmlWriter::OpenElement
public: void OpenElement
(
  const char * name
)
Open an element with the specified name.
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  bool newLine,
  const char * name,
  const char * value
)
Writes an attribute with a value.
Parameters
| newLine | Write on a new line if true. |
|
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  bool newLine,
  const char * name,
  Geo::s32 value
)
Writes an attribute with a value.
Parameters
| newLine | Write on a new line if true. |
|
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  bool newLine,
  const char * name,
  Geo::u32 value
)
Writes an attribute with a value.
Parameters
| newLine | Write on a new line if true. |
|
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  bool newLine,
  const char * name,
  bool value
)
Writes an attribute with a value.
Parameters
| newLine | Write on a new line if true. |
|
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  bool newLine,
  const char * name,
  float value
)
Writes an attribute with a value.
Parameters
| newLine | Write on a new line if true. |
|
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  bool newLine,
  const char * name,
  const Geo::GeoVector3 & value
)
Writes an attribute with a value.
Parameters
| newLine | Write on a new line if true. |
|
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  bool newLine,
  const char * name,
  const Geo::GeoVector4 & value
)
Writes an attribute with a value.
Parameters
| newLine | Write on a new line if true. |
|
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  bool newLine,
  const char * name,
  const LinearColor & value
)
Writes an attribute with a value.
Parameters
| newLine | Write on a new line if true. |
|
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  bool newLine,
  const char * name,
  const Geo::Matrix & value
)
Writes an attribute with a value.
Parameters
| newLine | Write on a new line if true. |
|
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  bool newLine,
  const char * name,
  const Geo::GeoGuid & value
)
Writes an attribute with a value.
Parameters
| newLine | Write on a new line if true. |
|
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttribute
public: void WriteAttribute
(
  const char * name,
  const T & value
)
Writes an attribute on the current line.
Parameters
| name | The name of the attribute to write. |
|
| value | The value to write. |
void Enlighten::XmlWriter::WriteAttributeNewLine
public: void WriteAttributeNewLine
(
  const char * name,
  const T & value
)
Writes an attribute on a new line.
Parameters
| name | The name of the attribute. |
|
| value | The value of the attribute. |
void Enlighten::XmlWriter::WriteComment
public: void WriteComment
(
  bool newLine,
  const char * text
)
Writes a comment.
Parameters
| newLine | Write on a new line if true. |
|
| text | The comment text to write. |
void Enlighten::XmlWriter::WriteComment
public: void WriteComment
(
  const char * text
)
Writes the supplied text as a comment on the current line.
void Enlighten::XmlWriter::WriteCommentNewLine
public: void WriteCommentNewLine
(
  const char * text
)
Writes the supplied text as a comment on a new line.
void Enlighten::XmlWriter::WriteEmptyLine
public: void WriteEmptyLine()
Writes an empty line to the output.
void Enlighten::XmlWriter::WriteText
public: void WriteText
(
  const char * text
)
Writes content text on the current line.
Parameters
| text | The text to write. |
void Enlighten::XmlWriter::WriteText
public: void WriteText
(
  bool newLine,
  const char * text
)
Writes content text.
Parameters
| newLine | Write on a new line if true. |
|
| text | The text to write. |
void Enlighten::XmlWriter::WriteTextNewLine
public: void WriteTextNewLine
(
  const char * text
)
Writes content text on a new line.
Parameters
| text | The text to write. |
Enlighten::XmlWriter::XmlWriter
public: XmlWriter
(
  Geo::GeoFileString filename
)
Constructs an XmlWriter object for writing to "filename" and initializes the output stream.