ActaText.hxx Source File documentation

ActaText.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 Acta document
36 *
37 */
38 #ifndef ACTA_TEXT
39 # define ACTA_TEXT
40
41 #include "libmwaw_internal.hxx"
42 #include "MWAWDebug.hxx"
43
44 namespace ActaTextInternal
45 {
46 struct Topic;
47 struct State;
48 }
49
50 class ActaParser;
51
57 class ActaText
58 {
59 friend class ActaParser;
60 public:
62 explicit ActaText(ActaParser &parser);
64 virtual ~ActaText();
65
67 int version() const;
68
70 int numPages() const;
71
72 protected:
74 bool createZones();
76 bool sendMainText();
77
78 //
79 // intermediate level
80 //
81
83 bool getColor(int id, MWAWColor &col) const;
84
86 bool readTopic();
87
89 bool sendTopic(ActaTextInternal::Topic const &topic);
90
92 bool sendText(ActaTextInternal::Topic const &topic);
93
95 bool sendGraphic(ActaTextInternal::Topic const &topic);
96
98 bool readFont(MWAWFont &font, bool inPLC);
99
100 private:
101 ActaText(ActaText const &orig) = delete;
102 ActaText &operator=(ActaText const &orig) = delete;
103
104 protected:
105 //
106 // data
107 //
109 MWAWParserStatePtr m_parserState;
110
112 std::shared_ptr<ActaTextInternal::State> m_state;
113
115 ActaParser *m_mainParser;
116 };
117 #endif
118 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWTextListenerPtr
std::shared_ptr< MWAWTextListener > MWAWTextListenerPtr
a smart pointer of MWAWTextListener
Definition: libmwaw_internal.hxx:567
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
ActaTextInternal::State::State
State()
constructor
Definition: ActaText.cxx:131
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
MWAWVec2f
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:842
MWAWPosition::setRelativePosition
void setRelativePosition(AnchorTo anchor, XPos X=XLeft, YPos Y=YTop)
sets the relative position
Definition: MWAWPosition.hxx:237
MWAWFont::boldBit
@ boldBit
Definition: MWAWFont.hxx:190
ActaTextInternal::Topic
Internal: a topic of a ActaText.
Definition: ActaText.cxx:62
MWAWParagraph::m_listLevelIndex
MWAWVariable< int > m_listLevelIndex
the actual level index
Definition: MWAWParagraph.hxx:174
ActaTextInternal::Topic::m_font
MWAWFont m_font
the line font
Definition: ActaText.cxx:114
MWAWFontConverter.hxx
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192
MWAWEmbeddedObject
small class use to define a embedded object
Definition: libmwaw_internal.hxx:467
ActaTextInternal::Topic::m_extra
std::string m_extra
extra
Definition: ActaText.cxx:124
MWAWParagraph
class to store the paragraph properties
Definition: MWAWParagraph.hxx:84
MWAWFont::Line::Simple
@ Simple
Definition: MWAWFont.hxx:49
ActaTextInternal::State::m_colorList
std::vector< MWAWColor > m_colorList
a list colorId -> color
Definition: ActaText.cxx:148
ActaTextInternal::State::m_numPages
int m_numPages
Definition: ActaText.cxx:151
libmwaw::DebugFile::addNote
void addNote(char const *note)
adds a note in the file, in actual position
Definition: MWAWDebug.cxx:59
MWAWParagraph::m_margins
MWAWVariable< double > m_margins[3]
the margins
Definition: MWAWParagraph.hxx:148
ActaTextInternal::Topic::m_pageBreak
bool m_pageBreak
true if a page break exists before the topic
Definition: ActaText.cxx:112
ActaText::sendTopic
bool sendTopic(ActaTextInternal::Topic const &topic)
try to send a topic
Definition: ActaText.cxx:353
ActaTextInternal::Topic::m_auxi
MWAWEntry m_auxi
an auxialliary entry(unknown)
Definition: ActaText.cxx:122
MWAWFont::embossBit
@ embossBit
Definition: MWAWFont.hxx:190
ActaText::~ActaText
virtual ~ActaText()
destructor
Definition: ActaText.cxx:181
ActaText::m_state
std::shared_ptr< ActaTextInternal::State > m_state
the state
Definition: ActaText.hxx:112
ActaText::createZones
bool createZones()
try to create the text zones
Definition: ActaText.cxx:225
MWAWFont::m_extra
std::string m_extra
extra data
Definition: MWAWFont.hxx:573
ActaParser.hxx
ActaTextInternal::State::m_topicList
std::vector< Topic > m_topicList
the topic list
Definition: ActaText.cxx:144
ActaTextInternal::Topic::m_hidden
int m_hidden
the number of time a topic is hidden by its parents
Definition: ActaText.cxx:110
MWAWFont::shadowBit
@ shadowBit
Definition: MWAWFont.hxx:191
MWAWParagraph.hxx
libmwaw::DebugFile::skipZone
void skipZone(long beginPos, long endPos)
skips the file zone defined by beginPos-endPos
Definition: MWAWDebug.hxx:113
MWAWRSRCParser.hxx
libmwaw::Debug::dumpFile
bool dumpFile(librevenge::RVNGBinaryData &data, char const *fileName)
a debug function to store in a datafile in the current directory WARNING: this function erase the fil...
Definition: MWAWDebug.cxx:193
libmwaw_internal.hxx
MWAWPosition.hxx
ActaText::readTopic
bool readTopic()
try to read the topic definitions (line or graphic)
Definition: ActaText.cxx:268
ActaParser::getMainList
std::shared_ptr< MWAWList > getMainList()
returns a list to be used in the text
Definition: ActaParser.cxx:316
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:47
ActaText.hxx
MWAWEntry::setBegin
void setBegin(long off)
sets the begin offset
Definition: MWAWEntry.hxx:67
MWAWColor::isBlack
bool isBlack() const
return true if the color is black
Definition: libmwaw_internal.hxx:284
ActaTextInternal::Topic::Topic
Topic()
constructor
Definition: ActaText.cxx:64
MWAWEntry::length
long length() const
returns the length of the zone
Definition: MWAWEntry.hxx:93
MWAWPictData.hxx
ActaText::operator=
ActaText & operator=(ActaText const &orig)=delete
MWAWPict::MWAW_R_BAD
@ MWAW_R_BAD
Definition: MWAWPict.hxx:73
MWAWDebug.hxx
ActaTextInternal::State::setDefaultColorList
void setDefaultColorList(int version)
set the default color map
Definition: ActaText.cxx:154
MWAWFont::getDebugString
std::string getDebugString(std::shared_ptr< MWAWFontConverter > &converter) const
returns a string which can be used for debugging
Definition: MWAWFont.cxx:181
ActaParser
the main class to read a Acta file
Definition: ActaParser.hxx:57
MWAWEntry::begin
long begin() const
returns the begin offset
Definition: MWAWEntry.hxx:83
MWAWEntry::setLength
void setLength(long l)
sets the zone size
Definition: MWAWEntry.hxx:72
ActaTextInternal::Topic::m_labelColor
MWAWColor m_labelColor
the label color
Definition: ActaText.cxx:116
ActaParser::newPage
void newPage(int number)
adds a new page
Definition: ActaParser.cxx:397
MWAWFont::setId
void setId(int newId)
sets the font id
Definition: MWAWFont.hxx:264
ActaTextInternal::State::m_listId
int m_listId
the list id
Definition: ActaText.cxx:146
ActaText::ActaText
ActaText(ActaParser &parser)
constructor
Definition: ActaText.cxx:174
ActaTextInternal
Internal: the structures of a ActaText.
Definition: ActaText.cxx:58
MWAWPosition::Char
@ Char
Definition: MWAWPosition.hxx:51
ActaTextInternal::Topic::operator<<
friend std::ostream & operator<<(std::ostream &o, Topic const &topic)
operator<<
Definition: ActaText.cxx:83
MWAWPictData::check
static ReadResult check(MWAWInputStreamPtr const &input, int size, MWAWBox2f &box)
checks if the data pointed by input is known
Definition: MWAWPictData.hxx:100
MWAWEntry::end
long end() const
returns the end offset
Definition: MWAWEntry.hxx:88
MWAWFont::setSize
void setSize(float sz, bool isRelative=false)
sets the font size
Definition: MWAWFont.hxx:275
ActaTextInternal::State::m_version
int m_version
the file version
Definition: ActaText.cxx:150
ActaTextInternal::State::m_actualPage
int m_actualPage
Definition: ActaText.cxx:151
ActaText::getColor
bool getColor(int id, MWAWColor &col) const
return the color which corresponds to an id (if possible)
Definition: ActaText.cxx:205
ActaTextInternal::Topic::valid
bool valid() const
return true if the topic is valid
Definition: ActaText.cxx:78
MWAWFont::italicBit
@ italicBit
Definition: MWAWFont.hxx:190
ActaText::sendGraphic
bool sendGraphic(ActaTextInternal::Topic const &topic)
try to read a graphic
Definition: ActaText.cxx:507
MWAWPageSpan.hxx
ActaText::version
int version() const
returns the file version
Definition: ActaText.cxx:184
ActaText::m_mainParser
ActaParser * m_mainParser
the main parser
Definition: ActaText.hxx:115
MWAWTextListener.hxx
ActaTextInternal::Topic::m_fonts
MWAWEntry m_fonts
the fonts entries(for text)
Definition: ActaText.cxx:120
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
libmwaw::DebugFile::addPos
void addPos(long pos)
adds a new position in the file
Definition: MWAWDebug.cxx:53
MWAWEntry::valid
bool valid() const
returns true if the zone length is positive
Definition: MWAWEntry.hxx:99
MWAWBox2::size
MWAWVec2< T > size() const
the box size
Definition: libmwaw_internal.hxx:1067
ActaTextInternal::Topic::m_depth
int m_depth
the node depth
Definition: ActaText.cxx:106
libmwaw::DebugFile
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:65
MWAWFont.hxx
ActaTextInternal::Topic::m_type
int m_type
the node type: 1=text, 2=graphic
Definition: ActaText.cxx:108
ActaText::readFont
bool readFont(MWAWFont &font, bool inPLC)
try to read a font
Definition: ActaText.cxx:560
ActaText::numPages
int numPages() const
returns the number of pages
Definition: ActaText.cxx:191
MWAWBox2< float >
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
ActaText
the main class to read the text part of Acta Text file
Definition: ActaText.hxx:57
ActaTextInternal::Topic::m_data
MWAWEntry m_data
the data entries(text or graphic)
Definition: ActaText.cxx:118
MWAWParagraph::m_listId
MWAWVariable< int > m_listId
the list id (if know )
Definition: MWAWParagraph.hxx:176
ActaText::sendMainText
bool sendMainText()
send a main zone
Definition: ActaText.cxx:250
ActaText::sendText
bool sendText(ActaTextInternal::Topic const &topic)
try to read a text entry
Definition: ActaText.cxx:409
ActaText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: ActaText.hxx:109
libmwaw::DebugStream
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:61
MWAWFont::setUnderlineStyle
void setUnderlineStyle(Line::Style style=Line::None, bool doReset=true)
sets the underline style ( by default, we also reset the style)
Definition: MWAWFont.hxx:466
ActaTextInternal::State
Internal: the state of a ActaText.
Definition: ActaText.cxx:129
MWAWFont::setFlags
void setFlags(uint32_t fl)
sets the font attributes bold, ...
Definition: MWAWFont.hxx:325