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;
55class MWAWTable;
56
58{
59struct DocumentState;
60struct State;
61}
62
65{
66public:
68 MWAWTextListener(MWAWParserState &parserState, std::vector<MWAWPageSpan> const &pageList, librevenge::RVNGTextInterface *documentInterface);
70 virtual ~MWAWTextListener();
71
73 Type getType() const
74 {
75 return Text;
76 }
77
79 void setDocumentMetaData(librevenge::RVNGPropertyList const &metadata);
81 void setDocumentLanguage(std::string const &locale);
82
84 void startDocument();
86 void endDocument(bool sendDelayedSubDoc=true);
88 bool isDocumentStarted() const;
89
91 void handleSubDocument(MWAWSubDocumentPtr subDocument, libmwaw::SubDocumentType subDocumentType);
93 bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const;
97 void closeFrame();
99 bool openGroup(MWAWPosition const &pos);
101 void closeGroup();
102
104 bool canWriteText() const
105 {
107 }
108
109 // ------ page --------
111 bool isPageSpanOpened() const;
115 MWAWPageSpan const &getPageSpan();
116
117 // ------ header/footer --------
119 bool insertHeader(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras);
121 bool insertFooter(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras);
123 bool isHeaderFooterOpened() const;
124
125 // ------ text data -----------
126
128 void insertChar(uint8_t character);
131 void insertCharacter(unsigned char c);
137 int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1);
140 void insertUnicode(uint32_t character);
142 void insertUnicodeString(librevenge::RVNGString const &str);
143
145 void insertTab();
147 void insertEOL(bool softBreak=false);
148
149 // ------ text format -----------
151 void setFont(MWAWFont const &font);
153 MWAWFont const &getFont() const;
154
155 // ------ paragraph format -----------
157 bool isParagraphOpened() const;
159 void setParagraph(MWAWParagraph const &paragraph);
161 MWAWParagraph const &getParagraph() const;
162
163 // ------- fields ----------------
165 void insertField(MWAWField const &field);
166
167 // ------- link ----------------
169 void openLink(MWAWLink const &link);
171 void closeLink();
172
173 // ------- subdocument -----------------
175 void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument);
176
178 void insertComment(MWAWSubDocumentPtr &subDocument);
179
181 void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture,
184 void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape,
185 MWAWGraphicStyle const &style);
187 void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr subDocument,
189
190 // ------- table -----------------
192 void openTable(MWAWTable const &table);
194 void closeTable();
196 void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false);
198 void closeTableRow();
200 void openTableCell(MWAWCell const &cell);
202 void closeTableCell();
204 void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1,1));
205
206 // ------- section ---------------
208 bool canOpenSectionAddBreak() const;
210 bool isSectionOpened() const;
212 MWAWSection const &getSection() const;
214 bool openSection(MWAWSection const &section);
216 bool closeSection();
218 void insertBreak(BreakType breakType);
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 shared_ptr<MWAWTextListenerInternal::State> _pushParsingState();
269 void _popParsingState();
270
271protected:
273 shared_ptr<MWAWTextListenerInternal::DocumentState> m_ds;
275 shared_ptr<MWAWTextListenerInternal::State> m_ps;
277 std::vector<shared_ptr<MWAWTextListenerInternal::State> > m_psStack;
281 librevenge::RVNGTextInterface *m_documentInterface;
282
283private:
288};
289
290#endif
291// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
a structure used to define a cell and its format
Definition: MWAWCell.hxx:53
Class to store font.
Definition: MWAWFont.hxx:44
a structure used to define a picture shape
Definition: MWAWGraphicShape.hxx:46
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:48
static MWAWGraphicStyle emptyStyle()
returns an empty style.
Definition: MWAWGraphicStyle.hxx:268
This class contains a virtual interface to all listener.
Definition: MWAWListener.hxx:50
Type
the listener type
Definition: MWAWListener.hxx:56
@ Text
Definition: MWAWListener.hxx:56
BreakType
the different break type
Definition: MWAWListener.hxx:58
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:96
class to store the paragraph properties
Definition: MWAWParagraph.hxx:82
a class to define the parser state
Definition: MWAWParser.hxx:50
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
a class which stores section properties
Definition: MWAWSection.hxx:46
a class used to recreate the table structure using cell informations, ....
Definition: MWAWTable.hxx:52
This class contents the main functions needed to create a Word processing Document.
Definition: MWAWTextListener.hxx:65
bool canWriteText() const
returns true if we can add text data
Definition: MWAWTextListener.hxx:104
Type getType() const
returns the listener type
Definition: MWAWTextListener.hxx:73
void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false)
open a row with given height ( if h < 0.0, set min-row-height = -h )
Definition: MWAWTextListener.cxx:1768
void startDocument()
starts the document
Definition: MWAWTextListener.cxx:495
virtual ~MWAWTextListener()
destructor
Definition: MWAWTextListener.cxx:209
void openTable(MWAWTable const &table)
open a table
Definition: MWAWTextListener.cxx:1731
void closeTableCell()
close a cell
Definition: MWAWTextListener.cxx:1835
bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const
returns try if a subdocument is open
Definition: MWAWTextListener.cxx:1703
std::vector< shared_ptr< MWAWTextListenerInternal::State > > m_psStack
stack of local state
Definition: MWAWTextListener.hxx:277
shared_ptr< MWAWTextListenerInternal::State > _pushParsingState()
creates a new parsing state (copy of the actual state)
Definition: MWAWTextListener.cxx:1855
void setDocumentMetaData(librevenge::RVNGPropertyList const &metadata)
sets the documents metadata
Definition: MWAWTextListener.cxx:477
bool isSectionOpened() const
returns true if a section is opened
Definition: MWAWTextListener.cxx:646
void setFont(MWAWFont const &font)
sets the font
Definition: MWAWTextListener.cxx:388
bool isParagraphOpened() const
returns true if a paragraph or a list is opened
Definition: MWAWTextListener.cxx:409
void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape, MWAWGraphicStyle const &style)
adds a shape picture in given position
Definition: MWAWTextListener.cxx:1114
void _changeList()
update the list so that it corresponds to the actual level
Definition: MWAWTextListener.cxx:870
void _openSpan()
low level: the function which opens a new span property
Definition: MWAWTextListener.cxx:929
void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1, 1))
add empty cell
Definition: MWAWTextListener.cxx:1799
shared_ptr< MWAWTextListenerInternal::State > m_ps
the actual local parse state
Definition: MWAWTextListener.hxx:275
void _openListElement()
open a list level
Definition: MWAWTextListener.cxx:807
MWAWPageSpan const & getPageSpan()
returns the current page span
Definition: MWAWTextListener.cxx:544
void insertUnicodeString(librevenge::RVNGString const &str)
adds a unicode string
Definition: MWAWTextListener.cxx:283
bool openGroup(MWAWPosition const &pos)
open a group
Definition: MWAWTextListener.cxx:1316
void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument)
insert a note
Definition: MWAWTextListener.cxx:1017
void insertChar(uint8_t character)
adds a basic character, ..
Definition: MWAWTextListener.cxx:216
bool isDocumentStarted() const
returns true if a document is opened
Definition: MWAWTextListener.cxx:490
void openTableCell(MWAWCell const &cell)
open a cell
Definition: MWAWTextListener.cxx:1818
void _openParagraph()
Definition: MWAWTextListener.cxx:736
librevenge::RVNGTextInterface * m_documentInterface
the document interface
Definition: MWAWTextListener.hxx:281
bool closeSection()
close a section
Definition: MWAWTextListener.cxx:678
void endDocument(bool sendDelayedSubDoc=true)
ends the document
Definition: MWAWTextListener.cxx:508
bool openFrame(MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle())
tries to open a frame
Definition: MWAWTextListener.cxx:1236
void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle())
adds a picture with potential various representationin given position
Definition: MWAWTextListener.cxx:1212
void _closeListElement()
close a list level
Definition: MWAWTextListener.cxx:837
void handleSubDocument(MWAWSubDocumentPtr subDocument, libmwaw::SubDocumentType subDocumentType)
function called to add a subdocument
Definition: MWAWTextListener.cxx:1621
void insertTab()
adds a tab
Definition: MWAWTextListener.cxx:308
void insertComment(MWAWSubDocumentPtr &subDocument)
adds comment
Definition: MWAWTextListener.cxx:1074
bool insertFooter(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras)
insert a footer
Definition: MWAWTextListener.cxx:630
void _closeSection()
does close a section (low level)
Definition: MWAWTextListener.cxx:716
void _resetParagraphState(const bool isListElement=false)
Definition: MWAWTextListener.cxx:786
void insertUnicode(uint32_t character)
adds an unicode character.
Definition: MWAWTextListener.cxx:273
void _popParsingState()
resets the previous parsing state
Definition: MWAWTextListener.cxx:1866
void _closeSpan()
low level: the function which closes the last opened span property
Definition: MWAWTextListener.cxx:953
void _handleFrameParameters(librevenge::RVNGPropertyList &propList, MWAWPosition const &pos)
Definition: MWAWTextListener.cxx:1379
void insertBreak(BreakType breakType)
inserts a break type: ColumBreak, PageBreak, ..
Definition: MWAWTextListener.cxx:319
bool isPageSpanOpened() const
returns true if a page is opened
Definition: MWAWTextListener.cxx:539
void _closePageSpan()
does close a page (low level)
Definition: MWAWTextListener.cxx:597
MWAWParserState & m_parserState
the parser state
Definition: MWAWTextListener.hxx:279
void closeTableRow()
closes this row
Definition: MWAWTextListener.cxx:1789
void closeLink()
close a link
Definition: MWAWTextListener.cxx:463
void closeFrame()
tries to close the last open frame
Definition: MWAWTextListener.cxx:1306
void insertCharacter(unsigned char c)
insert a character using the font converter to find the utf8 character
Definition: MWAWTextListener.cxx:227
MWAWTextListener(const MWAWTextListener &)
copy constructor (unimplemented)
void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr subDocument, MWAWGraphicStyle const &frameStyle=MWAWGraphicStyle::emptyStyle())
adds a textbox in given position
Definition: MWAWTextListener.cxx:1099
MWAWTextListener(MWAWParserState &parserState, std::vector< MWAWPageSpan > const &pageList, librevenge::RVNGTextInterface *documentInterface)
constructor
Definition: MWAWTextListener.cxx:203
void setParagraph(MWAWParagraph const &paragraph)
sets the paragraph
Definition: MWAWTextListener.cxx:414
void _openPageSpan(bool sendHeaderFooters=true)
does open a new page (low level)
Definition: MWAWTextListener.cxx:552
shared_ptr< MWAWTextListenerInternal::DocumentState > m_ds
the main parse state
Definition: MWAWTextListener.hxx:273
bool isHeaderFooterOpened() const
returns true if the header/footer is open
Definition: MWAWTextListener.cxx:612
void _flushText()
low level: flush the deferred text
Definition: MWAWTextListener.cxx:986
void _openSection()
does open a section (low level)
Definition: MWAWTextListener.cxx:693
bool insertHeader(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras)
insert a header
Definition: MWAWTextListener.cxx:617
void insertEOL(bool softBreak=false)
adds an end of line ( by default an hard one)
Definition: MWAWTextListener.cxx:290
void _closeParagraph()
Definition: MWAWTextListener.cxx:762
MWAWSection const & getSection() const
returns the actual section
Definition: MWAWTextListener.cxx:651
bool canOpenSectionAddBreak() const
returns true if we can add open a section, add page break, ...
Definition: MWAWTextListener.cxx:656
void _startSubDocument()
Definition: MWAWTextListener.cxx:1711
MWAWParagraph const & getParagraph() const
returns the actual paragraph
Definition: MWAWTextListener.cxx:421
void _insertBreakIfNecessary(librevenge::RVNGPropertyList &propList)
Definition: MWAWTextListener.cxx:367
void _flushDeferredTabs()
low level: flush the deferred tabs
Definition: MWAWTextListener.cxx:967
MWAWTextListener & operator=(const MWAWTextListener &)
operator= (unimplemented)
void _appendParagraphProperties(librevenge::RVNGPropertyList &propList, const bool isListElement=false)
Definition: MWAWTextListener.cxx:794
void setDocumentLanguage(std::string const &locale)
sets the documents language
Definition: MWAWTextListener.cxx:484
bool openSection(MWAWSection const &section)
open a section if possible
Definition: MWAWTextListener.cxx:661
void closeTable()
closes this table
Definition: MWAWTextListener.cxx:1754
int _getListId() const
low level: find a list id which corresponds to actual list and a change of level.
Definition: MWAWTextListener.cxx:853
void insertField(MWAWField const &field)
adds a field type
Definition: MWAWTextListener.cxx:429
void _endSubDocument()
Definition: MWAWTextListener.cxx:1717
void openLink(MWAWLink const &link)
open a link
Definition: MWAWTextListener.cxx:447
void closeGroup()
close a group
Definition: MWAWTextListener.cxx:1367
MWAWFont const & getFont() const
returns the actual font
Definition: MWAWTextListener.cxx:404
MWAWVec2< int > MWAWVec2i
MWAWVec2 of int.
Definition: libmwaw_internal.hxx:781
shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:517
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:503
Internal and low level namespace to define the states of MWAWTextListener.
Definition: MWAWTextListener.cxx:71
SubDocumentType
Definition: libmwaw_internal.hxx:178
small class use to define a embedded object
Definition: libmwaw_internal.hxx:425
a field
Definition: libmwaw_internal.hxx:369
a note
Definition: libmwaw_internal.hxx:406

Generated on Wed Jan 19 2022 22:23:16 for libmwaw by doxygen 1.9.3