MsWks3Text.hxx Source File documentation

MsWks3Text.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2
3 /* libmwaw
4 * Version: MPL 2.0 / LGPLv2+
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 2.0 (the "License"); you may not use this file except in compliance with
8 * the License or as specified alternatively below. You may obtain a copy of
9 * the License at http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * Major Contributor(s):
17 * Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18 * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19 * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20 * Copyright (C) 2006, 2007 Andrew Ziem
21 * Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22 *
23 *
24 * All Rights Reserved.
25 *
26 * For minor contributions see the git repository.
27 *
28 * Alternatively, the contents of this file may be used under the terms of
29 * the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30 * in which case the provisions of the LGPLv2+ are applicable
31 * instead of those above.
32 */
33
34 /*
35 * Parser to Microsoft Works text document
36 *
37 */
38 #ifndef MS_WKS3_TEXT
39 # define MS_WKS3_TEXT
40
41 #include <list>
42 #include <string>
43 #include <vector>
44
45 #include "libmwaw_internal.hxx"
46
47 #include "MWAWEntry.hxx"
48
49 namespace MsWks3TextInternal
50 {
51 struct Font;
52 struct LineZone;
53 struct TextZone;
54 struct State;
55
56 class SubDocument;
57 }
58
59 class MsWksDocument;
60 class MsWksParser;
61 class MsWksDRParser;
62 class MsWksSSParser;
63
69 class MsWks3Text
70 {
71 friend class MsWksDocument;
72 friend class MsWksParser;
73 friend class MsWksDRParser;
74 friend class MsWksSSParser;
75
76 friend class MsWks3TextInternal::SubDocument;
77 public:
79 explicit MsWks3Text(MsWksDocument &zone);
81 virtual ~MsWks3Text();
82
84 int version() const;
85
87 int numPages(int zoneId) const;
88
89 protected:
91 int createZones(int numLines=-1, bool mainZone=false);
92
94 std::string readHeaderFooterString(bool header);
95
97 void flushExtra();
98
100 void sendZone(int zoneId);
101
103 void sendNote(int zoneId, int noteId);
104
106 int getHeader() const;
107
109 int getFooter() const;
110
112 bool getLinesPagesHeight(int zoneId,
113 std::vector<int> &lines,
114 std::vector<int> &pages);
115
116 //
117 // low level
118 //
119
121 bool readZoneHeader(MsWks3TextInternal::LineZone &zone) const;
122
124 void update(MsWks3TextInternal::TextZone &zone);
125
127 void updateNotes(MsWks3TextInternal::TextZone &zone, int firstNote);
128
131 void send(MsWks3TextInternal::TextZone &zone, MWAWVec2i limit=MWAWVec2i(-1,-1));
132
134 bool readFont(MsWks3TextInternal::Font &font, long endPos);
135
137 bool readParagraph(MsWks3TextInternal::LineZone &zone, MWAWParagraph &parag);
138
140 bool sendText(MsWks3TextInternal::LineZone &zone, int zoneId);
141
143 bool sendString(std::string &str);
144
145 private:
146 MsWks3Text(MsWks3Text const &orig) = delete;
147 MsWks3Text &operator=(MsWks3Text const &orig) = delete;
148
149 protected:
150 //
151 // data
152 //
154 MWAWParserStatePtr m_parserState;
155
157 std::shared_ptr<MsWks3TextInternal::State> m_state;
158
160 MWAWParser *m_mainParser;
162 MsWksDocument &m_document;
163 };
164 #endif
165 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MsWks3TextInternal::SubDocument
Internal: the subdocument of a MsWks3Text.
Definition: MsWks3Text.cxx:215
MsWks3TextInternal
Internal: the structures of a MsWks3Text.
Definition: MsWks3Text.cxx:55
MsWks3Text::readParagraph
bool readParagraph(MsWks3TextInternal::LineZone &zone, MWAWParagraph &parag)
tries to read a paragraph
Definition: MsWks3Text.cxx:700
MsWks3Text::updateNotes
void updateNotes(MsWks3TextInternal::TextZone &zone, int firstNote)
prepare the note zones given a zone and the position of the first note
Definition: MsWks3Text.cxx:417
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
MsWksParser
the main class to read a Microsoft Works file: v1-v4
Definition: MsWksParser.hxx:59
MsWks3Text::update
void update(MsWks3TextInternal::TextZone &zone)
prepare a zone
Definition: MsWks3Text.cxx:393
MWAWEntry.hxx
libmwaw_internal.hxx
MsWks3Text::~MsWks3Text
virtual ~MsWks3Text()
destructor
Definition: MsWks3Text.cxx:289
MsWks3Text::getFooter
int getFooter() const
returns a footer zone id ( or -1 )
Definition: MsWks3Text.cxx:343
MsWks3Text::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: MsWks3Text.cxx:959
MWAWVec2i
MWAWVec2< int > MWAWVec2i
MWAWVec2 of int.
Definition: libmwaw_internal.hxx:834
MsWks3Text::send
void send(MsWks3TextInternal::TextZone &zone, MWAWVec2i limit=MWAWVec2i(-1,-1))
sends the zone data to the listener.
Definition: MsWks3Text.cxx:881
MsWks3Text::m_mainParser
MWAWParser * m_mainParser
the main parser;
Definition: MsWks3Text.hxx:160
MsWks3Text::readHeaderFooterString
std::string readHeaderFooterString(bool header)
reads the header/footer string : version v1-2
Definition: MsWks3Text.cxx:829
MsWks3Text::readFont
bool readFont(MsWks3TextInternal::Font &font, long endPos)
tries to read a font
Definition: MsWks3Text.cxx:637
MsWks3TextInternal::TextZone
Internal: the text zone.
Definition: MsWks3Text.cxx:153
MsWks3Text::sendString
bool sendString(std::string &str)
tries to send a string (for v1-2, header/footer zone)
Definition: MsWks3Text.cxx:591
MsWks3Text::numPages
int numPages(int zoneId) const
returns the number of pages
Definition: MsWks3Text.cxx:300
MsWks3Text::MsWks3Text
MsWks3Text(MsWksDocument &zone)
constructor
Definition: MsWks3Text.cxx:280
MsWks3Text::m_document
MsWksDocument & m_document
the input zone
Definition: MsWks3Text.hxx:162
MsWks3Text
the main class to read the text part of Microsoft Works file
Definition: MsWks3Text.hxx:69
MsWks3Text::getLinesPagesHeight
bool getLinesPagesHeight(int zoneId, std::vector< int > &lines, std::vector< int > &pages)
return the lines and pages height ( for v1, ...)
Definition: MsWks3Text.cxx:319
MsWks3Text::version
int version() const
returns the file version
Definition: MsWks3Text.cxx:293
MsWksDRParser
the main class to read a Microsoft Works graphic file
Definition: MsWksDRParser.hxx:59
MsWks3TextInternal::LineZone
Internal: header zone.
Definition: MsWks3Text.cxx:59
MsWksSSParser
the main class to read a Microsoft Works spreadsheet file
Definition: MsWksSSParser.hxx:65
MWAWParagraph
class to store the paragraph properties
Definition: MWAWParagraph.hxx:84
MsWks3Text::readZoneHeader
bool readZoneHeader(MsWks3TextInternal::LineZone &zone) const
try to read a zone header
Definition: MsWks3Text.cxx:480
MsWks3Text::sendNote
void sendNote(int zoneId, int noteId)
send a note
Definition: MsWks3Text.cxx:931
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:99
MsWks3Text::operator=
MsWks3Text & operator=(MsWks3Text const &orig)=delete
MsWks3TextInternal::Font
Internal: the fonts.
Definition: MsWks3Text.cxx:122
MsWks3Text::createZones
int createZones(int numLines=-1, bool mainZone=false)
finds the different text zones. Returns the zoneId or -1.
Definition: MsWks3Text.cxx:354
MsWks3Text::getHeader
int getHeader() const
returns a header zone id ( or -1 )
Definition: MsWks3Text.cxx:335
MsWks3Text::m_state
std::shared_ptr< MsWks3TextInternal::State > m_state
the state
Definition: MsWks3Text.hxx:157
MsWks3Text::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: MsWks3Text.hxx:154
MsWks3Text::sendText
bool sendText(MsWks3TextInternal::LineZone &zone, int zoneId)
tries to send a text zone
Definition: MsWks3Text.cxx:500
MWAWVec2< int >
MsWks3Text::sendZone
void sendZone(int zoneId)
send a zone
Definition: MsWks3Text.cxx:949
MsWksDocument
the main class to read/store generic data of a MsWorks document v1-v3
Definition: MsWksDocument.hxx:68