STOFFTextListener.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 /* libstoff
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 #ifndef STOFF_TEXT_LISTENER_H
35 #define STOFF_TEXT_LISTENER_H
36 
37 #include <vector>
38 
39 #include <librevenge/librevenge.h>
40 
42 
43 #include "STOFFGraphicStyle.hxx"
44 
45 #include "STOFFListener.hxx"
46 
47 class STOFFTextShape;
48 
50 {
51 struct TextState;
52 struct State;
53 }
54 
59 class STOFFTextListener final : public STOFFListener
60 {
61 public:
63  STOFFTextListener(STOFFListManagerPtr &listManager, std::vector<STOFFPageSpan> const &pageList, librevenge::RVNGTextInterface *documentInterface);
65  ~STOFFTextListener() final;
66 
68  Type getType() const final
69  {
70  return Text;
71  }
72 
74  void setDocumentLanguage(std::string locale) final;
76  void setDocumentMetaData(const librevenge::RVNGPropertyList &list) final;
78  void startDocument() final;
80  void endDocument(bool sendDelayedSubDoc=true) final;
81 
82  // ------ general information --------
84  bool canWriteText() const final
85  {
87  }
88 
90  bool isDocumentStarted() const final;
91 
93  void handleSubDocument(STOFFSubDocumentPtr subDocument, libstoff::SubDocumentType subDocumentType) final;
95  bool isSubDocumentOpened(libstoff::SubDocumentType &subdocType) const final;
97  bool openFrame(STOFFFrameStyle const &frame, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final;
99  void closeFrame() final;
101  bool openGroup(STOFFFrameStyle const &frame) final;
103  void closeGroup() final;
105  bool openLayer(librevenge::RVNGString const &name);
107  void closeLayer();
108 
109  // ------ page --------
111  bool openMasterPage(STOFFPageSpan &/*masterPage*/);
114  {
115  }
117  bool isPageSpanOpened() const final;
121  STOFFPageSpan const &getPageSpan() final;
122 
123  // ------ header/footer --------
125  bool openHeader(librevenge::RVNGPropertyList const &extras) final;
127  bool openFooter(librevenge::RVNGPropertyList const &extras) final;
129  bool closeHeader() final;
131  bool closeFooter() final;
133  bool insertHeaderRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which) final;
135  bool insertFooterRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which) final;
137  bool isHeaderFooterOpened() const final;
138 
139  // ------ text data -----------
141  void insertChar(uint8_t character) final;
146  void insertUnicode(uint32_t character) final;
148  void insertUnicodeString(librevenge::RVNGString const &str) final;
149 
151  void insertTab() final;
153  void insertEOL(bool softBreak=false) final;
154 
155  // ------ text format -----------
157  void setFont(STOFFFont const &font) final;
159  STOFFFont const &getFont() const final;
160 
161  // ------ paragraph format -----------
163  bool isParagraphOpened() const final;
165  void setParagraph(STOFFParagraph const &paragraph) final;
167  STOFFParagraph const &getParagraph() const final;
168 
169  // ------ style definition -----------
171  void defineStyle(STOFFFont const &style) final;
173  bool isFontStyleDefined(librevenge::RVNGString const &name) const final;
175  void defineStyle(STOFFGraphicStyle const &style) final;
177  bool isGraphicStyleDefined(librevenge::RVNGString const &name) const final;
179  void defineStyle(STOFFParagraph const &style) final;
181  bool isParagraphStyleDefined(librevenge::RVNGString const &name) const final;
182 
183  // ------- fields ----------------
185  void insertField(STOFFField const &field) final;
186 
187  // ------- link ----------------
189  void openLink(STOFFLink const &link) final;
191  void closeLink() final;
192 
193  // ------- subdocument -----------------
195  void insertShape(STOFFFrameStyle const &frame, STOFFGraphicShape const &shape, STOFFGraphicStyle const &style) final;
197  void insertTextBox(STOFFFrameStyle const &pos, STOFFSubDocumentPtr subDocument, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final;
199  void insertPicture(STOFFFrameStyle const &frame, STOFFEmbeddedObject const &picture,
200  STOFFGraphicStyle const &style=STOFFGraphicStyle()) final;
202  void insertEquation(STOFFFrameStyle const &frame, librevenge::RVNGString const &equation,
203  STOFFGraphicStyle const &style=STOFFGraphicStyle()) final;
205  void insertNote(STOFFNote const &note, STOFFSubDocumentPtr &subDocument) final;
207  void insertComment(STOFFSubDocumentPtr &subDocument, librevenge::RVNGString const &creator="", librevenge::RVNGString const &date="") final;
208 
209  // ------- table -----------------
210 
212  void openTable(STOFFTable const &table) final;
214  void closeTable() final;
216  void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false) final;
218  void closeTableRow() final;
220  void openTableCell(STOFFCell const &cell) final;
222  void closeTableCell() final;
224  void addCoveredTableCell(STOFFVec2i const &pos) final;
226  void addEmptyTableCell(STOFFVec2i const &pos, STOFFVec2i span=STOFFVec2i(1,1)) final;
227 
228  // ------- section ---------------
229 
231  bool canOpenSectionAddBreak() const final;
233  bool isSectionOpened() const final;
235  STOFFSection const &getSection() const final;
237  bool openSection(STOFFSection const &section) final;
239  bool closeSection() final;
241  void insertBreak(BreakType breakType) final;
242 
243 protected:
245  void _openSection();
247  void _closeSection();
249  void _openPageSpan(bool sendHeaderFooters=true);
251  void _closePageSpan();
252 
253  void _startSubDocument();
254  void _endSubDocument();
255 
259  void _handleFrameParameters(librevenge::RVNGPropertyList &propList, STOFFFrameStyle const &frame, STOFFGraphicStyle const &style);
260 
261  void _openParagraph();
262  void _closeParagraph();
263  void _appendParagraphProperties(librevenge::RVNGPropertyList &propList, const bool isListElement=false);
264  void _resetParagraphState(const bool isListElement=false);
265 
267  void _openListElement();
269  void _closeListElement();
271  void _changeList();
276  int _getListId() const;
277 
279  void _openSpan();
281  void _closeSpan();
282 
284  void _flushText();
286  void _flushDeferredTabs();
287 
288  void _insertBreakIfNecessary(librevenge::RVNGPropertyList &propList);
289 
293  std::shared_ptr<STOFFTextListenerInternal::State> _pushParsingState();
295  void _popParsingState();
296 
297 protected:
299  std::shared_ptr<STOFFTextListenerInternal::TextState> m_ds;
301  std::shared_ptr<STOFFTextListenerInternal::State> m_ps;
303  std::vector<std::shared_ptr<STOFFTextListenerInternal::State> > m_psStack;
305  librevenge::RVNGTextInterface *m_documentInterface;
306 
307 private:
309  STOFFTextListener &operator=(const STOFFTextListener &);
310 };
311 
312 #endif
313 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
void insertEquation(STOFFFrameStyle const &frame, librevenge::RVNGString const &equation, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final
adds a equation given a position
Definition: STOFFTextListener.cxx:1249
void _closePageSpan()
does close a page (low level)
Definition: STOFFTextListener.cxx:622
void _closeSection()
does close a section (low level)
Definition: STOFFTextListener.cxx:779
std::shared_ptr< STOFFTextListenerInternal::TextState > m_ds
the actual global state
Definition: STOFFTextListener.hxx:299
void handleSubDocument(STOFFSubDocumentPtr subDocument, libstoff::SubDocumentType subDocumentType) final
function called to add a subdocument and modify the origin
Definition: STOFFTextListener.cxx:1420
void insertChar(uint8_t character) final
adds a basic character, ..
Definition: STOFFTextListener.cxx:290
int _getListId() const
low level: find a list id which corresponds to actual list and a change of level.
Definition: STOFFTextListener.cxx:918
void _openSpan()
low level: the function which opens a new span property
Definition: STOFFTextListener.cxx:993
void _closeParagraph()
Definition: STOFFTextListener.cxx:827
Definition: STOFFDocument.hxx:42
bool canWriteText() const final
returns true if a text zone is opened
Definition: STOFFTextListener.hxx:84
bool openFooter(librevenge::RVNGPropertyList const &extras) final
open a footer (interaction with STOFFPageSpan which fills the parameters for openFooter)
Definition: STOFFTextListener.cxx:677
a structure used to define a cell and its format
Definition: STOFFCell.hxx:53
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: STOFFTextListener.cxx:1569
bool insertHeaderRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which) final
insert a header
Definition: STOFFTextListener.cxx:654
Class to store a frame style.
Definition: STOFFFrameStyle.hxx:45
Type
the listener type
Definition: STOFFListener.hxx:57
void insertTab() final
adds a tab
Definition: STOFFTextListener.cxx:340
bool isSectionOpened() const final
returns true if a section is opened
Definition: STOFFTextListener.cxx:715
void openLink(STOFFLink const &link) final
open a link
Definition: STOFFTextListener.cxx:467
void insertPicture(STOFFFrameStyle const &frame, STOFFEmbeddedObject const &picture, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final
adds a picture with potential various representationin given position
Definition: STOFFTextListener.cxx:1239
void _changeList()
update the list so that it corresponds to the actual level
Definition: STOFFTextListener.cxx:934
bool openSection(STOFFSection const &section) final
open a section if possible
Definition: STOFFTextListener.cxx:730
bool canOpenSectionAddBreak() const final
returns true if we can add open a section, add page break, ...
Definition: STOFFTextListener.cxx:725
STOFFSection const & getSection() const final
returns the actual section
Definition: STOFFTextListener.cxx:720
bool closeFooter() final
close a footer
Definition: STOFFTextListener.cxx:701
void startDocument() final
starts a new document
Definition: STOFFTextListener.cxx:517
bool isPageSpanOpened() const final
returns true if a page is opened
Definition: STOFFTextListener.cxx:561
std::vector< std::shared_ptr< STOFFTextListenerInternal::State > > m_psStack
stack of local state
Definition: STOFFTextListener.hxx:303
void setFont(STOFFFont const &font) final
sets the font
Definition: STOFFTextListener.cxx:420
void _flushDeferredTabs()
low level: flush the deferred tabs
Definition: STOFFTextListener.cxx:1031
a class used to recreate the table structure using cell informations, ....
Definition: STOFFTable.hxx:51
void insertUnicodeString(librevenge::RVNGString const &str) final
adds a unicode string
Definition: STOFFTextListener.cxx:318
void setDocumentMetaData(const librevenge::RVNGPropertyList &list) final
sets the document meta data
Definition: STOFFTextListener.cxx:499
void defineStyle(STOFFFont const &style) final
defines a font styles
Definition: STOFFTextListener.cxx:246
void insertBreak(BreakType breakType) final
inserts a break type: ColumBreak, PageBreak, ..
Definition: STOFFTextListener.cxx:351
void insertField(STOFFField const &field) final
adds a field type
Definition: STOFFTextListener.cxx:457
STOFFParagraph const & getParagraph() const final
returns the actual paragraph
Definition: STOFFTextListener.cxx:449
void _closeSpan()
low level: the function which closes the last opened span property
Definition: STOFFTextListener.cxx:1017
void endDocument(bool sendDelayedSubDoc=true) final
ends the actual document
Definition: STOFFTextListener.cxx:530
void closeTableRow() final
closes this row
Definition: STOFFTextListener.cxx:1590
a note
Definition: libstaroffice_internal.hxx:389
Type getType() const final
returns the listener type
Definition: STOFFTextListener.hxx:68
void _handleFrameParameters(librevenge::RVNGPropertyList &propList, STOFFFrameStyle const &frame, STOFFGraphicStyle const &style)
adds in propList the frame parameters.
Definition: STOFFTextListener.cxx:1409
bool openFrame(STOFFFrameStyle const &frame, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final
store the position and the style (which will be needed further to insert a textbox or a table with op...
Definition: STOFFTextListener.cxx:1268
bool openHeader(librevenge::RVNGPropertyList const &extras) final
open a header (interaction with STOFFPageSpan which fills the parameters for openHeader)
Definition: STOFFTextListener.cxx:642
class to store the paragraph properties
Definition: STOFFParagraph.hxx:47
void setParagraph(STOFFParagraph const &paragraph) final
sets the paragraph
Definition: STOFFTextListener.cxx:438
bool openMasterPage(STOFFPageSpan &)
opens a master page
std::shared_ptr< STOFFSubDocument > STOFFSubDocumentPtr
a smart pointer of STOFFSubDocument
Definition: libstaroffice_internal.hxx:495
Definition: STOFFListener.hxx:57
void _popParsingState()
resets the previous parsing state
Definition: STOFFTextListener.cxx:1683
void _openPageSpan(bool sendHeaderFooters=true)
does open a new page (low level)
Definition: STOFFTextListener.cxx:574
void closeFrame() final
close a frame
Definition: STOFFTextListener.cxx:1337
bool isHeaderFooterOpened() const final
returns true if the header/footer is open
Definition: STOFFTextListener.cxx:637
void _flushText()
low level: flush the deferred text
Definition: STOFFTextListener.cxx:1039
librevenge::RVNGTextInterface * m_documentInterface
the document interface
Definition: STOFFTextListener.hxx:305
void insertNote(STOFFNote const &note, STOFFSubDocumentPtr &subDocument) final
insert a note
Definition: STOFFTextListener.cxx:1070
SubDocumentType
Definition: libstaroffice_internal.hxx:185
a class which stores section properties
Definition: STOFFSection.hxx:45
void openTableCell(STOFFCell const &cell) final
open a cell
Definition: STOFFTextListener.cxx:1635
void closeLayer()
close a layer
bool isDocumentStarted() const final
returns true if a document is opened
Definition: STOFFTextListener.cxx:512
a field
Definition: libstaroffice_internal.hxx:363
void insertShape(STOFFFrameStyle const &frame, STOFFGraphicShape const &shape, STOFFGraphicStyle const &style) final
adds a shape picture in given position
Definition: STOFFTextListener.cxx:1169
void insertEOL(bool softBreak=false) final
adds an end of line ( by default an hard one)
Definition: STOFFTextListener.cxx:325
a structure used to define a picture shape
Definition: STOFFGraphicShape.hxx:45
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libstaroffice_internal.cxx:50
small class use to define a embedded object
Definition: libstaroffice_internal.hxx:408
~STOFFTextListener() final
destructor
Definition: STOFFTextListener.cxx:242
void _closeListElement()
close a list level
Definition: STOFFTextListener.cxx:902
void addCoveredTableCell(STOFFVec2i const &pos) final
add covered cell
Definition: STOFFTextListener.cxx:1600
STOFFFont const & getFont() const final
returns the actual font
Definition: STOFFTextListener.cxx:428
bool isSubDocumentOpened(libstoff::SubDocumentType &subdocType) const final
returns try if a subdocument is open
Definition: STOFFTextListener.cxx:1503
void _openSection()
does open a section (low level)
Definition: STOFFTextListener.cxx:761
bool closeHeader() final
close a header
Definition: STOFFTextListener.cxx:666
This class contains the code needed to create Text document.
Definition: STOFFTextListener.hxx:59
void _openListElement()
open a list level
Definition: STOFFTextListener.cxx:872
void closeTableCell() final
close a cell
Definition: STOFFTextListener.cxx:1652
bool isParagraphOpened() const final
returns true if a paragraph or a list is opened
Definition: STOFFTextListener.cxx:433
void openTable(STOFFTable const &table) final
open a table (using the last parameters of openFrame for the position )
Definition: STOFFTextListener.cxx:1531
void closeGroup() final
close a group
Definition: STOFFTextListener.cxx:1397
bool closeSection() final
close a section
Definition: STOFFTextListener.cxx:746
void closeMasterPage()
close a master page
Definition: STOFFTextListener.hxx:113
Class to store font.
Definition: STOFFFont.hxx:43
void _insertBreakIfNecessary(librevenge::RVNGPropertyList &propList)
Definition: STOFFTextListener.cxx:399
bool insertFooterRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which) final
insert a footer
Definition: STOFFTextListener.cxx:689
std::shared_ptr< STOFFTextListenerInternal::State > m_ps
the actual local parse state
Definition: STOFFTextListener.hxx:301
void setDocumentLanguage(std::string locale) final
sets the documents language
Definition: STOFFTextListener.cxx:506
bool openGroup(STOFFFrameStyle const &frame) final
open a group
Definition: STOFFTextListener.cxx:1347
void _resetParagraphState(const bool isListElement=false)
Definition: STOFFTextListener.cxx:851
std::shared_ptr< STOFFTextListenerInternal::State > _pushParsingState()
creates a new parsing state (copy of the actual state)
Definition: STOFFTextListener.cxx:1672
A class which defines the page properties.
Definition: STOFFPageSpan.hxx:75
BreakType
the different break type
Definition: STOFFListener.hxx:59
void addEmptyTableCell(STOFFVec2i const &pos, STOFFVec2i span=STOFFVec2i(1, 1)) final
add empty cell
Definition: STOFFTextListener.cxx:1616
void _startSubDocument()
Definition: STOFFTextListener.cxx:1511
STOFFPageSpan const & getPageSpan() final
returns the current page span
Definition: STOFFTextListener.cxx:566
bool openLayer(librevenge::RVNGString const &name)
open a layer
bool isFontStyleDefined(librevenge::RVNGString const &name) const final
check if a font style with a display name is already defined
Definition: STOFFTextListener.cxx:272
void _openParagraph()
Definition: STOFFTextListener.cxx:799
void closeLink() final
close a link
Definition: STOFFTextListener.cxx:485
Internal and low level namespace to define the states of STOFFTextListener.
Definition: STOFFTextListener.cxx:69
std::shared_ptr< STOFFListManager > STOFFListManagerPtr
a smart pointer of STOFFListManager
Definition: libstaroffice_internal.hxx:489
bool isParagraphStyleDefined(librevenge::RVNGString const &name) const final
check if a paragraph style with a display name is already defined
Definition: STOFFTextListener.cxx:282
bool isGraphicStyleDefined(librevenge::RVNGString const &name) const final
check if a graphic style with a display name is already defined
Definition: STOFFTextListener.cxx:277
void closeTable() final
closes this table
Definition: STOFFTextListener.cxx:1555
void insertTextBox(STOFFFrameStyle const &pos, STOFFSubDocumentPtr subDocument, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final
adds a textbox in given position
Definition: STOFFTextListener.cxx:1154
void insertUnicode(uint32_t character) final
insert a character using the font converter to find the utf8 character
Definition: STOFFTextListener.cxx:301
This class contains a virtual interface to all listener.
Definition: STOFFListener.hxx:50
STOFFTextListener(STOFFListManagerPtr &listManager, std::vector< STOFFPageSpan > const &pageList, librevenge::RVNGTextInterface *documentInterface)
constructor
Definition: STOFFTextListener.cxx:233
Class to store a graphic style.
Definition: STOFFGraphicStyle.hxx:44
void _appendParagraphProperties(librevenge::RVNGPropertyList &propList, const bool isListElement=false)
Definition: STOFFTextListener.cxx:859
void _endSubDocument()
Definition: STOFFTextListener.cxx:1517
void insertComment(STOFFSubDocumentPtr &subDocument, librevenge::RVNGString const &creator="", librevenge::RVNGString const &date="") final
adds comment
Definition: STOFFTextListener.cxx:1127

Generated on Sun Mar 24 2019 23:33:12 for libstaroffice by doxygen 1.8.15