RagTime5Spreadsheet Class Reference documentation

RagTime5Spreadsheet Class Reference

the main class to read the spreadsheet part of RagTime 56 file More...

`#include <RagTime5Spreadsheet.hxx>`

## Public Member Functions
| RagTime5Spreadsheet (RagTime5Document &doc)
| constructor
virtual | ~RagTime5Spreadsheet ()
| destructor
int | version () const
| returns the file version
int | numPages () const
| returns the number of pages
bool | getFormulaRef (int sheetId, int refId, MWAWCellContent::FormulaInstruction &instruction) const
| returns a formula instruction corresponding to a sheetId and refId

## Static Public Member Functions
static std::string | printType (unsigned long fileType)
| debug: print a file type

## Protected Member Functions
bool | send (int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0)
| try to send the cluster zone
bool | send (RagTime5SpreadsheetInternal::Sheet &sheet, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0)
| try to send the cluster zone
bool | send (RagTime5SpreadsheetInternal::Sheet &sheet, int plane, RagTime5SpreadsheetInternal::CellContent const &cell, int numRepeated, MWAWSpreadsheetListenerPtr &listener)
| try to send a cell
std::vector< int > | getSheetIdList () const
| return the sheet data id list
void | flushExtra (bool onlyCheck=false)
| sends the data which have not yet been sent to the listener
std::shared_ptr< RagTime5ClusterManager::Cluster > | readSpreadsheetCluster (RagTime5Zone &zone, int zoneType)
| try to read a spreadsheet cluster
void | parseSpreadsheetFormulas ()
| parses all the formula structure linked to a spreadsheet
void | storeFormula (int sheetId, std::map< int, std::vector< MWAWCellContent::FormulaInstruction > > const &idToFormula)
| store the formula corresponding to a sheetId
bool | readSheetDimensions (RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link)
| try to read the spreadsheet dimensions
bool | readValuesTree (RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link, int rootId, MWAWVec3i const &maxPos)
| try to read a spreadsheet tree of values
bool | readCellBlocks (RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link, bool unionBlock)
| try to read a spreadsheet referenced/union zones
bool | readCellRefPos (RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link)
| try to read the cell ref to value zone

## Protected Attributes
RagTime5Document & | m_document
| the parser
std::shared_ptr< RagTime5StructManager > | m_structManager
| the structure manager
std::shared_ptr< RagTime5StyleManager > | m_styleManager
| the style manager
MWAWParserStatePtr | m_parserState
| the parser state
std::shared_ptr< RagTime5SpreadsheetInternal::State > | m_state
| the state

## Private Member Functions
| RagTime5Spreadsheet (RagTime5Spreadsheet const &orig)=delete
RagTime5Spreadsheet & | operator= (RagTime5Spreadsheet const &orig)=delete

## Friends
class | RagTime5SpreadsheetInternal::SubDocument
class | RagTime5Document
class | RagTime5Formula

## Detailed Description

the main class to read the spreadsheet part of RagTime 56 file

## Constructor & Destructor Documentation

## ◆ RagTime5Spreadsheet() [1/2]

RagTime5Spreadsheet::RagTime5Spreadsheet | ( | RagTime5Document & | doc | ) |
| explicit

constructor

Referenced by operator=(), and RagTime5Spreadsheet().

## ◆ ~RagTime5Spreadsheet()

RagTime5Spreadsheet::~RagTime5Spreadsheet | ( |  | ) |
| virtual

destructor

## ◆ RagTime5Spreadsheet() [2/2]

RagTime5Spreadsheet::RagTime5Spreadsheet | ( | RagTime5Spreadsheet const & | orig | ) |
| privatedelete

## Member Function Documentation

## ◆ flushExtra()

void RagTime5Spreadsheet::flushExtra | ( | bool | onlyCheck = false | ) |
| protected

sends the data which have not yet been sent to the listener

## ◆ getFormulaRef()

bool RagTime5Spreadsheet::getFormulaRef | ( | int | sheetId,
|  | int | refId,
|  | MWAWCellContent::FormulaInstruction & | instruction ) const

returns a formula instruction corresponding to a sheetId and refId

## ◆ getSheetIdList()

std::vector< int > RagTime5Spreadsheet::getSheetIdList | ( |  | ) | const
| protected

return the sheet data id list

## ◆ numPages()

int RagTime5Spreadsheet::numPages | ( |  | ) | const

returns the number of pages

## ◆ operator=()

RagTime5Spreadsheet & RagTime5Spreadsheet::operator= | ( | RagTime5Spreadsheet const & | orig | ) |
| privatedelete

## ◆ parseSpreadsheetFormulas()

void RagTime5Spreadsheet::parseSpreadsheetFormulas | ( |  | ) |
| protected

parses all the formula structure linked to a spreadsheet

## ◆ printType()

std::string RagTime5Spreadsheet::printType | ( | unsigned long | fileType | ) |
| inlinestatic

debug: print a file type

Referenced by RagTime5SpreadsheetInternal::SpreadsheetCParser::parseDataZone(), and RagTime5SpreadsheetInternal::SpreadsheetCParser::parseHeaderZone().

