odsstream
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdsDocWriter Class Reference
Inheritance diagram for OdsDocWriter:
CalcWriterInterface

Public Member Functions

 OdsDocWriter (const QString &filename)
 
 OdsDocWriter (QIODevice *device)
 
void close () override
 
void writeSheet (const QString &sheetName) override
 
void writeLine () override
 
void writeCell (const char *) override
 write a text cell
 
void writeCell (const QString &) override
 
void writeEmptyCell () override
 
void writeCell (std::size_t) override
 
void writeCell (int) override
 
void writeCell (float) override
 
void writeCell (double) override
 
void writeCellPercentage (double value) override
 
void writeCell (bool) override
 
void writeCell (const QDate &) override
 
void writeCell (const QDateTime &) override
 
void writeCell (const QUrl &, const QString &) override
 
OdsTableCellStyleRef getTableCellStyleRef (const OdsTableCellStyle &style) override
 
void setTableCellStyleRef (OdsTableCellStyleRef style_ref) override
 
void setCellAnnotation (const QString &annotation) override
 set annotation to write in the next cell
 
void addColorScale (const OdsColorScale &ods_color_scale) override
 apply solor scale conditional format on a cell range
 
QString getOdsCellCoordinate () override
 get the last written cell coordinate in ODS coordinate format get the coordinate of the last written cell or an empty string if the writer is not an OdsDocWriter
 
void setCurrentOdsTableSettings (const OdsTableSettings &settings) override
 set ODS table settings of the current sheet (table)
 
- Public Member Functions inherited from CalcWriterInterface
void clearTableCellStyleRef ()
 

Member Function Documentation

◆ addColorScale()

void OdsDocWriter::addColorScale ( const OdsColorScale ods_color_scale)
overridevirtual

apply solor scale conditional format on a cell range

Reimplemented from CalcWriterInterface.

◆ close()

void OdsDocWriter::close ( )
overridevirtual

ends the document creation. It is required to obtain a correct output

Implements CalcWriterInterface.

◆ getOdsCellCoordinate()

QString OdsDocWriter::getOdsCellCoordinate ( )
overridevirtual

get the last written cell coordinate in ODS coordinate format get the coordinate of the last written cell or an empty string if the writer is not an OdsDocWriter

Returns
QString with ODS cell coordinate of the form : "classeur.A5"

Reimplemented from CalcWriterInterface.

◆ getTableCellStyleRef()

OdsTableCellStyleRef OdsDocWriter::getTableCellStyleRef ( const OdsTableCellStyle style)
overridevirtual

get a table cell style reference with a style definition

Parameters
styleOdsTableCellStyle
Returns
OdsTableCellStyleRef pointer on a style reference

Reimplemented from CalcWriterInterface.

◆ setCellAnnotation()

void OdsDocWriter::setCellAnnotation ( const QString &  annotation)
overridevirtual

set annotation to write in the next cell

Parameters
annotationany comment on this cell

Implements CalcWriterInterface.

◆ setCurrentOdsTableSettings()

void OdsDocWriter::setCurrentOdsTableSettings ( const OdsTableSettings settings)
overridevirtual

set ODS table settings of the current sheet (table)

Reimplemented from CalcWriterInterface.

◆ setTableCellStyleRef()

void OdsDocWriter::setTableCellStyleRef ( OdsTableCellStyleRef  style_ref)
overridevirtual

set the cell table style. This is applied to in the stream to following cells. This ends by using an other style reference or by using setTableCellStyleRef function

Parameters
style_refOdsTableCellStyleRef

Reimplemented from CalcWriterInterface.

◆ writeCell() [1/10]

void OdsDocWriter::writeCell ( bool  value)
overridevirtual

adds a new cell containing a boolean

Parameters
value
Exceptions
XMLStreamException

Implements CalcWriterInterface.

◆ writeCell() [2/10]

void OdsDocWriter::writeCell ( const char *  cell_text)
overridevirtual

write a text cell

Parameters
cell_textcell text

Implements CalcWriterInterface.

◆ writeCell() [3/10]

void OdsDocWriter::writeCell ( const QDate &  date)
overridevirtual

adds a new cell containing a date

Parameters
date
Exceptions
XMLStreamException
DatatypeConfigurationException

Implements CalcWriterInterface.

◆ writeCell() [4/10]

void OdsDocWriter::writeCell ( const QDateTime &  date)
overridevirtual

adds a new cell containing a timestamp

Parameters
date
Exceptions
XMLStreamException
DatatypeConfigurationException

Implements CalcWriterInterface.

◆ writeCell() [5/10]

void OdsDocWriter::writeCell ( const QString &  text)
overridevirtual

adds a new text cell to the document

Parameters
text
Exceptions
XMLStreamException

Implements CalcWriterInterface.

◆ writeCell() [6/10]

void OdsDocWriter::writeCell ( const QUrl &  theUri,
const QString &  text 
)
overridevirtual

NOT WORKING, adds a new cell containing a duration

Parameters
duration
Exceptions
XMLStreamException
DatatypeConfigurationExceptionadds a new cell containing a text inside an href link
Parameters
theUri
text
Exceptions
XMLStreamException

Implements CalcWriterInterface.

◆ writeCell() [7/10]

void OdsDocWriter::writeCell ( double  value)
overridevirtual

adds a new cell containing a double

Parameters
value
Exceptions
XMLStreamException

Implements CalcWriterInterface.

◆ writeCell() [8/10]

void OdsDocWriter::writeCell ( float  value)
overridevirtual

adds a new cell containing a float

Parameters
value
Exceptions
XMLStreamException

Implements CalcWriterInterface.

◆ writeCell() [9/10]

void OdsDocWriter::writeCell ( int  value)
overridevirtual

adds a new cell containing an integer

Parameters
value
Exceptions
XMLStreamException

Implements CalcWriterInterface.

◆ writeCell() [10/10]

void OdsDocWriter::writeCell ( std::size_t  value)
overridevirtual

adds a new cell containing an integer

Parameters
value
Exceptions
XMLStreamException

Implements CalcWriterInterface.

◆ writeCellPercentage()

void OdsDocWriter::writeCellPercentage ( double  value)
overridevirtual

adds a new cell containing a percentage

Parameters
value
Exceptions
XMLStreamException

Implements CalcWriterInterface.

◆ writeEmptyCell()

void OdsDocWriter::writeEmptyCell ( )
overridevirtual

writes an empty cell

Exceptions
XMLStreamException

Implements CalcWriterInterface.

◆ writeLine()

void OdsDocWriter::writeLine ( )
overridevirtual

adds a new line to the document

Exceptions
XMLStreamException

Implements CalcWriterInterface.

◆ writeSheet()

void OdsDocWriter::writeSheet ( const QString &  sheetName)
overridevirtual

adds a new datasheet to the document

Parameters
sheetName
Exceptions
XMLStreamException

Implements CalcWriterInterface.


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