Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
DocumentWriter Class Referenceabstract

Interface for writing documentation output. More...

#include <documentwriter.h>

Inheritance diagram for DocumentWriter:
Collaboration diagram for DocumentWriter:

Public Member Functions

virtual ~DocumentWriter ()=default
virtual void write (QStringView content)=0
 Writes content to the output without a trailing newline.
virtual void writeLine (QStringView content={})=0
 Writes content to the output followed by a newline.
virtual bool isOpen () const =0
 Returns true if a document is currently open for writing.
virtual QString currentFileName () const =0
 Returns the file name of the currently open document, or an empty string if no document is open.

Detailed Description

Interface for writing documentation output.

DocumentWriter abstracts the output destination for documentation generators, enabling:

\list

  • Unit testing with in-memory writers (StringDocumentWriter)
  • Production file-based output (FileDocumentWriter)
  • Future extensions (network, database, etc.) \endlist

This interface replaces Generator::out() which was coupled to a QTextStream stack managed by beginSubPage()/endSubPage().

void generateDocument(DocumentWriter &writer) {
writer.write("<html>");
writer.writeLine("<body>");
writer.write("Content here");
writer.writeLine("</body></html>");
}
DocumentWriter
Interface for writing documentation output.
Definition documentwriter.h:43
DocumentWriter::writeLine
virtual void writeLine(QStringView content={})=0
Writes content to the output followed by a newline.
DocumentWriter::write
virtual void write(QStringView content)=0
Writes content to the output without a trailing newline.
See also
FileDocumentWriter, StringDocumentWriter

Definition at line 42 of file documentwriter.h.

Constructor & Destructor Documentation

◆ ~DocumentWriter()

virtual DocumentWriter::~DocumentWriter ( )
virtualdefault

Member Function Documentation

◆ currentFileName()

virtual QString DocumentWriter::currentFileName ( ) const
nodiscardpure virtual

Returns the file name of the currently open document, or an empty string if no document is open.

Implemented in FileDocumentWriter.

◆ isOpen()

virtual bool DocumentWriter::isOpen ( ) const
nodiscardpure virtual

Returns true if a document is currently open for writing.

Implemented in FileDocumentWriter.

◆ write()

virtual void DocumentWriter::write ( QStringView content)
pure virtual

Writes content to the output without a trailing newline.

Implemented in FileDocumentWriter.

◆ writeLine()

virtual void DocumentWriter::writeLine ( QStringView content = {})
pure virtual

Writes content to the output followed by a newline.

Implemented in FileDocumentWriter.

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