FullWrtText.hxx Source File documentation

FullWrtText.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 FullWrite text document
36 *
37 */
38 #ifndef FULL_WRT_TEXT
39 # define FULL_WRT_TEXT
40
41 #include "libmwaw_internal.hxx"
42
43
44 #include "MWAWDebug.hxx"
45
46 #include "FullWrtStruct.hxx"
47
48 namespace FullWrtTextInternal
49 {
50 struct Font;
51 struct Paragraph;
52
53 struct LineHeader;
54 struct Zone;
55
56 struct State;
57 }
58
59 class FullWrtParser;
60
66 class FullWrtText
67 {
68 friend class FullWrtParser;
69 public:
71 explicit FullWrtText(FullWrtParser &parser);
73 virtual ~FullWrtText();
74
76 int version() const;
77
79 int numPages() const;
80
81 protected:
82
84 void flushExtra();
85
87 bool sendMainText();
89 int getHeaderFooterId(bool header, int page, int &numSimillar) const;
90
92 bool send(int zId, MWAWColor fontColor=MWAWColor::black());
93
94 //
95 // intermediate level
96 //
97
99 bool readTextData(FullWrtStruct::EntryPtr zone);
100
102 bool send(std::shared_ptr<FullWrtTextInternal::Zone> zone, MWAWColor fontColor=MWAWColor::black());
103
105 void send(std::shared_ptr<FullWrtTextInternal::Zone> zone, int numChar,
106 FullWrtTextInternal::Font &font, FullWrtTextInternal::Paragraph &ruler,
107 std::string &str);
108
110 bool sendTable(std::shared_ptr<FullWrtTextInternal::Zone> zone,
111 FullWrtTextInternal::LineHeader const &lHeader,
112 FullWrtTextInternal::Font &font, FullWrtTextInternal::Paragraph &ruler,
113 std::string &str);
115 bool sendHiddenItem(int id, FullWrtTextInternal::Font &font, FullWrtTextInternal::Paragraph &ruler);
116
118 void prepareData()
119 {
120 sortZones();
121 createItemStructures();
122 }
123
125 void sortZones();
127 void createItemStructures();
128
129 //
130 // low level
131 //
132
134 bool readLineHeader(std::shared_ptr<FullWrtTextInternal::Zone> zone, FullWrtTextInternal::LineHeader &lHeader);
135
137 bool readItem(FullWrtStruct::EntryPtr zone, int id=-1, bool hidden=false);
138
140 bool readParagraphTabs(FullWrtStruct::EntryPtr zone, int id=-1);
142 bool readParaModDocInfo(FullWrtStruct::EntryPtr zone);
143
145 bool readStyle(FullWrtStruct::EntryPtr zone);
146
148 bool readDataMod(FullWrtStruct::EntryPtr zone, int id);
149
151 bool readColumns(FullWrtStruct::EntryPtr zone);
152
153 private:
154 FullWrtText(FullWrtText const &orig) = delete;
155 FullWrtText &operator=(FullWrtText const &orig) = delete;
156
157 protected:
158 //
159 // data
160 //
162 MWAWParserStatePtr m_parserState;
163
165 std::shared_ptr<FullWrtTextInternal::State> m_state;
166
168 FullWrtParser *m_mainParser;
169 };
170 #endif
171 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
FullWrtText::readDataMod
bool readDataMod(FullWrtStruct::EntryPtr zone, int id)
try to read the font/paragraph modifier zone (Zone1f)
Definition: FullWrtText.cxx:2289
FullWrtText::~FullWrtText
virtual ~FullWrtText()
destructor
Definition: FullWrtText.cxx:714
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
FullWrtParser
the main class to read a FullWrite file
Definition: FullWrtParser.hxx:66
libmwaw_internal.hxx
FullWrtText::sendMainText
bool sendMainText()
send a main zone
Definition: FullWrtText.cxx:2440
FullWrtText::readTextData
bool readTextData(FullWrtStruct::EntryPtr zone)
check if a zone is a text zone, if so read it...
Definition: FullWrtText.cxx:1644
MWAWColor::black
static MWAWColor black()
return the back color
Definition: libmwaw_internal.hxx:245
FullWrtText::sendTable
bool sendTable(std::shared_ptr< FullWrtTextInternal::Zone > zone, FullWrtTextInternal::LineHeader const &lHeader, FullWrtTextInternal::Font &font, FullWrtTextInternal::Paragraph &ruler, std::string &str)
try send a table row
Definition: FullWrtText.cxx:1213
FullWrtText::readParaModDocInfo
bool readParaModDocInfo(FullWrtStruct::EntryPtr zone)
try to read the paragraph modifier (at the end of doc info)
Definition: FullWrtText.cxx:2324
FullWrtText::readColumns
bool readColumns(FullWrtStruct::EntryPtr zone)
check if the input of the zone points to the columns definition, ...
Definition: FullWrtText.cxx:2393
FullWrtText::m_mainParser
FullWrtParser * m_mainParser
the main parser;
Definition: FullWrtText.hxx:168
FullWrtText::readLineHeader
bool readLineHeader(std::shared_ptr< FullWrtTextInternal::Zone > zone, FullWrtTextInternal::LineHeader &lHeader)
try to read the header of a line
Definition: FullWrtText.cxx:1316
FullWrtText::prepareData
void prepareData()
prepare the different data (called sortZones and createItemStructures)
Definition: FullWrtText.hxx:118
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192
FullWrtText::createItemStructures
void createItemStructures()
create the item structures
Definition: FullWrtText.cxx:2550
FullWrtText::m_state
std::shared_ptr< FullWrtTextInternal::State > m_state
the state
Definition: FullWrtText.hxx:165
FullWrtText::operator=
FullWrtText & operator=(FullWrtText const &orig)=delete
FullWrtText::sendHiddenItem
bool sendHiddenItem(int id, FullWrtTextInternal::Font &font, FullWrtTextInternal::Paragraph &ruler)
send a hidden item
Definition: FullWrtText.cxx:1557
FullWrtText::readItem
bool readItem(FullWrtStruct::EntryPtr zone, int id=-1, bool hidden=false)
check if the input of the zone points to a item zone in DataStruct Zone
Definition: FullWrtText.cxx:1937
FullWrtText::getHeaderFooterId
int getHeaderFooterId(bool header, int page, int &numSimillar) const
return the header/footer blockid ( or -1)
Definition: FullWrtText.cxx:2459
FullWrtText::FullWrtText
FullWrtText(FullWrtParser &parser)
constructor
Definition: FullWrtText.cxx:707
FullWrtText::readStyle
bool readStyle(FullWrtStruct::EntryPtr zone)
try to read a style
Definition: FullWrtText.cxx:2064
FullWrtTextInternal::Font
Internal: class to store a font and it state.
Definition: FullWrtText.cxx:210
MWAWDebug.hxx
FullWrtText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: FullWrtText.cxx:2498
FullWrtText
the main class to read the text part of writenow file
Definition: FullWrtText.hxx:66
FullWrtTextInternal::LineHeader
Internal: class to store the LineHeader.
Definition: FullWrtText.cxx:267
FullWrtStruct::EntryPtr
std::shared_ptr< Entry > EntryPtr
Definition: FullWrtStruct.hxx:153
FullWrtText::version
int version() const
returns the file version
Definition: FullWrtText.cxx:718
FullWrtText::sortZones
void sortZones()
sort the different zones, finding the main zone, ...
Definition: FullWrtText.cxx:2508
FullWrtTextInternal::Paragraph
Internal: class to store the paragraph properties.
Definition: FullWrtText.cxx:476
FullWrtText::send
bool send(int zId, MWAWColor fontColor=MWAWColor::black())
send a id zone
Definition: FullWrtText.cxx:2487
FullWrtText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: FullWrtText.hxx:162
FullWrtText::numPages
int numPages() const
returns the number of pages
Definition: FullWrtText.cxx:725
FullWrtTextInternal
Internal: the structures of a FullWrtText.
Definition: FullWrtText.cxx:59
FullWrtStruct.hxx
FullWrtText::readParagraphTabs
bool readParagraphTabs(FullWrtStruct::EntryPtr zone, int id=-1)
check if the input of the zone points to a paragraph zone in DataStruct Zone
Definition: FullWrtText.cxx:2116