Marble::GeoDataDocumentWriter Class Reference

#include <GeoDataDocumentWriter.h>

Static Public Member Functions
static void	registerWriter (GeoWriterBackend *writer, const QString &fileExtension)
static void	unregisterWriter (GeoWriterBackend *writer, const QString &fileExtension)
static bool	write (const QString &filename, const GeoDataDocument &document, const QString &documentIdentifier=QString())
static bool	write (QIODevice *device, const GeoDataDocument &document, const QString &documentIdentifier)

Detailed Description

Write GeoDataDocument content to I/O devices (e.g.

a file)

Definition at line 23 of file GeoDataDocumentWriter.h.

Member Function Documentation

registerWriter()

void Marble::GeoDataDocumentWriter::registerWriter ( GeoWriterBackend * writer, const QString & fileExtension )

static

Registers a plugin as a backend for writing a certain file extension.

Usually called by the MARBLE_ADD_WRITER macro.

Parameters

writer	Backend to register
fileExtension	File extension to associate the backend with

Definition at line 54 of file GeoDataDocumentWriter.cpp.

unregisterWriter()

void Marble::GeoDataDocumentWriter::unregisterWriter ( GeoWriterBackend * writer, const QString & fileExtension )

static

Definition at line 59 of file GeoDataDocumentWriter.cpp.

write() [1/2]

bool Marble::GeoDataDocumentWriter::write ( const QString & filename, const GeoDataDocument & document, const QString & documentIdentifier = QString() )

static

Convenience method that uses a QFile as QIODevice and determines the document type from the filename extension.

Parameters

filename	Target file's name
document	Document to write
documentIdentifier	XML document identifier or filename extension that determines the content type. Use an empty string (default) to determine it automatically

Returns

True if writing is successful, false otherwise

Definition at line 42 of file GeoDataDocumentWriter.cpp.

write() [2/2]

bool Marble::GeoDataDocumentWriter::write ( QIODevice * device, const GeoDataDocument & document, const QString & documentIdentifier )

static

Write the content of the given GeoDataDocument to the given I/O device.

Parameters

device	An I/O device open for writing
document	A GeoDataDocument with content to write
documentIdentifier	XML document identifier or file extension that determines

Returns

True if writing is successful, false otherwise

Definition at line 22 of file GeoDataDocumentWriter.cpp.

---

The documentation for this class was generated from the following files:

• GeoDataDocumentWriter.h
• GeoDataDocumentWriter.cpp