MWAWTextListener.hxx Source File documentation

MWAWTextListener.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
40#ifndef MWAW_TEXT_LISTENER_H
41#define MWAW_TEXT_LISTENER_H
42
43#include <vector>
44
45#include <librevenge/librevenge.h>
46
47#include "libmwaw_internal.hxx"
48#include "MWAWGraphicStyle.hxx"
49
50#include "MWAWListener.hxx"
51
52class MWAWCell;
53class MWAWGraphicStyle;
54class MWAWGraphicShape;
55class MWAWTable;
56
57namespace MWAWTextListenerInternal
58{
59struct DocumentState;
60struct State;
61}
62
64 class MWAWTextListener final : public MWAWListener
65{
66public:
68 MWAWTextListener(MWAWParserState &parserState, std::vector<MWAWPageSpan> const &pageList, librevenge::RVNGTextInterface *documentInterface);
70 ~MWAWTextListener() final;
71
73 Type getType() const final
74 {
75 return Text;
76 }
77
79 void setDocumentMetaData(librevenge::RVNGPropertyList const &metadata) final;
81 void setDocumentLanguage(std::string const &locale) final;
82
84 void startDocument() final;
86 void endDocument(bool sendDelayedSubDoc=true) final;
88 bool isDocumentStarted() const final;
89
91 void handleSubDocument(MWAWSubDocumentPtr const &subDocument, libmwaw::SubDocumentType subDocumentType) final;
93 bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const final;
95 bool openFrame(MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final;
97 void closeFrame() final;
99 bool openGroup(MWAWPosition const &pos) final;
101 void closeGroup() final;
102
104 bool canWriteText() const final
105 {
106 return MWAWTextListener::isDocumentStarted();
107 }
108
109 // ------ page --------
111 bool isPageSpanOpened() const final;
115 MWAWPageSpan const &getPageSpan() final;
116
117 // ------ header/footer --------
119 bool insertHeader(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final;
121 bool insertFooter(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final;
123 bool isHeaderFooterOpened() const final;
124
125 // ------ text data -----------
126
128 void insertChar(uint8_t character) final;
131 void insertCharacter(unsigned char c) final;
137 int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1) final;
140 void insertUnicode(uint32_t character) final;
142 void insertUnicodeString(librevenge::RVNGString const &str) final;
143
145 void insertTab() final;
147 void insertEOL(bool softBreak=false) final;
148
149 // ------ text format -----------
151 void setFont(MWAWFont const &font) final;
153 MWAWFont const &getFont() const final;
154
155 // ------ paragraph format -----------
157 bool isParagraphOpened() const final;
159 void setParagraph(MWAWParagraph const &paragraph) final;
161 MWAWParagraph const &getParagraph() const final;
162
163 // ------- fields ----------------
165 void insertField(MWAWField const &field) final;
166
167 // ------- link ----------------
169 void openLink(MWAWLink const &link) final;
171 void closeLink() final;
172
173 // ------- subdocument -----------------
175 void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument) final;
176
178 void insertComment(MWAWSubDocumentPtr &subDocument) final;
179
181 void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture,
182 MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final;
184 void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape,
185 MWAWGraphicStyle const &style) final;
187 void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr const &subDocument,
188 MWAWGraphicStyle const &frameStyle=MWAWGraphicStyle::emptyStyle()) final;
189
190 // ------- table -----------------
192 void openTable(MWAWTable const &table) final;
194 void closeTable() final;
196 void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false) final;
198 void closeTableRow() final;
200 void openTableCell(MWAWCell const &cell) final;
202 void closeTableCell() final;
204 void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1,1)) final;
205
206 // ------- section ---------------
208 bool canOpenSectionAddBreak() const final;
210 bool isSectionOpened() const final;
212 MWAWSection const &getSection() const final;
214 bool openSection(MWAWSection const &section) final;
216 bool closeSection() final;
218 void insertBreak(BreakType breakType) final;
219
220protected:
222 void _openSection();
224 void _closeSection();
226 void _openPageSpan(bool sendHeaderFooters=true);
228 void _closePageSpan();
229
230 void _startSubDocument();
231 void _endSubDocument();
232
233 void _handleFrameParameters(librevenge::RVNGPropertyList &propList, MWAWPosition const &pos);
234
235 void _openParagraph();
236 void _closeParagraph();
237 void _appendParagraphProperties(librevenge::RVNGPropertyList &propList, const bool isListElement=false);
238 void _resetParagraphState(const bool isListElement=false);
239
241 void _openListElement();
243 void _closeListElement();
245 void _changeList();
250 int _getListId() const;
251
253 void _openSpan();
255 void _closeSpan();
256
258 void _flushText();
260 void _flushDeferredTabs();
261
262 void _insertBreakIfNecessary(librevenge::RVNGPropertyList &propList);
263
267 std::shared_ptr<MWAWTextListenerInternal::State> _pushParsingState();
269 void _popParsingState();
270
271protected:
273 std::shared_ptr<MWAWTextListenerInternal::DocumentState> m_ds;
275 std::shared_ptr<MWAWTextListenerInternal::State> m_ps;
277 std::vector<std::shared_ptr<MWAWTextListenerInternal::State> > m_psStack;
279 MWAWParserState &m_parserState;
281 librevenge::RVNGTextInterface *m_documentInterface;
282
283private:
285 MWAWTextListener(const MWAWTextListener &) = delete;
287 MWAWTextListener &operator=(const MWAWTextListener &) = delete;
288};
289
290#endif
291// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWGraphicStyle.hxx
MWAWListener.hxx
MWAWCell
a structure used to define a cell and its format
Definition MWAWCell.hxx:53
MWAWFont
Class to store font.
Definition MWAWFont.hxx:44
MWAWGraphicShape
a structure used to define a picture shape
Definition MWAWGraphicShape.hxx:46
MWAWGraphicStyle
a structure used to define a picture style
Definition MWAWGraphicStyle.hxx:48
MWAWListener
This class contains a virtual interface to all listener.
Definition MWAWListener.hxx:50
MWAWListener::Type
Type
the listener type
Definition MWAWListener.hxx:56
MWAWListener::Text
@ Text
Definition MWAWListener.hxx:56
MWAWListener::BreakType
BreakType
the different break type
Definition MWAWListener.hxx:58
MWAWPageSpan
A class which defines the page properties.
Definition MWAWPageSpan.hxx:99
MWAWParagraph
class to store the paragraph properties
Definition MWAWParagraph.hxx:85
MWAWParserState
a class to define the parser state
Definition MWAWParser.hxx:50
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition MWAWPosition.hxx:48
MWAWSection
a class which stores section properties
Definition MWAWSection.hxx:46
MWAWTable
a class used to recreate the table structure using cell informations, ....
Definition MWAWTable.hxx:52
MWAWTextListener
This class contents the main functions needed to create a Word processing Document.
Definition MWAWTextListener.hxx:65
MWAWTextListener::isParagraphOpened
bool isParagraphOpened() const final
returns true if a paragraph or a list is opened
Definition MWAWTextListener.cxx:431
MWAWTextListener::isPageSpanOpened
bool isPageSpanOpened() const final
returns true if a page is opened
Definition MWAWTextListener.cxx:561
MWAWTextListener::closeTableRow
void closeTableRow() final
closes this row
Definition MWAWTextListener.cxx:1814
MWAWTextListener::canWriteText
bool canWriteText() const final
returns true if we can add text data
Definition MWAWTextListener.hxx:104
MWAWTextListener::m_ds
std::shared_ptr< MWAWTextListenerInternal::DocumentState > m_ds
the main parse state
Definition MWAWTextListener.hxx:273
MWAWTextListener::m_ps
std::shared_ptr< MWAWTextListenerInternal::State > m_ps
the actual local parse state
Definition MWAWTextListener.hxx:275
MWAWTextListener::insertChar
void insertChar(uint8_t character) final
adds a basic character, ..
Definition MWAWTextListener.cxx:238
MWAWTextListener::insertTab
void insertTab() final
adds a tab
Definition MWAWTextListener.cxx:330
MWAWTextListener::startDocument
void startDocument() final
starts the document
Definition MWAWTextListener.cxx:517
MWAWTextListener::_pushParsingState
std::shared_ptr< MWAWTextListenerInternal::State > _pushParsingState()
creates a new parsing state (copy of the actual state)
Definition MWAWTextListener.cxx:1880
MWAWTextListener::_changeList
void _changeList()
update the list so that it corresponds to the actual level
Definition MWAWTextListener.cxx:891
MWAWTextListener::_openSpan
void _openSpan()
low level: the function which opens a new span property
Definition MWAWTextListener.cxx:950
MWAWTextListener::insertHeader
bool insertHeader(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final
insert a header
Definition MWAWTextListener.cxx:639
MWAWTextListener::setParagraph
void setParagraph(MWAWParagraph const &paragraph) final
sets the paragraph
Definition MWAWTextListener.cxx:436
MWAWTextListener::m_psStack
std::vector< std::shared_ptr< MWAWTextListenerInternal::State > > m_psStack
stack of local state
Definition MWAWTextListener.hxx:277
MWAWTextListener::_openListElement
void _openListElement()
open a list level
Definition MWAWTextListener.cxx:829
MWAWTextListener::handleSubDocument
void handleSubDocument(MWAWSubDocumentPtr const &subDocument, libmwaw::SubDocumentType subDocumentType) final
function called to add a subdocument
Definition MWAWTextListener.cxx:1643
MWAWTextListener::addEmptyTableCell
void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1, 1)) final
add empty cell
Definition MWAWTextListener.cxx:1824
MWAWTextListener::isHeaderFooterOpened
bool isHeaderFooterOpened() const final
returns true if the header/footer is open
Definition MWAWTextListener.cxx:634
MWAWTextListener::_openParagraph
void _openParagraph()
Definition MWAWTextListener.cxx:758
MWAWTextListener::insertField
void insertField(MWAWField const &field) final
adds a field type
Definition MWAWTextListener.cxx:451
MWAWTextListener::m_documentInterface
librevenge::RVNGTextInterface * m_documentInterface
the document interface
Definition MWAWTextListener.hxx:281
MWAWTextListener::insertShape
void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape, MWAWGraphicStyle const &style) final
adds a shape picture in given position
Definition MWAWTextListener.cxx:1136
MWAWTextListener::insertComment
void insertComment(MWAWSubDocumentPtr &subDocument) final
adds comment
Definition MWAWTextListener.cxx:1095
MWAWTextListener::_closeListElement
void _closeListElement()
close a list level
Definition MWAWTextListener.cxx:859
MWAWTextListener::openTable
void openTable(MWAWTable const &table) final
open a table
Definition MWAWTextListener.cxx:1756
MWAWTextListener::isSectionOpened
bool isSectionOpened() const final
returns true if a section is opened
Definition MWAWTextListener.cxx:668
MWAWTextListener::openLink
void openLink(MWAWLink const &link) final
open a link
Definition MWAWTextListener.cxx:469
MWAWTextListener::_closeSection
void _closeSection()
does close a section (low level)
Definition MWAWTextListener.cxx:738
MWAWTextListener::_resetParagraphState
void _resetParagraphState(const bool isListElement=false)
Definition MWAWTextListener.cxx:808
MWAWTextListener::_popParsingState
void _popParsingState()
resets the previous parsing state
Definition MWAWTextListener.cxx:1891
MWAWTextListener::_closeSpan
void _closeSpan()
low level: the function which closes the last opened span property
Definition MWAWTextListener.cxx:974
MWAWTextListener::getPageSpan
MWAWPageSpan const & getPageSpan() final
returns the current page span
Definition MWAWTextListener.cxx:566
MWAWTextListener::_handleFrameParameters
void _handleFrameParameters(librevenge::RVNGPropertyList &propList, MWAWPosition const &pos)
Definition MWAWTextListener.cxx:1401
MWAWTextListener::closeLink
void closeLink() final
close a link
Definition MWAWTextListener.cxx:485
MWAWTextListener::_closePageSpan
void _closePageSpan()
does close a page (low level)
Definition MWAWTextListener.cxx:619
MWAWTextListener::m_parserState
MWAWParserState & m_parserState
the parser state
Definition MWAWTextListener.hxx:279
MWAWTextListener::insertTextBox
void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr const &subDocument, MWAWGraphicStyle const &frameStyle=MWAWGraphicStyle::emptyStyle()) final
adds a textbox in given position
Definition MWAWTextListener.cxx:1120
MWAWTextListener::insertUnicodeString
void insertUnicodeString(librevenge::RVNGString const &str) final
adds a unicode string
Definition MWAWTextListener.cxx:305
MWAWTextListener::openTableCell
void openTableCell(MWAWCell const &cell) final
open a cell
Definition MWAWTextListener.cxx:1843
MWAWTextListener::isSubDocumentOpened
bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const final
returns try if a subdocument is open
Definition MWAWTextListener.cxx:1728
MWAWTextListener::closeGroup
void closeGroup() final
close a group
Definition MWAWTextListener.cxx:1389
MWAWTextListener::openFrame
bool openFrame(MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final
tries to open a frame
Definition MWAWTextListener.cxx:1258
MWAWTextListener::getParagraph
MWAWParagraph const & getParagraph() const final
returns the actual paragraph
Definition MWAWTextListener.cxx:443
MWAWTextListener::endDocument
void endDocument(bool sendDelayedSubDoc=true) final
ends the document
Definition MWAWTextListener.cxx:530
MWAWTextListener::closeTable
void closeTable() final
closes this table
Definition MWAWTextListener.cxx:1779
MWAWTextListener::setFont
void setFont(MWAWFont const &font) final
sets the font
Definition MWAWTextListener.cxx:410
MWAWTextListener::MWAWTextListener
MWAWTextListener(MWAWParserState &parserState, std::vector< MWAWPageSpan > const &pageList, librevenge::RVNGTextInterface *documentInterface)
constructor
Definition MWAWTextListener.cxx:222
MWAWTextListener::insertEOL
void insertEOL(bool softBreak=false) final
adds an end of line ( by default an hard one)
Definition MWAWTextListener.cxx:312
MWAWTextListener::_openPageSpan
void _openPageSpan(bool sendHeaderFooters=true)
does open a new page (low level)
Definition MWAWTextListener.cxx:574
MWAWTextListener::_flushText
void _flushText()
low level: flush the deferred text
Definition MWAWTextListener.cxx:1007
MWAWTextListener::getFont
MWAWFont const & getFont() const final
returns the actual font
Definition MWAWTextListener.cxx:426
MWAWTextListener::_openSection
void _openSection()
does open a section (low level)
Definition MWAWTextListener.cxx:715
MWAWTextListener::_closeParagraph
void _closeParagraph()
Definition MWAWTextListener.cxx:784
MWAWTextListener::insertUnicode
void insertUnicode(uint32_t character) final
adds an unicode character.
Definition MWAWTextListener.cxx:295
MWAWTextListener::getSection
MWAWSection const & getSection() const final
returns the actual section
Definition MWAWTextListener.cxx:673
MWAWTextListener::_startSubDocument
void _startSubDocument()
Definition MWAWTextListener.cxx:1736
MWAWTextListener::insertNote
void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument) final
insert a note
Definition MWAWTextListener.cxx:1038
MWAWTextListener::_insertBreakIfNecessary
void _insertBreakIfNecessary(librevenge::RVNGPropertyList &propList)
Definition MWAWTextListener.cxx:389
MWAWTextListener::closeSection
bool closeSection() final
close a section
Definition MWAWTextListener.cxx:700
MWAWTextListener::insertBreak
void insertBreak(BreakType breakType) final
inserts a break type: ColumBreak, PageBreak, ..
Definition MWAWTextListener.cxx:341
MWAWTextListener::_flushDeferredTabs
void _flushDeferredTabs()
low level: flush the deferred tabs
Definition MWAWTextListener.cxx:988
MWAWTextListener::_appendParagraphProperties
void _appendParagraphProperties(librevenge::RVNGPropertyList &propList, const bool isListElement=false)
Definition MWAWTextListener.cxx:816
MWAWTextListener::closeFrame
void closeFrame() final
tries to close the last open frame
Definition MWAWTextListener.cxx:1328
MWAWTextListener::insertPicture
void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final
adds a picture with potential various representationin given position
Definition MWAWTextListener.cxx:1234
MWAWTextListener::getType
Type getType() const final
returns the listener type
Definition MWAWTextListener.hxx:73
MWAWTextListener::openGroup
bool openGroup(MWAWPosition const &pos) final
open a group
Definition MWAWTextListener.cxx:1338
MWAWTextListener::openSection
bool openSection(MWAWSection const &section) final
open a section if possible
Definition MWAWTextListener.cxx:683
MWAWTextListener::closeTableCell
void closeTableCell() final
close a cell
Definition MWAWTextListener.cxx:1860
MWAWTextListener::isDocumentStarted
bool isDocumentStarted() const final
returns true if a document is opened
Definition MWAWTextListener.cxx:512
MWAWTextListener::insertCharacter
void insertCharacter(unsigned char c) final
insert a character using the font converter to find the utf8 character
Definition MWAWTextListener.cxx:249
MWAWTextListener::setDocumentMetaData
void setDocumentMetaData(librevenge::RVNGPropertyList const &metadata) final
sets the documents metadata
Definition MWAWTextListener.cxx:499
MWAWTextListener::openTableRow
void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false) final
open a row with given height ( if h < 0.0, set min-row-height = -h )
Definition MWAWTextListener.cxx:1793
MWAWTextListener::_getListId
int _getListId() const
low level: find a list id which corresponds to actual list and a change of level.
Definition MWAWTextListener.cxx:875
MWAWTextListener::insertFooter
bool insertFooter(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final
insert a footer
Definition MWAWTextListener.cxx:652
MWAWTextListener::_endSubDocument
void _endSubDocument()
Definition MWAWTextListener.cxx:1742
MWAWTextListener::setDocumentLanguage
void setDocumentLanguage(std::string const &locale) final
sets the documents language
Definition MWAWTextListener.cxx:506
MWAWTextListener::~MWAWTextListener
~MWAWTextListener() final
destructor
Definition MWAWTextListener.cxx:231
MWAWTextListener::canOpenSectionAddBreak
bool canOpenSectionAddBreak() const final
returns true if we can add open a section, add page break, ...
Definition MWAWTextListener.cxx:678
MWAWVec2< int >
libmwaw_internal.hxx
MWAWSubDocumentPtr
std::shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition libmwaw_internal.hxx:565
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition libmwaw_internal.hxx:551
MWAWTextListenerInternal
Internal and low level namespace to define the states of MWAWTextListener.
Definition MWAWTextListener.cxx:71
libmwaw
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition libmwaw_internal.cxx:51
librevenge
Definition MWAWDocument.hxx:57
MWAWEmbeddedObject
small class use to define a embedded object
Definition libmwaw_internal.hxx:467
MWAWField
a field
Definition libmwaw_internal.hxx:399
MWAWLink
a link
Definition libmwaw_internal.hxx:430
MWAWNote
a note
Definition libmwaw_internal.hxx:445