MWAWContentListener.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 #ifndef MWAW_CONTENT_LISTENER_H
35 #define MWAW_CONTENT_LISTENER_H
36 
37 #include <vector>
38 
39 #include <libwpd/libwpd.h>
40 
41 #include "libmwaw_internal.hxx"
42 
43 #include "MWAWListener.hxx"
44 
45 class MWAWCell;
46 class MWAWGraphicStyle;
47 class MWAWGraphicShape;
48 class MWAWTable;
49 
50 namespace MWAWContentListenerInternal
51 {
52 struct DocumentState;
53 struct State;
54 }
55 
58 {
59 public:
61  MWAWContentListener(MWAWParserState &parserState, std::vector<MWAWPageSpan> const &pageList, WPXDocumentInterface *documentInterface);
63  virtual ~MWAWContentListener();
64 
66  void setDocumentLanguage(std::string locale);
67 
69  void startDocument();
71  void endDocument(bool sendDelayedSubDoc=true);
73  bool isDocumentStarted() const;
74 
76  void handleSubDocument(MWAWSubDocumentPtr subDocument, libmwaw::SubDocumentType subDocumentType);
78  bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const;
79 
81  bool canWriteText() const {
83  }
84 
85  // ------ page --------
87  bool isPageSpanOpened() const;
91  MWAWPageSpan const &getPageSpan();
92 
93  // ------ header/footer --------
95  bool insertHeader(MWAWSubDocumentPtr subDocument, WPXPropertyList const &extras);
97  bool insertFooter(MWAWSubDocumentPtr subDocument, WPXPropertyList const &extras);
99  bool isHeaderFooterOpened() const;
100 
101  // ------ text data -----------
102 
104  void insertChar(uint8_t character);
107  void insertCharacter(unsigned char c);
113  int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1);
116  void insertUnicode(uint32_t character);
118  void insertUnicodeString(WPXString const &str);
119 
121  void insertTab();
123  void insertEOL(bool softBreak=false);
124 
125  // ------ text format -----------
127  void setFont(MWAWFont const &font);
129  MWAWFont const &getFont() const;
130 
131  // ------ paragraph format -----------
133  bool isParagraphOpened() const;
135  void setParagraph(MWAWParagraph const &paragraph);
137  MWAWParagraph const &getParagraph() const;
138 
139  // ------- fields ----------------
141  void insertField(MWAWField const &field);
142 
143  // ------- subdocument -----------------
145  void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument);
146 
148  void insertComment(MWAWSubDocumentPtr &subDocument);
149 
151  void insertPicture(MWAWPosition const &pos, const WPXBinaryData &binaryData,
152  std::string type="image/pict",
153  WPXPropertyList frameExtras=WPXPropertyList());
155  void insertPicture(MWAWPosition const &pos, MWAWGraphicShape const &shape,
156  MWAWGraphicStyle const &style);
158  void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr subDocument,
159  WPXPropertyList frameExtras=WPXPropertyList(),
160  WPXPropertyList textboxExtras=WPXPropertyList());
161 
162  // ------- table -----------------
164  void openTable(MWAWTable const &table, WPXPropertyList tableExtras=WPXPropertyList());
166  void closeTable();
168  void openTableRow(float h, WPXUnit unit, bool headerRow=false);
170  void closeTableRow();
172  void openTableCell(MWAWCell const &cell);
174  void closeTableCell();
176  void addEmptyTableCell(Vec2i const &pos, Vec2i span=Vec2i(1,1));
177 
178  // ------- section ---------------
180  bool canOpenSectionAddBreak() const;
182  bool isSectionOpened() const;
184  MWAWSection const &getSection() const;
186  bool openSection(MWAWSection const &section);
188  bool closeSection();
190  void insertBreak(BreakType breakType);
191 
192 protected:
193  void _openSection();
194  void _closeSection();
195 
196  void _openPageSpan(bool sendHeaderFooters=true);
197  void _closePageSpan();
198 
199  void _startSubDocument();
200  void _endSubDocument();
201 
202  void _handleFrameParameters( WPXPropertyList &propList, MWAWPosition const &pos);
203  bool openFrame(MWAWPosition const &pos, WPXPropertyList extras=WPXPropertyList());
204  void closeFrame();
205 
206 
207  void _openParagraph();
208  void _closeParagraph();
209  void _appendParagraphProperties(WPXPropertyList &propList, const bool isListElement=false);
210  void _resetParagraphState(const bool isListElement=false);
211 
213  void _openListElement();
215  void _closeListElement();
217  void _changeList();
222  int _getListId() const;
223 
224  void _openSpan();
225  void _closeSpan();
226 
227  void _flushText();
228  void _flushDeferredTabs();
229 
230  void _insertBreakIfNecessary(WPXPropertyList &propList);
231 
235  shared_ptr<MWAWContentListenerInternal::State> _pushParsingState();
237  void _popParsingState();
238 
239 protected:
241  shared_ptr<MWAWContentListenerInternal::DocumentState> m_ds;
243  shared_ptr<MWAWContentListenerInternal::State> m_ps;
245  std::vector<shared_ptr<MWAWContentListenerInternal::State> > m_psStack;
249  WPXDocumentInterface *m_documentInterface;
250 
251 private:
254 };
255 
256 #endif
257 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:

Generated on Tue May 6 2014 09:50:48 for libmwaw by doxygen 1.8.3.1