LightWayTxtText.hxx Source File documentation

LightWayTxtText.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 LightWay Text document
36 *
37 */
38#ifndef LIGHT_WAY_TXT_TEXT
39# define LIGHT_WAY_TXT_TEXT
40
41#include "libmwaw_internal.hxx"
42#include "MWAWDebug.hxx"
43
44namespace LightWayTxtTextInternal
45{
46struct Font;
47struct State;
48}
49
50class LightWayTxtParser;
51
57 class LightWayTxtText
58{
59 friend class LightWayTxtParser;
60public:
62 explicit LightWayTxtText(LightWayTxtParser &parser);
64 virtual ~LightWayTxtText();
65
67 int version() const;
68
70 int numPages() const;
71
72protected:
74 bool createZones();
75
77 bool sendMainText();
78
80 bool getColor(int id, MWAWColor &col) const;
81
83 void flushExtra();
84
85 //
86 // intermediate level
87 //
88
90 void computePositions();
91
93 bool readFonts(MWAWEntry const &entry);
95 bool readFont2(MWAWEntry const &entry);
96
98 bool readRulers(MWAWEntry const &entry);
100 void setProperty(MWAWParagraph const &para);
101
103 bool readRuby(MWAWEntry const &entry);
104
106 bool readDocumentHF(MWAWEntry const &entry);
108 bool hasHeaderFooter(bool header) const;
110 bool sendHeaderFooter(bool header);
111
113 bool readStyleU(MWAWEntry const &entry);
114
116 bool readUnknownStyle(MWAWEntry const &entry);
117
118private:
119 LightWayTxtText(LightWayTxtText const &orig) = delete;
120 LightWayTxtText &operator=(LightWayTxtText const &orig) = delete;
121
122protected:
123 //
124 // data
125 //
127 MWAWParserStatePtr m_parserState;
128
130 std::shared_ptr<LightWayTxtTextInternal::State> m_state;
131
133 LightWayTxtParser *m_mainParser;
134};
135#endif
136// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
LightWayTxtParser
the main class to read a LightWay Text file
Definition: LightWayTxtParser.hxx:59
LightWayTxtText
the main class to read the text part of LightWay Text file
Definition: LightWayTxtText.hxx:58
LightWayTxtText::readDocumentHF
bool readDocumentHF(MWAWEntry const &entry)
read the header/footer part of the document zone
Definition: LightWayTxtText.cxx:1016
LightWayTxtText::computePositions
void computePositions()
compute the positions
Definition: LightWayTxtText.cxx:316
LightWayTxtText::readFont2
bool readFont2(MWAWEntry const &entry)
read the Font2 resource ( underline, upperline, ...)
Definition: LightWayTxtText.cxx:621
LightWayTxtText::readStyleU
bool readStyleU(MWAWEntry const &entry)
read the unknown styu resource
Definition: LightWayTxtText.cxx:1119
LightWayTxtText::sendMainText
bool sendMainText()
send a main zone
Definition: LightWayTxtText.cxx:410
LightWayTxtText::operator=
LightWayTxtText & operator=(LightWayTxtText const &orig)=delete
LightWayTxtText::readRuby
bool readRuby(MWAWEntry const &entry)
read the ruby data
Definition: LightWayTxtText.cxx:1171
LightWayTxtText::version
int version() const
returns the file version
Definition: LightWayTxtText.cxx:300
LightWayTxtText::readRulers
bool readRulers(MWAWEntry const &entry)
read the rulers (stylx resource)
Definition: LightWayTxtText.cxx:813
LightWayTxtText::sendHeaderFooter
bool sendHeaderFooter(bool header)
try to send the header/footer
Definition: LightWayTxtText.cxx:955
LightWayTxtText::numPages
int numPages() const
returns the number of pages
Definition: LightWayTxtText.cxx:307
LightWayTxtText::hasHeaderFooter
bool hasHeaderFooter(bool header) const
returns true if there is a header/footer
Definition: LightWayTxtText.cxx:323
LightWayTxtText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: LightWayTxtText.hxx:127
LightWayTxtText::LightWayTxtText
LightWayTxtText(LightWayTxtText const &orig)=delete
LightWayTxtText::m_mainParser
LightWayTxtParser * m_mainParser
the main parser;
Definition: LightWayTxtText.hxx:133
LightWayTxtText::readUnknownStyle
bool readUnknownStyle(MWAWEntry const &entry)
read the styl resource
Definition: LightWayTxtText.cxx:1220
LightWayTxtText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: LightWayTxtText.cxx:1270
LightWayTxtText::createZones
bool createZones()
finds the different text zones
Definition: LightWayTxtText.cxx:349
LightWayTxtText::readFonts
bool readFonts(MWAWEntry const &entry)
read the fonts ( styl resource)
Definition: LightWayTxtText.cxx:548
LightWayTxtText::m_state
std::shared_ptr< LightWayTxtTextInternal::State > m_state
the state
Definition: LightWayTxtText.hxx:130
LightWayTxtText::setProperty
void setProperty(MWAWParagraph const &para)
send the paragraph properties
Definition: LightWayTxtText.cxx:807
LightWayTxtText::getColor
bool getColor(int id, MWAWColor &col) const
return a color corresponding to an id
Definition: LightWayTxtText.cxx:330
LightWayTxtText::~LightWayTxtText
virtual ~LightWayTxtText()
destructor
Definition: LightWayTxtText.cxx:296
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
MWAWParagraph
class to store the paragraph properties
Definition: MWAWParagraph.hxx:85
libmwaw_internal.hxx
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
LightWayTxtTextInternal
Internal: the structures of a LightWayTxtText.
Definition: LightWayTxtText.cxx:60
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192