GreatWksText.hxx Source File documentation

GreatWksText.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 GreatWorks document
36 *
37 */
38 #ifndef GREAT_WKS_TEXT
39 # define GREAT_WKS_TEXT
40
41 #include "libmwaw_internal.hxx"
42 #include "MWAWDebug.hxx"
43
44 namespace GreatWksTextInternal
45 {
46 struct State;
47 struct Token;
48 struct Zone;
49 }
50
51 class GreatWksDocument;
52 class GreatWksParser;
53 class GreatWksDBParser;
54 class GreatWksDRParser;
55 class GreatWksSSParser;
56
62 class GreatWksText
63 {
64 friend class GreatWksDocument;
65 friend class GreatWksParser;
66 friend class GreatWksDBParser;
67 friend class GreatWksDRParser;
68 friend class GreatWksSSParser;
69 public:
71 explicit GreatWksText(GreatWksDocument &document);
73 virtual ~GreatWksText();
74
76 int version() const;
77
79 int numPages() const;
80
81 protected:
83 bool createZones(int expectedHF);
85 bool sendMainText();
87 int numHFZones() const;
89 bool sendHF(int id);
91 bool canSendTextBoxAsGraphic(MWAWEntry const &entry);
93 bool sendTextbox(MWAWEntry const &entry, MWAWListenerPtr listener=MWAWListenerPtr());
95 void flushExtra();
97 int getFontId(int fileId) const;
98
99 //
100 // intermediate level
101 //
102
104 bool readFontNames();
106 bool readZone(GreatWksTextInternal::Zone &zone);
108 bool readZonePositions(GreatWksTextInternal::Zone &zone);
110 bool sendZone(GreatWksTextInternal::Zone const &zone, MWAWListenerPtr listener=MWAWListenerPtr());
112 bool sendSimpleTextbox(MWAWEntry const &entry, MWAWListenerPtr listener=MWAWListenerPtr());
114 bool readFont(MWAWFont &font);
116 bool readRuler(MWAWParagraph &para);
118 bool readToken(GreatWksTextInternal::Token &token, long &nChar);
119
121 bool findNextZone();
122
123 private:
124 GreatWksText(GreatWksText const &orig) = delete;
125 GreatWksText &operator=(GreatWksText const &orig) = delete;
126
127 protected:
128 //
129 // data
130 //
131
133 GreatWksDocument &m_document;
135 MWAWParserStatePtr m_parserState;
137 std::shared_ptr<GreatWksTextInternal::State> m_state;
139 MWAWParser *m_mainParser;
140 };
141 #endif
142 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
GreatWksText::numPages
int numPages() const
returns the number of pages
Definition: GreatWksText.cxx:475
GreatWksText::sendMainText
bool sendMainText()
send a main zone
Definition: GreatWksText.cxx:1164
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
GreatWksText::sendTextbox
bool sendTextbox(MWAWEntry const &entry, MWAWListenerPtr listener=MWAWListenerPtr())
try to send the textbox text
Definition: GreatWksText.cxx:521
GreatWksDBParser
the main class to read a GreatWorks database file
Definition: GreatWksDBParser.hxx:61
libmwaw_internal.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:549
GreatWksText::sendSimpleTextbox
bool sendSimpleTextbox(MWAWEntry const &entry, MWAWListenerPtr listener=MWAWListenerPtr())
try to send simplified textbox zone
Definition: GreatWksText.cxx:1200
GreatWksDocument
the main class to read/store generic data of a GreatWorks document
Definition: GreatWksDocument.hxx:60
GreatWksText::readToken
bool readToken(GreatWksTextInternal::Token &token, long &nChar)
try to read a token
Definition: GreatWksText.cxx:1129
GreatWksText::readZonePositions
bool readZonePositions(GreatWksTextInternal::Zone &zone)
try to read the end of a zone ( line + frame position )
Definition: GreatWksText.cxx:817
GreatWksText::numHFZones
int numHFZones() const
return the number of header/footer zones
Definition: GreatWksText.cxx:497
GreatWksText::sendHF
bool sendHF(int id)
try to send the i^th header/footer
Definition: GreatWksText.cxx:1174
GreatWksTextInternal::Token
Internal and low level: structure which stores a token for GreatWksText.
Definition: GreatWksText.cxx:112
GreatWksText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: GreatWksText.hxx:135
GreatWksText::canSendTextBoxAsGraphic
bool canSendTextBoxAsGraphic(MWAWEntry const &entry)
check if a textbox can be send in a graphic zone, ie. does not contains any graphic ...
Definition: GreatWksText.cxx:508
GreatWksText::GreatWksText
GreatWksText(GreatWksDocument &document)
constructor
Definition: GreatWksText.cxx:457
GreatWksText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: GreatWksText.cxx:1186
GreatWksText::readRuler
bool readRuler(MWAWParagraph &para)
try to read a ruler
Definition: GreatWksText.cxx:1010
GreatWksText::version
int version() const
returns the file version
Definition: GreatWksText.cxx:468
GreatWksText::m_document
GreatWksDocument & m_document
the document
Definition: GreatWksText.hxx:133
GreatWksTextInternal::Zone
Internal and low level: structure which stores a text zone header for GreatWksText.
Definition: GreatWksText.cxx:307
GreatWksText::readFontNames
bool readFontNames()
try to read the font names zone
Definition: GreatWksText.cxx:888
GreatWksText::readZone
bool readZone(GreatWksTextInternal::Zone &zone)
try to read a zone ( textheader+fonts+rulers)
Definition: GreatWksText.cxx:666
GreatWksText::m_state
std::shared_ptr< GreatWksTextInternal::State > m_state
the state
Definition: GreatWksText.hxx:137
GreatWksText::sendZone
bool sendZone(GreatWksTextInternal::Zone const &zone, MWAWListenerPtr listener=MWAWListenerPtr())
try to send a zone
Definition: GreatWksText.cxx:1352
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
GreatWksText::getFontId
int getFontId(int fileId) const
read the final font id corresponding to a file id
Definition: GreatWksText.cxx:492
GreatWksText
the main class to read the text part of GreatWorks Text file
Definition: GreatWksText.hxx:62
GreatWksText::readFont
bool readFont(MWAWFont &font)
try to read a font
Definition: GreatWksText.cxx:955
GreatWksDRParser
the main class to read a GreatWorks graphic file
Definition: GreatWksDRParser.hxx:55
GreatWksText::m_mainParser
MWAWParser * m_mainParser
the main parser;
Definition: GreatWksText.hxx:139
GreatWksParser
the main class to read a GreatWorks text file
Definition: GreatWksParser.hxx:56
MWAWDebug.hxx
MWAWParagraph
class to store the paragraph properties
Definition: MWAWParagraph.hxx:84
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:99
GreatWksSSParser
the main class to read a GreatWorks spreadsheet file
Definition: GreatWksSSParser.hxx:58
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
GreatWksText::findNextZone
bool findNextZone()
heuristic function used to find the next zone
Definition: GreatWksText.cxx:597
GreatWksText::createZones
bool createZones(int expectedHF)
finds the different objects zones
Definition: GreatWksText.cxx:543
GreatWksTextInternal
Internal: the structures of a GreatWksText.
Definition: GreatWksText.cxx:59
GreatWksText::operator=
GreatWksText & operator=(GreatWksText const &orig)=delete
GreatWksText::~GreatWksText
virtual ~GreatWksText()
destructor
Definition: GreatWksText.cxx:465