Go to the documentation of this file.
38 #ifndef CLARIS_WKS_DOCUMENT
39 # define CLARIS_WKS_DOCUMENT
110 std::shared_ptr<ClarisWksStruct::DSET>
getZone(
int zId)
const;
114 void newPage(
int page,
bool softBreak=
false);
211 std::shared_ptr<ClarisWksStruct::DSET>
readDSET(
bool &complete);
224 bool readStructCellZone(
char const *zoneName,
bool hasEntete, std::vector<MWAWVec2i> &res);
226 bool readStringList(
char const *zoneName,
bool hasEntete, std::vector<std::string> &res);
233 void checkOrdering(std::vector<int16_t> &vec16, std::vector<int32_t> &vec32)
const;
239 std::shared_ptr<ClarisWksDocumentInternal::State>
m_state;
long m_size
the size of the DSET header
Definition: ClarisWksStruct.hxx:178
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
int m_id
the zone identificator
Definition: ClarisWksStruct.hxx:199
@ MWAW_K_DATABASE
database
Definition: MWAWDocument.hxx:87
std::vector< int > m_hFZonesList
the list of header/footer group
Definition: ClarisWksDocument.cxx:131
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
the main class to read the text part of Claris Works file
Definition: ClarisWksTable.hxx:70
std::shared_ptr< ClarisWksTable > getTableParser()
returns the table parser
Definition: ClarisWksDocument.hxx:159
@ MWAW_K_UNKNOWN
unknown
Definition: MWAWDocument.hxx:81
bool m_pageSpanSet
a flag to know if pageSpan is filled
Definition: ClarisWksDocument.cxx:102
std::shared_ptr< ClarisWksDatabase > m_databaseParser
the database parser
Definition: ClarisWksDocument.hxx:251
std::shared_ptr< ClarisWksGraph > m_graphParser
the graph parser
Definition: ClarisWksDocument.hxx:253
void setPageSpan(const int pageSpan)
set the page span ( default 1)
Definition: MWAWPageSpan.hxx:268
@ MWAW_K_SPREADSHEET
spreadsheet
Definition: MWAWDocument.hxx:86
bool readPrintInfo()
read the print info zone
Definition: ClarisWksDocument.cxx:2309
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:842
@ P_Table
Definition: ClarisWksStruct.hxx:91
void addDelimiter(long pos, char c)
adds a not breaking delimiter in position pos
Definition: MWAWDebug.cxx:73
State()
constructor
Definition: ClarisWksDocument.cxx:73
long m_headerSize
the header size
Definition: ClarisWksStruct.hxx:75
bool readStructZone(MWAWParserState &parserState, char const *zoneName, bool hasEntete)
try to read a structured zone with unknown content
Definition: ClarisWksStruct.cxx:162
~SubDocument() final
destructor
Definition: ClarisWksDocument.cxx:149
@ MWAW_K_PAINT
bitmap graphic
Definition: MWAWDocument.hxx:84
the main class to read a bitmap AppleWorks/ClarisWorks file
Definition: ClarisWksBMParser.hxx:66
void checkOrdering(std::vector< int16_t > &vec16, std::vector< int32_t > &vec32) const
small fonction used to check unusual endian ordering of a list of int16_t, int32_t
Definition: ClarisWksDocument.cxx:376
std::shared_ptr< ClarisWksStruct::DSET > getZone(int zId) const
return the zone corresponding to an id ( low level)
Definition: ClarisWksDocument.cxx:415
librevenge::RVNGPropertyList m_metaData
the metadata
Definition: ClarisWksDocument.cxx:111
void setMarginBottom(const double marginBottom)
set the page bottom margin
Definition: MWAWPageSpan.hxx:208
the main class to read the text part of Claris Works file
Definition: ClarisWksDatabase.hxx:72
void appendUnicode(uint32_t val, librevenge::RVNGString &buffer)
adds an unicode character to a string
Definition: libmwaw_internal.cxx:63
@ Presentation
Definition: MWAWListener.hxx:56
int m_textType
the text type (header/footer,footnote, ...)
Definition: ClarisWksStruct.hxx:209
int m_footerId
the footer zone if known
Definition: ClarisWksDocument.cxx:113
int m_footerHeight
the footer height if known
Definition: ClarisWksDocument.cxx:115
std::string const & type() const
returns the type of the entry
Definition: MWAWEntry.hxx:137
Kind
an enum to define the kind of document
Definition: MWAWDocument.hxx:80
MWAWVec2i m_pages
the number of pages find in the header ( if known )
Definition: ClarisWksDocument.cxx:107
@ MWAW_K_DRAW
vectorized grphic
Definition: MWAWDocument.hxx:83
bool sendZone(int zoneId, MWAWListenerPtr listener=MWAWListenerPtr(), MWAWPosition pos=MWAWPosition())
try to send a zone
Definition: ClarisWksDocument.cxx:453
void setMarginLeft(const double marginLeft)
set the page left margin
Definition: MWAWPageSpan.hxx:193
MWAWVec2f getPageLeftTop() const
returns the page left top point ( in inches)
Definition: ClarisWksDocument.cxx:317
std::shared_ptr< ClarisWksPresentation > m_presentationParser
the spreadsheet parser
Definition: ClarisWksDocument.hxx:255
ClarisWksDocument(ClarisWksDocument const &orig)=delete
std::shared_ptr< ClarisWksTable > m_tableParser
the table parser
Definition: ClarisWksDocument.hxx:259
the AppleŠ printer information : TPrint
Definition: MWAWPrinter.hxx:82
int m_endSelection
the end of selection ( at least in text header)
Definition: ClarisWksStruct.hxx:206
main document information used to create a ClarisWorks file
Definition: ClarisWksDocument.hxx:74
bool readZone()
read a zone
Definition: ClarisWksDocument.cxx:746
Internal: the state of a ClarisWksDocument.
Definition: ClarisWksDocument.cxx:71
the main class to read the text part of Claris Works file
Definition: ClarisWksSpreadsheet.hxx:71
void addNote(char const *note)
adds a note in the file, in actual position
Definition: MWAWDebug.cxx:59
abstract class used to store a subdocument (with a comparison function)
Definition: MWAWSubDocument.hxx:42
bool readDocHeader()
reads the document header
Definition: ClarisWksDocument.cxx:1083
std::shared_ptr< ClarisWksDocumentInternal::State > m_state
the state
Definition: ClarisWksDocument.hxx:239
int m_flags[4]
some unknown flag
Definition: ClarisWksStruct.hxx:212
int m_columns
the number of columns
Definition: ClarisWksDocument.cxx:118
ClarisWksDocument(MWAWParser &parser)
constructor
Definition: ClarisWksDocument.cxx:191
int m_beginSelection
the begin of selection ( at least in text header)
Definition: ClarisWksStruct.hxx:204
bool exploreZonesGraph()
try to find the zone dags structure...
Definition: ClarisWksDocument.cxx:2586
@ MWAW_T_CLARISWORKS
ClarisWorks/AppleWorks: all versions, export database (as spreadsheet), draw(as text),...
Definition: MWAWDocument.hxx:105
std::vector< int > const & getMainZonesList() const
returns the list of the main zones
Definition: ClarisWksDocument.cxx:410
bool readTNAM(MWAWEntry const &entry)
Definition: ClarisWksDocument.cxx:1993
void newPage(int page, bool softBreak=false)
send a page break
Definition: ClarisWksDocument.cxx:326
bool isSet() const
return true if the variable is set
Definition: libmwaw_internal.hxx:635
std::shared_ptr< MWAWParserState > m_parserState
the parser state
Definition: ClarisWksDocument.hxx:242
void typeMainZones()
try to type the main zones
Definition: ClarisWksDocument.cxx:2703
void setFormLength(const double formLength)
set the total page length
Definition: MWAWPageSpan.hxx:178
void setMasterPageName(librevenge::RVNGString const &name)
set the page master name
Definition: MWAWPageSpan.hxx:243
double getPageWidth() const
returns the page width (form width without margin )
Definition: MWAWParser.hxx:185
SubDocumentType
Definition: libmwaw_internal.hxx:188
@ MWAW_K_PRESENTATION
presentation graphic
Definition: MWAWDocument.hxx:85
the main class to create presentation Claris Works file
Definition: ClarisWksPRParser.hxx:68
std::map< int, ClarisWksStruct::DSET::Position > m_zonesTypeMap
the type of each zone
Definition: ClarisWksDocument.cxx:127
double getMarginRight() const
returns the right margin
Definition: MWAWPageSpan.hxx:137
int m_headerId
the header zone if known
Definition: ClarisWksDocument.cxx:112
void setType(std::string const &newType)
sets the type of the entry: BTEP,FDPP, BTEC, FDPC, PLC , TEXT, ...
Definition: MWAWEntry.hxx:132
void skipZone(long beginPos, long endPos)
skips the file zone defined by beginPos-endPos
Definition: MWAWDebug.hxx:113
bool readCPRT(MWAWEntry const &entry)
Definition: ClarisWksDocument.cxx:1566
T y() const
second element
Definition: libmwaw_internal.hxx:673
bool dumpFile(librevenge::RVNGBinaryData &data, char const *fileName)
a debug function to store in a datafile in the current directory WARNING: this function erase the fil...
Definition: MWAWDebug.cxx:193
ClarisWksDocument operator=(ClarisWksDocument const &orig)=delete
void setFormWidth(const double formWidth)
set the total page width
Definition: MWAWPageSpan.hxx:183
@ MWAW_K_TEXT
word processing file
Definition: MWAWDocument.hxx:82
the main class to read the text part of Claris Works file
Definition: ClarisWksPresentation.hxx:71
void setEnd(long off)
sets the end offset
Definition: MWAWEntry.hxx:77
std::shared_ptr< ClarisWksSpreadsheet > m_spreadsheetParser
the spreadsheet parser
Definition: ClarisWksDocument.hxx:257
SubDocument(ClarisWksDocument &doc, MWAWInputStreamPtr const &input, int zoneId)
Definition: ClarisWksDocument.cxx:143
double getFormLength() const
returns the form length
Definition: MWAWParser.hxx:170
@ P_Header
Definition: ClarisWksStruct.hxx:91
T x() const
first element
Definition: libmwaw_internal.hxx:668
NewPage m_newPage
the new page callback
Definition: ClarisWksDocument.hxx:273
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
std::shared_ptr< ClarisWksSpreadsheet > getSpreadsheetParser()
returns the spreadsheet parser
Definition: ClarisWksDocument.hxx:154
int m_fileType
the type ( 0: text, -1: graphic, ...)
Definition: ClarisWksStruct.hxx:189
void setBegin(long off)
sets the begin offset
Definition: MWAWEntry.hxx:67
std::vector< Column > m_columns
the different column
Definition: MWAWSection.hxx:108
void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType type) final
the parser function
Definition: ClarisWksDocument.cxx:172
void(MWAWParser::* NewPage)(int page, bool softBreak)
callback used to send a page break
Definition: ClarisWksDocument.hxx:268
MWAWVec2i getDocumentPages()
returns the number of expected pages ( accross pages x down page)
Definition: ClarisWksDocument.cxx:222
MWAWParser & getMainParser()
returns the main parser
Definition: ClarisWksDocument.hxx:129
long length() const
returns the length of the zone
Definition: MWAWEntry.hxx:93
std::vector< int > m_columnsSep
the columns separator in Points
Definition: ClarisWksDocument.cxx:122
SendFootnote m_sendFootnote
the send footnote callback
Definition: ClarisWksDocument.hxx:275
bool readHeader(MWAWInputStreamPtr input, bool strict=false)
try to read the header
Definition: ClarisWksStruct.cxx:72
the main class to read the text part of Claris Works file
Definition: ClarisWksText.hxx:76
Internal: the structures of a ClarisWksDocument.
Definition: ClarisWksDocument.cxx:68
bool readDSUM(MWAWEntry const &entry, bool inHeader)
Definition: ClarisWksDocument.cxx:2038
a class which stores section properties
Definition: MWAWSection.hxx:46
long begin() const
returns the begin offset
Definition: MWAWEntry.hxx:83
double getFormWidth() const
returns the form width
Definition: MWAWParser.hxx:175
void setLength(long l)
sets the zone size
Definition: MWAWEntry.hxx:72
MWAWPageSpan const & getPageSpan() const
returns the actual page dimension
Definition: MWAWParser.hxx:160
bool readStructCellZone(char const *zoneName, bool hasEntete, std::vector< MWAWVec2i > &res)
try to read a structured zone list of cells
Definition: ClarisWksDocument.cxx:2379
MWAWBox2< float > MWAWBox2f
MWAWBox2 of float.
Definition: libmwaw_internal.hxx:1193
main structure which correspond to a document part
Definition: ClarisWksStruct.hxx:87
int m_numPages
the number of pages (computed)
Definition: ClarisWksDocument.cxx:105
bool readMARKList(MWAWEntry const &entry)
Definition: ClarisWksDocument.cxx:1619
ClarisWksStruct::DSET::Position getZoneType(int id) const
returns a zone's type
Definition: ClarisWksDocument.cxx:95
std::shared_ptr< ClarisWksPresentation > getPresentationParser()
returns the presentation parser
Definition: ClarisWksDocument.hxx:149
std::shared_ptr< ClarisWksText > m_textParser
the text parser
Definition: ClarisWksDocument.hxx:261
void setMarginTop(const double marginTop)
set the page top margin
Definition: MWAWPageSpan.hxx:203
std::shared_ptr< ClarisWksStyleManager > getStyleManager()
returns the style manager
Definition: ClarisWksDocument.hxx:134
bool read(MWAWInputStreamPtr input)
reads the struture in a file
Definition: MWAWPrinter.cxx:235
MWAWSection getMainSection() const
returns the main document section
Definition: ClarisWksDocument.cxx:335
MWAWPageSpan getFinalPageSpan() const
returns the final page span to use for the document
Definition: ClarisWksDocument.cxx:297
bool sendDatabasePictZone(int pictId, MWAWListenerPtr listener=MWAWListenerPtr(), MWAWPosition pos=MWAWPosition())
try to send a database picture
Definition: ClarisWksDocument.cxx:504
the main class to read the graphic part of Claris Works file
Definition: ClarisWksGraph.hxx:78
std::map< int, std::shared_ptr< ClarisWksStruct::DSET > > m_zonesMap
the map of zone
Definition: ClarisWksDocument.cxx:125
void sendFootnote(int zoneId)
ask the main parser to create a document to send a footnote
Definition: ClarisWksDocument.cxx:367
int m_id
the subdocument id
Definition: ClarisWksDocument.cxx:169
bool checkHeader(MWAWHeader *header, bool strict=false)
checks if the document header is correct (or not)
Definition: ClarisWksDocument.cxx:642
long end() const
returns the end offset
Definition: MWAWEntry.hxx:88
a structure to store the style list and the lookup zone
Definition: ClarisWksStyleManager.hxx:61
double getMarginBottom() const
returns the bottom margin
Definition: MWAWPageSpan.hxx:147
librevenge::RVNGPropertyList const & getDocumentMetaData() const
returns the document meta data
Definition: ClarisWksDocument.cxx:263
bool readEndTable(long &eof)
reads the end table ( appears in v3.0 : file version ? )
Definition: ClarisWksDocument.cxx:1460
Internal: the subdocument of a ClarisWksDocument.
Definition: ClarisWksDocument.cxx:141
long m_size
the size of the DSET header
Definition: ClarisWksStruct.hxx:69
Position
the zone position
Definition: ClarisWksStruct.hxx:91
bool readDocumentMark(long endPos)
Definition: ClarisWksDocument.cxx:1837
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:100
the main class to read a Claris Works file
Definition: ClarisWksParser.hxx:68
bool readURL(long endPos)
Definition: ClarisWksDocument.cxx:1782
void updateChildPositions()
try to update the child page of each zone
Definition: ClarisWksDocument.cxx:2524
bool readEndMark(long endPos)
Definition: ClarisWksDocument.cxx:1951
@ P_Footer
Definition: ClarisWksStruct.hxx:91
long m_numData
the number of header
Definition: ClarisWksStruct.hxx:180
bool readSNAP(MWAWEntry const &entry)
Definition: ClarisWksDocument.cxx:2253
void(MWAWParser::* SendFootnote)(int zoneId)
callback used to send a footnote
Definition: ClarisWksDocument.hxx:270
std::shared_ptr< ClarisWksStruct::DSET > readDSET(bool &complete)
reads the zone DSET
Definition: ClarisWksDocument.cxx:854
bool exploreZonesGraphRec(int zId, std::set< int > ¬DoneList)
try to find the zone tree graph ( DSF) function
Definition: ClarisWksDocument.cxx:2653
long m_dataSz
the data size
Definition: ClarisWksStruct.hxx:182
@ Right
Definition: libmwaw_internal.hxx:176
double getTextHeight() const
returns the page height, ie. paper size less margin (in inches) less header/footer size
Definition: ClarisWksDocument.cxx:312
std::vector< int > m_rootZonesList
the list of root zones
Definition: ClarisWksDocument.cxx:129
~ClarisWksDocument()
virtual destructor
Definition: ClarisWksDocument.cxx:215
void cleanZonesGraph()
remove uneeded edge (mainly header/footer edges in main graph)
Definition: ClarisWksDocument.cxx:2808
void addPos(long pos)
adds a new position in the file
Definition: MWAWDebug.cxx:53
long m_dataSize
the data size
Definition: ClarisWksStruct.hxx:73
bool canSendZoneAsGraphic(int number) const
check if we can send a zone as a graphic
Definition: ClarisWksDocument.cxx:423
void setMarginRight(const double marginRight)
set the page right margin
Definition: MWAWPageSpan.hxx:198
bool createZones()
finds the different objects zones
Definition: ClarisWksDocument.cxx:519
bool valid() const
returns true if the zone length is positive
Definition: MWAWEntry.hxx:99
@ P_Main
Definition: ClarisWksStruct.hxx:91
void setHeaderFooter(MWAWHeaderFooter const &headerFooter)
add a header/footer on some page
Definition: MWAWPageSpan.cxx:227
@ Left
Definition: libmwaw_internal.hxx:176
int typeMainZonesRec(int zId, ClarisWksStruct::DSET::Position type, int maxHeight)
try to type the main zones recursif, returns the father id
Definition: ClarisWksDocument.cxx:2784
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:66
bool readStringList(char const *zoneName, bool hasEntete, std::vector< std::string > &res)
Definition: ClarisWksDocument.cxx:2095
@ P_Unknown
Definition: ClarisWksStruct.hxx:93
ClarisWksDocument & m_document
the document manager
Definition: ClarisWksDocument.cxx:167
bool readBookmark(long endPos)
Definition: ClarisWksDocument.cxx:1898
std::shared_ptr< ClarisWksGraph > getGraphParser()
returns the graph parser
Definition: ClarisWksDocument.hxx:144
the main class to read a AppleWorks/ClarisWorks spreadsheet file
Definition: ClarisWksSSParser.hxx:68
bool readZoneA()
try to read a unknown zone which appear to be filled at least in some v2 database file
Definition: ClarisWksDocument.cxx:2432
a basic structure
Definition: ClarisWksStruct.hxx:53
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
AnchorTo m_anchorTo
anchor position
Definition: MWAWPosition.hxx:270
bool m_pagesVerified
true if the number pages of pages has been verified
Definition: ClarisWksDocument.cxx:109
bool readDataLinkList()
try to read a structured zone list of picture definition: v5-v6
Definition: ClarisWksDocument.cxx:2146
bool readDocInfo()
reads the document info part ( end of the header)
Definition: ClarisWksDocument.cxx:1010
Class to store font.
Definition: MWAWFont.hxx:44
std::shared_ptr< ClarisWksDatabase > getDatabaseParser()
returns the database parser
Definition: ClarisWksDocument.hxx:139
std::set< MWAWVec2i > m_zonesSentSet
a stack of send zone (id,anchor) used to avoid unsolved potential loop
Definition: ClarisWksDocument.cxx:133
long m_headerSz
the header size
Definition: ClarisWksStruct.hxx:184
std::map< int, int > m_linkIdToDabasePictIdMap
a map pict id to database pict id
Definition: ClarisWksDocument.cxx:135
bool operator!=(MWAWSubDocument const &doc) const final
operator!=
Definition: ClarisWksDocument.cxx:152
void updatePageSpanList(std::vector< MWAWPageSpan > &spanList)
updates the page span list
Definition: ClarisWksDocument.cxx:268
std::vector< int > m_columnsWidth
the columns witdh in Points
Definition: ClarisWksDocument.cxx:120
MWAWVec2< int > MWAWVec2i
MWAWVec2 of int.
Definition: libmwaw_internal.hxx:838
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:61
void forceParsed(int zoneId)
indicates that a zone is parser
Definition: ClarisWksDocument.cxx:2580
@ P_Slide
Definition: ClarisWksStruct.hxx:93
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:99
std::shared_ptr< ClarisWksText > getTextParser()
returns the text parser
Definition: ClarisWksDocument.hxx:164
std::shared_ptr< ClarisWksStyleManager > m_styleManager
the style manager
Definition: ClarisWksDocument.hxx:248
int numPages() const
returns the document number of page
Definition: ClarisWksDocument.cxx:245
long m_numData
the number of header
Definition: ClarisWksStruct.hxx:71
MWAWParser * m_parser
the main parser
Definition: ClarisWksDocument.hxx:246
int m_headerHeight
the header height if known
Definition: ClarisWksDocument.cxx:114
Generated on Fri Sep 18 2020 18:14:52 for libmwaw by
doxygen 1.8.20