libodsstream
Library for mass spectrometry
Loading...
Searching...
No Matches
CalcWriterInterface Class Referenceabstract

#include <calcwriterinterface.h>

Inheritance diagram for CalcWriterInterface:
OdsDocWriter TsvDirectoryWriter TsvOutputStream ZipTsvOutputStream

Public Member Functions

virtual ~CalcWriterInterface ()
 
virtual void close ()=0
 
virtual void writeSheet (const QString &sheetName)=0
 open a new sheet
 
virtual void writeLine ()=0
 open a new line
 
virtual void writeCell (const char *cell_text)=0
 write a text cell
 
virtual void writeCell (const QString &cell_text)=0
 write a text cell
 
virtual void writeEmptyCell ()=0
 write an empty cell
 
virtual void writeCell (std::size_t number)=0
 write an unsigned integer in a cell
 
virtual void writeCell (int number)=0
 write an integer in a cell
 
virtual void writeCell (float number)=0
 write a float in a cell
 
virtual void writeCell (double number)=0
 write a double in a cell
 
virtual void writeCellPercentage (double value)=0
 write a double as a percentage
 
virtual void writeCell (bool true_or_false)=0
 write a boolean in a cell
 
virtual void writeCell (const QDate &date)=0
 write a date in a cell
 
virtual void writeCell (const QDateTime &datetime)=0
 write a timestamp in a cell
 
virtual void writeCell (const QUrl &url_link, const QString &text)=0
 write a text cell with an URL link
 
virtual OdsTableCellStyleRef getTableCellStyleRef (const OdsTableCellStyle &style)
 
virtual void setTableCellStyleRef (OdsTableCellStyleRef style_ref)
 
void clearTableCellStyleRef ()
 
virtual void setCellAnnotation (const QString &annotation)=0
 set annotation to write in the next cell
 
virtual void addColorScale (const OdsColorScale &ods_color_scale)
 apply solor scale conditional format on a cell range
 
virtual QString getOdsCellCoordinate ()
 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
 
virtual void setCurrentOdsTableSettings (const OdsTableSettings &settings)
 set ODS table settings of the current sheet (table)
 
virtual void writeCellVariant (const QVariant &var)
 write a cell for a given QVariant
 

Detailed Description

Definition at line 48 of file calcwriterinterface.h.

Constructor & Destructor Documentation

◆ ~CalcWriterInterface()

CalcWriterInterface::~CalcWriterInterface ( )
virtual

Definition at line 41 of file calcwriterinterface.cpp.

42{
43}

Member Function Documentation

◆ addColorScale()

void CalcWriterInterface::addColorScale ( const OdsColorScale ods_color_scale)
virtual

apply solor scale conditional format on a cell range

Reimplemented in OdsDocWriter.

Definition at line 87 of file calcwriterinterface.cpp.

89{
90}

◆ clearTableCellStyleRef()

void CalcWriterInterface::clearTableCellStyleRef ( )

clear cell style definition in the stream. the default style will be applied.

Definition at line 78 of file calcwriterinterface.cpp.

79{
80 setTableCellStyleRef(nullptr);
81}
virtual void setTableCellStyleRef(OdsTableCellStyleRef style_ref)

References setTableCellStyleRef().

◆ close()

virtual void CalcWriterInterface::close ( )
pure virtual

◆ getOdsCellCoordinate()

QString CalcWriterInterface::getOdsCellCoordinate ( )
virtual

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 in OdsDocWriter.

Definition at line 99 of file calcwriterinterface.cpp.

100{
101 return QString();
102}

◆ getTableCellStyleRef()

OdsTableCellStyleRef CalcWriterInterface::getTableCellStyleRef ( const OdsTableCellStyle style)
virtual

build table cell style reference with a style definition

Parameters
styleOdsTableCellStyle
Returns
OdsTableCellStyleRef pointer on a style reference

Reimplemented in OdsDocWriter.

Definition at line 53 of file calcwriterinterface.cpp.

55{
56 return nullptr;
57}

◆ setCellAnnotation()

virtual void CalcWriterInterface::setCellAnnotation ( const QString &  annotation)
pure virtual

set annotation to write in the next cell

Parameters
annotationany comment on this cell

Implemented in OdsDocWriter, and TsvDirectoryWriter.

Referenced by QtableWriter::writeSheet().

◆ setCurrentOdsTableSettings()

void CalcWriterInterface::setCurrentOdsTableSettings ( const OdsTableSettings settings)
virtual

set ODS table settings of the current sheet (table)

Reimplemented in OdsDocWriter.

Definition at line 107 of file calcwriterinterface.cpp.

109{
110}

Referenced by QtableWriter::writeSheet().

◆ setTableCellStyleRef()

void CalcWriterInterface::setTableCellStyleRef ( OdsTableCellStyleRef  style_ref)
virtual

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 in OdsDocWriter.

Definition at line 67 of file calcwriterinterface.cpp.

69{
70}

Referenced by clearTableCellStyleRef().

◆ writeCell() [1/10]

