HanMacWrdKText.hxx Source File documentation

HanMacWrdKText.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 HanMac Word text document
36 *
37 */
38 #ifndef HAN_MAC_WRD_K_TEXT
39 # define HAN_MAC_WRD_K_TEXT
40
41 #include <map>
42
43 #include "libmwaw_internal.hxx"
44 #include "MWAWDebug.hxx"
45
46 namespace HanMacWrdKTextInternal
47 {
48 struct Paragraph;
49 struct Token;
50 struct State;
51 }
52
53 struct HanMacWrdKZone;
54 class HanMacWrdKParser;
55
61 class HanMacWrdKText
62 {
63 friend class HanMacWrdKParser;
64 public:
66 explicit HanMacWrdKText(HanMacWrdKParser &parser);
68 virtual ~HanMacWrdKText();
69
71 int version() const;
72
74 int numPages() const;
75
76 protected:
78 bool sendMainText();
80 bool sendText(long id, long subId, MWAWListenerPtr listener=MWAWListenerPtr());
82 bool canSendTextAsGraphic(long id, long subId);
84 void flushExtra();
86 void updateTextZoneTypes(std::map<long,int> const &idTypeMap);
88 int computeNumPages(HanMacWrdKZone const &zone) const;
90 std::vector<long> const &getTokenIdList() const;
92 void getHeaderFooterId(long &headerId, long &footerId) const;
93
94 //
95 // intermediate level
96 //
97
99 bool readTextZone(std::shared_ptr<HanMacWrdKZone> zone);
101 bool readFontNames(std::shared_ptr<HanMacWrdKZone> zone);
103 bool readStyles(std::shared_ptr<HanMacWrdKZone> zone);
105 bool readSections(std::shared_ptr<HanMacWrdKZone> zone);
106
108 bool sendText(HanMacWrdKZone &zone, MWAWListenerPtr listener=MWAWListenerPtr());
110 bool canSendTextAsGraphic(HanMacWrdKZone &zone);
111
112 //
113 // low level
114 //
116 bool readFont(HanMacWrdKZone const &zone, MWAWFont &font) const;
117
119 bool readParagraph(HanMacWrdKZone const &zone, HanMacWrdKTextInternal::Paragraph &para) const;
121 void setProperty(HanMacWrdKTextInternal::Paragraph const &para, float width);
122
124 bool readToken(HanMacWrdKZone const &zone, HanMacWrdKTextInternal::Token &token) const;
125
126 private:
127 HanMacWrdKText(HanMacWrdKText const &orig) = delete;
128 HanMacWrdKText &operator=(HanMacWrdKText const &orig) = delete;
129
130 protected:
131 //
132 // data
133 //
135 MWAWParserStatePtr m_parserState;
136
138 std::shared_ptr<HanMacWrdKTextInternal::State> m_state;
139
141 HanMacWrdKParser *m_mainParser;
142 };
143 #endif
144 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
HanMacWrdKText::operator=
HanMacWrdKText & operator=(HanMacWrdKText const &orig)=delete
HanMacWrdKText::~HanMacWrdKText
virtual ~HanMacWrdKText()
destructor
Definition: HanMacWrdKText.cxx:289
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
libmwaw_internal.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:549
HanMacWrdKText::canSendTextAsGraphic
bool canSendTextAsGraphic(long id, long subId)
check if we can send a textzone as graphic
Definition: HanMacWrdKText.cxx:515
HanMacWrdKText::getHeaderFooterId
void getHeaderFooterId(long &headerId, long &footerId) const
return sthe header/footer id
Definition: HanMacWrdKText.cxx:312
HanMacWrdKText::HanMacWrdKText
HanMacWrdKText(HanMacWrdKParser &parser)
constructor
Definition: HanMacWrdKText.cxx:282
HanMacWrdKText::m_state
std::shared_ptr< HanMacWrdKTextInternal::State > m_state
the state
Definition: HanMacWrdKText.hxx:138
HanMacWrdKText::numPages
int numPages() const
returns the number of pages
Definition: HanMacWrdKText.cxx:300
HanMacWrdKText::readFontNames
bool readFontNames(std::shared_ptr< HanMacWrdKZone > zone)
try to read the fonts name zone (type 5)
Definition: HanMacWrdKText.cxx:1017
HanMacWrdKText::sendText
bool sendText(long id, long subId, MWAWListenerPtr listener=MWAWListenerPtr())
send a text zone
Definition: HanMacWrdKText.cxx:528
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
HanMacWrdKText::m_mainParser
HanMacWrdKParser * m_mainParser
the main parser;
Definition: HanMacWrdKText.hxx:141
HanMacWrdKTextInternal::Token
Internal: class to store the token properties of a HanMacWrdKText.
Definition: HanMacWrdKText.cxx:173
HanMacWrdKText::version
int version() const
returns the file version
Definition: HanMacWrdKText.cxx:293
HanMacWrdKText::readParagraph
bool readParagraph(HanMacWrdKZone const &zone, HanMacWrdKTextInternal::Paragraph &para) const
try to read a paragraph in a text zone
Definition: HanMacWrdKText.cxx:1211
HanMacWrdKParser
the main class to read a HanMac Word-K file
Definition: HanMacWrdKParser.hxx:185
HanMacWrdKText::computeNumPages
int computeNumPages(HanMacWrdKZone const &zone) const
compute the number of pages present in a zone
Definition: HanMacWrdKText.cxx:349
MWAWDebug.hxx
HanMacWrdKText
the main class to read the text part of HanMac Word file
Definition: HanMacWrdKText.hxx:61
HanMacWrdKText::setProperty
void setProperty(HanMacWrdKTextInternal::Paragraph const &para, float width)
send the ruler properties
Definition: HanMacWrdKText.cxx:1205
HanMacWrdKText::sendMainText
bool sendMainText()
send the main text zone
Definition: HanMacWrdKText.cxx:545
HanMacWrdKText::readTextZone
bool readTextZone(std::shared_ptr< HanMacWrdKZone > zone)
try to read a text zone (type 1)
Definition: HanMacWrdKText.cxx:448
HanMacWrdKZone
Small class used to store the decoded zone of HanMacWrdKParser.
Definition: HanMacWrdKParser.hxx:58
HanMacWrdKText::readFont
bool readFont(HanMacWrdKZone const &zone, MWAWFont &font) const
try to read a font in a text zone
Definition: HanMacWrdKText.cxx:892
HanMacWrdKText::getTokenIdList
std::vector< long > const & getTokenIdList() const
returns the list of zoneId which corresponds to the token
Definition: HanMacWrdKText.cxx:318
HanMacWrdKTextInternal
Internal: the structures of a HanMacWrdKText.
Definition: HanMacWrdKText.cxx:57
HanMacWrdKText::updateTextZoneTypes
void updateTextZoneTypes(std::map< long, int > const &idTypeMap)
update the text zone type with map id->type
Definition: HanMacWrdKText.cxx:323
HanMacWrdKText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: HanMacWrdKText.cxx:1580
HanMacWrdKText::readSections
bool readSections(std::shared_ptr< HanMacWrdKZone > zone)
try to read a section info zone (type 4)
Definition: HanMacWrdKText.cxx:1477
HanMacWrdKText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: HanMacWrdKText.hxx:135
HanMacWrdKText::readToken
bool readToken(HanMacWrdKZone const &zone, HanMacWrdKTextInternal::Token &token) const
try to read an token in a text zone
Definition: HanMacWrdKText.cxx:1432
HanMacWrdKTextInternal::Paragraph
Internal: class to store the paragraph properties of a HanMacWrdKText.
Definition: HanMacWrdKText.cxx:60
HanMacWrdKText::readStyles
bool readStyles(std::shared_ptr< HanMacWrdKZone > zone)
try to read the style zone (type 3)
Definition: HanMacWrdKText.cxx:1078