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 
60 {
61 public:
63  STOFFTextListener(STOFFListManagerPtr listManager, std::vector<STOFFPageSpan> const &pageList, librevenge::RVNGTextInterface *documentInterface);
65  virtual ~STOFFTextListener();
66 
68  Type getType() const
69  {
70  return Text;
71  }
72 
74  void setDocumentLanguage(std::string locale);
76  void setDocumentMetaData(const librevenge::RVNGPropertyList &list);
78  void startDocument();
80  void endDocument(bool sendDelayedSubDoc=true);
81 
82  // ------ general information --------
84  bool canWriteText() const
85  {
87  }
88 
90  bool isDocumentStarted() const;
91 
93  void handleSubDocument(STOFFSubDocumentPtr subDocument, libstoff::SubDocumentType subDocumentType);
95  bool isSubDocumentOpened(libstoff::SubDocumentType &subdocType) const;
97  bool openFrame(STOFFPosition const &pos, STOFFGraphicStyle const &style=STOFFGraphicStyle());
99  void closeFrame();
101  bool openGroup(STOFFPosition const &pos);
103  void closeGroup();
105  bool openLayer(librevenge::RVNGString const &name);
107  void closeLayer();
108 
109  // ------ page --------
111  bool openMasterPage(STOFFPageSpan &/*masterPage*/);
114  {
115  }
117  bool isPageSpanOpened() const;
121  STOFFPageSpan const &getPageSpan();
122 
123  // ------ header/footer --------
125  bool openHeader(librevenge::RVNGPropertyList const &extras);
127  bool openFooter(librevenge::RVNGPropertyList const &extras);
129  bool closeHeader();
131  bool closeFooter();
133  bool insertHeaderRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which);
135  bool insertFooterRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which);
137  bool isHeaderFooterOpened() const;
138 
139  // ------ text data -----------
141  void insertChar(uint8_t character);
146  void insertUnicode(uint32_t character);
148  void insertUnicodeString(librevenge::RVNGString const &str);
149 
151  void insertTab();
153  void insertEOL(bool softBreak=false);
154 
155  // ------ text format -----------
157  void setFont(STOFFFont const &font);
159  STOFFFont const &getFont() const;
160 
161  // ------ paragraph format -----------
163  bool isParagraphOpened() const;
165  void setParagraph(STOFFParagraph const &paragraph);
167  STOFFParagraph const &getParagraph() const;
168 
169  // ------ style definition -----------
171  void defineStyle(STOFFFont const &style);
173  bool isFontStyleDefined(librevenge::RVNGString const &name) const;
175  void defineStyle(STOFFGraphicStyle const &style);
177  bool isGraphicStyleDefined(librevenge::RVNGString const &name) const;
179  void defineStyle(STOFFParagraph const &style);
181  bool isParagraphStyleDefined(librevenge::RVNGString const &name) const;
182 
183  // ------- fields ----------------
185  void insertField(STOFFField const &field);
186 
187  // ------- link ----------------
189  void openLink(STOFFLink const &link);
191  void closeLink();
192 
193  // ------- subdocument -----------------
195  void insertShape(STOFFGraphicShape const &shape, STOFFGraphicStyle const &style, STOFFPosition const &pos);
197  void insertTextBox(STOFFPosition const &pos, STOFFSubDocumentPtr subDocument, STOFFGraphicStyle const &style=STOFFGraphicStyle());
199  void insertPicture(STOFFPosition const &pos, STOFFEmbeddedObject const &picture,
200  STOFFGraphicStyle const &style=STOFFGraphicStyle());
202  void insertNote(STOFFNote const &note, STOFFSubDocumentPtr &subDocument);
204  void insertComment(STOFFSubDocumentPtr &subDocument, librevenge::RVNGString const &creator="", librevenge::RVNGString const &date="");
205 
206  // ------- table -----------------
207 
209  void insertTable(STOFFPosition const &pos, STOFFTable &table, STOFFGraphicStyle const &style=STOFFGraphicStyle());
211  void openTable(STOFFTable const &table);
213  void openTable(STOFFPosition const &pos, STOFFTable const &table);
215  void closeTable();
217  void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false);
219  void closeTableRow();
221  void openTableCell(STOFFCell const &cell);
223  void closeTableCell();
225  void addEmptyTableCell(STOFFVec2i const &pos, STOFFVec2i span=STOFFVec2i(1,1));
226 
227  // ------- section ---------------
228 
230  bool canOpenSectionAddBreak() const;
232  bool isSectionOpened() const;
234  STOFFSection const &getSection() const;
236  bool openSection(STOFFSection const &section);
238  bool closeSection();
240  void insertBreak(BreakType breakType);
241 
242 protected:
244  void _openSection();
246  void _closeSection();
248  void _openPageSpan(bool sendHeaderFooters=true);
250  void _closePageSpan();
251 
252  void _startSubDocument();
253  void _endSubDocument();
254 
258  void _handleFrameParameters(librevenge::RVNGPropertyList &propList, STOFFPosition const &pos, STOFFGraphicStyle const &style);
259 
260  void _openParagraph();
261  void _closeParagraph();
262  void _appendParagraphProperties(librevenge::RVNGPropertyList &propList, const bool isListElement=false);
263  void _resetParagraphState(const bool isListElement=false);
264 
266  void _openListElement();
268  void _closeListElement();
270  void _changeList();
275  int _getListId() const;
276 
278  void _openSpan();
280  void _closeSpan();
281 
283  void _flushText();
285  void _flushDeferredTabs();
286 
287  void _insertBreakIfNecessary(librevenge::RVNGPropertyList &propList);
288 
292  shared_ptr<STOFFTextListenerInternal::State> _pushParsingState();
294  void _popParsingState();
295 
296 protected:
298  shared_ptr<STOFFTextListenerInternal::TextState> m_ds;
300  shared_ptr<STOFFTextListenerInternal::State> m_ps;
302  std::vector<shared_ptr<STOFFTextListenerInternal::State> > m_psStack;
304  librevenge::RVNGTextInterface *m_documentInterface;
305 
306 private:
308  STOFFTextListener &operator=(const STOFFTextListener &);
309 };
310 
311 #endif
312 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
bool isDocumentStarted() const
returns true if a document is opened
Definition: STOFFTextListener.cxx:478
a structure used to define a cell and its format
Definition: STOFFCell.hxx:53
bool canWriteText() const
returns true if a text zone is opened
Definition: STOFFTextListener.hxx:84
Type
the listener type
Definition: STOFFListener.hxx:57
a class used to recreate the table structure using cell informations, ....
Definition: STOFFTable.hxx:51
a note
Definition: libstaroffice_internal.hxx:379
shared_ptr< STOFFTextListenerInternal::State > m_ps
the actual local parse state
Definition: STOFFTextListener.hxx:300
class to store the paragraph properties
Definition: STOFFParagraph.hxx:47
shared_ptr< STOFFListManager > STOFFListManagerPtr
a smart pointer of STOFFListManager
Definition: libstaroffice_internal.hxx:478
librevenge::RVNGTextInterface * m_documentInterface
the document interface
Definition: STOFFTextListener.hxx:304
SubDocumentType
Definition: libstaroffice_internal.hxx:175
shared_ptr< STOFFSubDocument > STOFFSubDocumentPtr
a smart pointer of STOFFSubDocument
Definition: libstaroffice_internal.hxx:484
a class which stores section properties
Definition: STOFFSection.hxx:45
a field
Definition: libstaroffice_internal.hxx:353
a structure used to define a picture shape
Definition: STOFFGraphicShape.hxx:45
small class use to define a embedded object
Definition: libstaroffice_internal.hxx:398
Type getType() const
returns the listener type
Definition: STOFFTextListener.hxx:68
This class contains the code needed to create Text document.
Definition: STOFFTextListener.hxx:59
STOFFVec2< int > STOFFVec2i
STOFFVec2 of int.
Definition: libstaroffice_internal.hxx:748
void closeMasterPage()
close a master page
Definition: STOFFTextListener.hxx:113
Class to store font.
Definition: STOFFFont.hxx:43
shared_ptr< STOFFTextListenerInternal::TextState > m_ds
the actual global state
Definition: STOFFTextListener.hxx:298
std::vector< shared_ptr< STOFFTextListenerInternal::State > > m_psStack
stack of local state
Definition: STOFFTextListener.hxx:302
A class which defines the page properties.
Definition: STOFFPageSpan.hxx:75
BreakType
the different break type
Definition: STOFFListener.hxx:59
Internal and low level namespace to define the states of STOFFTextListener.
Definition: STOFFTextListener.cxx:68
This class contains a virtual interface to all listener.
Definition: STOFFListener.hxx:50
Class to store a graphic style.
Definition: STOFFGraphicStyle.hxx:44
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: STOFFPosition.hxx:47

Generated on Thu Aug 11 2016 08:37:51 for libstaroffice by doxygen 1.8.11