ZWrtText.hxx Source File documentation

ZWrtText.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 ZWrite document
36 *
37 */
38 #ifndef Z_WRT_TEXT
39 # define Z_WRT_TEXT
40
41 #include "libmwaw_internal.hxx"
42 #include "MWAWDebug.hxx"
43
44 namespace ZWrtTextInternal
45 {
46 struct Section;
47 struct State;
48 class SubDocument;
49 }
50
51 class ZWrtParser;
52
58 class ZWrtText
59 {
60 friend class ZWrtParser;
61 friend class ZWrtTextInternal::SubDocument;
62 public:
64 explicit ZWrtText(ZWrtParser &parser);
66 virtual ~ZWrtText();
67
69 int version() const;
70
72 int numPages() const;
73
74 protected:
76 enum TextCode { None, Center, BookMark, NewPage, Tag, Link };
77
79 bool createZones();
80
82 bool sendMainText();
83
85 void flushExtra();
86
87 //
88 // intermediate level
89 //
90
92 void computePositions();
93
95 bool sendText(ZWrtTextInternal::Section const &zone, MWAWEntry const &entry);
97 bool sendText(int sectionId, MWAWEntry const &entry);
99 TextCode isTextCode(MWAWInputStreamPtr &input, long endPos, MWAWEntry &dPos) const;
100
102 bool readHFZone(MWAWEntry const &entry);
104 bool hasHeaderFooter(bool header) const;
106 bool sendHeaderFooter(bool header);
107
109 bool readStyles(MWAWEntry const &entry);
110
112 bool readSectionFonts(MWAWEntry const &entry);
113
114 private:
115 ZWrtText(ZWrtText const &orig) = delete;
116 ZWrtText &operator=(ZWrtText const &orig) = delete;
117
118 protected:
119 //
120 // data
121 //
123 MWAWParserStatePtr m_parserState;
124
126 std::shared_ptr<ZWrtTextInternal::State> m_state;
127
129 ZWrtParser *m_mainParser;
130 };
131 #endif
132 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
ZWrtText::createZones
bool createZones()
finds the different text zones
Definition: ZWrtText.cxx:324
ZWrtText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: ZWrtText.cxx:943
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
ZWrtText::m_state
std::shared_ptr< ZWrtTextInternal::State > m_state
the state
Definition: ZWrtText.hxx:126
libmwaw_internal.hxx
ZWrtText::TextCode
TextCode
the list of code in the text
Definition: ZWrtText.hxx:76
ZWrtText::Link
Definition: ZWrtText.hxx:76
ZWrtText::m_mainParser
ZWrtParser * m_mainParser
the main parser;
Definition: ZWrtText.hxx:129
ZWrtText::readHFZone
bool readHFZone(MWAWEntry const &entry)
read the header/footer zone
Definition: ZWrtText.cxx:815
ZWrtText::ZWrtText
ZWrtText(ZWrtParser &parser)
constructor
Definition: ZWrtText.cxx:259
ZWrtText::numPages
int numPages() const
returns the number of pages
Definition: ZWrtText.cxx:277
ZWrtTextInternal::Section
Internal: struct used to store a section of a ZWrtText.
Definition: ZWrtText.cxx:127
ZWrtText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: ZWrtText.hxx:123
ZWrtText::hasHeaderFooter
bool hasHeaderFooter(bool header) const
returns true if there is a header/footer
Definition: ZWrtText.cxx:285
ZWrtText::Center
Definition: ZWrtText.hxx:76
ZWrtText::sendMainText
bool sendMainText()
send a main zone
Definition: ZWrtText.cxx:567
ZWrtText::operator=
ZWrtText & operator=(ZWrtText const &orig)=delete
ZWrtText::isTextCode
TextCode isTextCode(MWAWInputStreamPtr &input, long endPos, MWAWEntry &dPos) const
check if a character after &#39;<&#39; corresponds to a text code
Definition: ZWrtText.cxx:383
ZWrtText::sendText
bool sendText(ZWrtTextInternal::Section const &zone, MWAWEntry const &entry)
try to send a section
Definition: ZWrtText.cxx:443
ZWrtText::NewPage
Definition: ZWrtText.hxx:76
ZWrtText::Tag
Definition: ZWrtText.hxx:76
ZWrtText::~ZWrtText
virtual ~ZWrtText()
destructor
Definition: ZWrtText.cxx:266
ZWrtText::readSectionFonts
bool readSectionFonts(MWAWEntry const &entry)
read a section fonts
Definition: ZWrtText.cxx:583
ZWrtText::readStyles
bool readStyles(MWAWEntry const &entry)
read the styles
Definition: ZWrtText.cxx:653
MWAWDebug.hxx
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:547
ZWrtText::version
int version() const
returns the file version
Definition: ZWrtText.cxx:270
ZWrtParser
the main class to read a ZWrite file
Definition: ZWrtParser.hxx:82
ZWrtText::BookMark
Definition: ZWrtText.hxx:76
ZWrtTextInternal::SubDocument
Internal: the subdocument of a ZWrtText.
Definition: ZWrtText.cxx:188
ZWrtText::sendHeaderFooter
bool sendHeaderFooter(bool header)
try to send the header/footer
Definition: ZWrtText.cxx:750
ZWrtTextInternal
Internal: the structures of a ZWrtText.
Definition: ZWrtText.cxx:58
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
ZWrtText::None
Definition: ZWrtText.hxx:76
ZWrtText::computePositions
void computePositions()
compute the positions
Definition: ZWrtText.cxx:291
ZWrtText
the main class to read the text part of ZWrite Text file
Definition: ZWrtText.hxx:58