virtual void CalcWriterInterface::writeCell ( bool  true_or_false)
pure virtual

write a boolean in a cell

Parameters
true_or_falseboolean to write

Implemented in OdsDocWriter, and TsvDirectoryWriter.

◆ writeCell() [2/10]

virtual void CalcWriterInterface::writeCell ( const char *  cell_text)
pure virtual

write a text cell

Parameters
cell_textcell text

Implemented in OdsDocWriter, and TsvDirectoryWriter.

Referenced by writeCellVariant(), and QtableWriter::writeSheet().

◆ writeCell() [3/10]

virtual void CalcWriterInterface::writeCell ( const QDate &  date)
pure virtual

write a date in a cell

Parameters
datedate to write

Implemented in OdsDocWriter, and TsvDirectoryWriter.

◆ writeCell() [4/10]

virtual void CalcWriterInterface::writeCell ( const QDateTime &  datetime)
pure virtual

write a timestamp in a cell

Parameters
datetimetimestamp to write

Implemented in OdsDocWriter, and TsvDirectoryWriter.

◆ writeCell() [5/10]

virtual void CalcWriterInterface::writeCell ( const QString &  cell_text)
pure virtual

write a text cell

Parameters
cell_textcell text

Implemented in OdsDocWriter, and TsvDirectoryWriter.

◆ writeCell() [6/10]

virtual void CalcWriterInterface::writeCell ( const QUrl &  url_link,
const QString &  text 
)
pure virtual

write a text cell with an URL link

Parameters
url_linkURL link
texttext to write

Implemented in OdsDocWriter, and TsvDirectoryWriter.

◆ writeCell() [7/10]

virtual void CalcWriterInterface::writeCell ( double  number)
pure virtual

write a double in a cell

Parameters
numberdouble to write

Implemented in OdsDocWriter, and TsvDirectoryWriter.

◆ writeCell() [8/10]

virtual void CalcWriterInterface::writeCell ( float  number)
pure virtual

write a float in a cell

Parameters
numberfloat to write

Implemented in OdsDocWriter, and TsvDirectoryWriter.

◆ writeCell() [9/10]

virtual void CalcWriterInterface::writeCell ( int  number)
pure virtual

write an integer in a cell

Parameters
numberinteger to write

Implemented in OdsDocWriter, and TsvDirectoryWriter.

◆ writeCell() [10/10]

virtual void CalcWriterInterface::writeCell ( std::size_t  number)
pure virtual

write an unsigned integer in a cell

Parameters
numberinteger to write

Implemented in OdsDocWriter, and TsvDirectoryWriter.

◆ writeCellPercentage()

virtual void CalcWriterInterface::writeCellPercentage ( double  value)
pure virtual

write a double as a percentage

Parameters
numberdouble to write must be a ratio (0.5 == 50%)

Implemented in OdsDocWriter, and TsvDirectoryWriter.

Referenced by QtableWriter::writeSheet().

◆ writeCellVariant()

void CalcWriterInterface::writeCellVariant ( const QVariant &  var)
virtual

write a cell for a given QVariant

Parameters
QVariantvariable to write

Definition at line 117 of file calcwriterinterface.cpp.

118{
119 int type = var.metaType().id();
120 switch(type)
121 {
122 case QMetaType::Void:
124 break;
125 case QMetaType::Bool:
126 writeCell(var.toBool());
127 break;
128 case QMetaType::Double:
129 case QMetaType::Float:
130 writeCell(var.toDouble());
131 break;
132 case QMetaType::Int:
133 writeCell(var.toInt());
134 break;
135 case QMetaType::QDate:
136 writeCell(var.toDate());
137 break;
138 case QMetaType::QDateTime:
139 writeCell(var.toDateTime());
140 break;
141 case QMetaType::QString:
142 writeCell(var.toString());
143 break;
144 case QMetaType::QUrl:
145 writeCell(var.toUrl(), var.toUrl().toString());
146 break;
147 default:
148 writeCell(var.toString());
149 }
150}
virtual void writeEmptyCell()=0
write an empty cell
virtual void writeCell(const char *cell_text)=0
write a text cell

References writeCell(), and writeEmptyCell().

◆ writeEmptyCell()

virtual void CalcWriterInterface::writeEmptyCell ( )
pure virtual

write an empty cell

Implemented in OdsDocWriter, and TsvDirectoryWriter.

Referenced by writeCellVariant(), and QtableWriter::writeSheet().

◆ writeLine()

virtual void CalcWriterInterface::writeLine ( )
pure virtual

open a new line

Implemented in OdsDocWriter, and TsvDirectoryWriter.

Referenced by QtableWriter::writeSheet().

◆ writeSheet()

virtual void CalcWriterInterface::writeSheet ( const QString &  sheetName)
pure virtual

open a new sheet

Parameters
sheetNamethe sheet name

Implemented in OdsDocWriter, TsvDirectoryWriter, TsvOutputStream, and ZipTsvOutputStream.

Referenced by QtableWriter::writeSheet().


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