Orcus
Loading...
Searching...
No Matches
orcus::iface::document_dumper Class Referenceabstract

#include <interface.hpp>

Inheritance diagram for orcus::iface::document_dumper:
orcus::spreadsheet::document

Public Member Functions

virtual void dump (dump_format_t format, const std::string &output) const =0
 
virtual void dump_check (std::ostream &os) const =0
 

Detailed Description

Base interface for document content dumpers.

Member Function Documentation

◆ dump()

virtual void orcus::iface::document_dumper::dump ( dump_format_t format,
const std::string & output ) const
pure virtual

Dump the content of a document in a specified format, either into set of multiple files, or a single file.

Parameters
formatOutput format type in which to dump the content.
outputDepending on the output format type, this can be either an output directory path where multiple output files get created, or an output file path where the content of the entire document gets dumped into.

Implemented in orcus::spreadsheet::document.

◆ dump_check()

virtual void orcus::iface::document_dumper::dump_check ( std::ostream & os) const
pure virtual

Dump the content of a document in a specialized "check" format suitable for content verification.

Parameters
osoutput stream to write the transformed content to.

Implemented in orcus::spreadsheet::document.