## ◆ readCellBlocks()

bool RagTime5Spreadsheet::readCellBlocks | ( | RagTime5SpreadsheetInternal::Sheet & | sheet,
|  | RagTime5Zone & | zone,
|  | RagTime5ClusterManager::Link const & | link,
|  | bool | unionBlock )
| protected

try to read a spreadsheet referenced/union zones

Referenced by readSpreadsheetCluster().

## ◆ readCellRefPos()

bool RagTime5Spreadsheet::readCellRefPos | ( | RagTime5SpreadsheetInternal::Sheet & | sheet,
|  | RagTime5Zone & | zone,
|  | RagTime5ClusterManager::Link const & | link )
| protected

try to read the cell ref to value zone

Referenced by readSpreadsheetCluster().

## ◆ readSheetDimensions()

bool RagTime5Spreadsheet::readSheetDimensions | ( | RagTime5SpreadsheetInternal::Sheet & | sheet,
|  | RagTime5Zone & | zone,
|  | RagTime5ClusterManager::Link const & | link )
| protected

try to read the spreadsheet dimensions

Referenced by readSpreadsheetCluster().

## ◆ readSpreadsheetCluster()

std::shared_ptr< RagTime5ClusterManager::Cluster > RagTime5Spreadsheet::readSpreadsheetCluster | ( | RagTime5Zone & | zone,
|  | int | zoneType )
| protected

try to read a spreadsheet cluster

## ◆ readValuesTree()

bool RagTime5Spreadsheet::readValuesTree | ( | RagTime5SpreadsheetInternal::Sheet & | sheet,
|  | RagTime5Zone & | zone,
|  | RagTime5ClusterManager::Link const & | link,
|  | int | rootId,
|  | MWAWVec3i const & | maxPos )
| protected

try to read a spreadsheet tree of values

Referenced by readSpreadsheetCluster().

## ◆ send() [1/3]

bool RagTime5Spreadsheet::send | ( | int | zoneId,
|  | MWAWListenerPtr | listener,
|  | MWAWPosition const & | pos,
|  | int | partId = 0 )
| protected

try to send the cluster zone

Referenced by flushExtra(), send(), and send().

## ◆ send() [2/3]

bool RagTime5Spreadsheet::send | ( | RagTime5SpreadsheetInternal::Sheet & | sheet,
|  | int | plane,
|  | RagTime5SpreadsheetInternal::CellContent const & | cell,
|  | int | numRepeated,
|  | MWAWSpreadsheetListenerPtr & | listener )
| protected

try to send a cell

## ◆ send() [3/3]

bool RagTime5Spreadsheet::send | ( | RagTime5SpreadsheetInternal::Sheet & | sheet,
|  | MWAWListenerPtr | listener,
|  | MWAWPosition const & | pos,
|  | int | partId = 0 )
| protected

try to send the cluster zone

## ◆ storeFormula()

void RagTime5Spreadsheet::storeFormula | ( | int | sheetId,
|  | std::map< int, std::vector< MWAWCellContent::FormulaInstruction > > const & | idToFormula )
| protected

store the formula corresponding to a sheetId

## ◆ version()

int RagTime5Spreadsheet::version | ( |  | ) | const

returns the file version

## Friends And Related Symbol Documentation

## ◆ RagTime5Document

friend class RagTime5Document
| friend

Referenced by RagTime5Document, RagTime5Formula, and RagTime5Spreadsheet().

## ◆ RagTime5Formula

friend class RagTime5Formula
| friend

Referenced by RagTime5Formula.

## ◆ RagTime5SpreadsheetInternal::SubDocument

friend class RagTime5SpreadsheetInternal::SubDocument
| friend

Referenced by RagTime5SpreadsheetInternal::SubDocument.

## Member Data Documentation

## ◆ m_document

RagTime5Document& RagTime5Spreadsheet::m_document
| protected

the parser

Referenced by parseSpreadsheetFormulas(), RagTime5Spreadsheet(), readSpreadsheetCluster(), and send().

## ◆ m_parserState

MWAWParserStatePtr RagTime5Spreadsheet::m_parserState
| protected

the parser state

Referenced by flushExtra(), RagTime5Spreadsheet(), send(), send(), and version().

## ◆ m_state

std::shared_ptr<RagTime5SpreadsheetInternal::State> RagTime5Spreadsheet::m_state
| protected

the state

Referenced by flushExtra(), getFormulaRef(), getSheetIdList(), numPages(), parseSpreadsheetFormulas(), RagTime5Spreadsheet(), readSpreadsheetCluster(), send(), and storeFormula().

## ◆ m_structManager

std::shared_ptr<RagTime5StructManager> RagTime5Spreadsheet::m_structManager
| protected

the structure manager

Referenced by RagTime5Spreadsheet().

## ◆ m_styleManager

std::shared_ptr<RagTime5StyleManager> RagTime5Spreadsheet::m_styleManager
| protected

the style manager

Referenced by RagTime5Spreadsheet(), send(), and send().

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

- RagTime5Spreadsheet.hxx
- RagTime5Spreadsheet.cxx