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:
void _openParagraph()
Definition: MWAWContentListener.cxx:715
bool isHeaderFooterOpened() const
returns true if the header/footer is open
Definition: MWAWContentListener.cxx:594
bool isParagraphOpened() const
returns true if a paragraph or a list is opened
Definition: MWAWContentListener.cxx:385
void closeTable()
closes this table
Definition: MWAWContentListener.cxx:1543
void _closeListElement()
close a list level
Definition: MWAWContentListener.cxx:818
bool isDocumentStarted() const
returns true if a document is opened
Definition: MWAWContentListener.cxx:472
shared_ptr< MWAWContentListenerInternal::DocumentState > m_ds
the main parse state
Definition: MWAWContentListener.hxx:241
void insertCharacter(unsigned char c)
insert a character using the font converter to find the utf8 character
Definition: MWAWContentListener.cxx:214
MWAWParagraph const & getParagraph() const
returns the actual paragraph
Definition: MWAWContentListener.cxx:397
MWAWPageSpan const & getPageSpan()
returns the current page span
Definition: MWAWContentListener.cxx:528
void insertField(MWAWField const &field)
adds a field type
Definition: MWAWContentListener.cxx:405
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:95
bool isSectionOpened() const
returns true if a section is opened
Definition: MWAWContentListener.cxx:628
bool closeSection()
close a section
Definition: MWAWContentListener.cxx:659
bool openSection(MWAWSection const &section)
open a section if possible
Definition: MWAWContentListener.cxx:643
void handleSubDocument(MWAWSubDocumentPtr subDocument, libmwaw::SubDocumentType subDocumentType)
function called to add a subdocument
Definition: MWAWContentListener.cxx:1419
bool insertHeader(MWAWSubDocumentPtr subDocument, WPXPropertyList const &extras)
insert a header
Definition: MWAWContentListener.cxx:599
void _openSection()
Definition: MWAWContentListener.cxx:674
void openTableRow(float h, WPXUnit unit, bool headerRow=false)
open a row with given height ( if h &lt; 0.0, set min-row-height = -h )
Definition: MWAWContentListener.cxx:1557
void insertUnicode(uint32_t character)
adds an unicode character.
Definition: MWAWContentListener.cxx:256
void insertEOL(bool softBreak=false)
adds an end of line ( by default an hard one)
Definition: MWAWContentListener.cxx:273
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:47
void _flushText()
Definition: MWAWContentListener.cxx:970
SubDocumentType
Definition: libmwaw_internal.hxx:162
void insertComment(MWAWSubDocumentPtr &subDocument)
adds comment
Definition: MWAWContentListener.cxx:1055
a class used to recreate the table structure using cell informations, ....
Definition: MWAWTable.hxx:53
void _insertBreakIfNecessary(WPXPropertyList &propList)
Definition: MWAWContentListener.cxx:345
void startDocument()
starts the document
Definition: MWAWContentListener.cxx:477
int _getListId() const
low level: find a list id which corresponds to actual list and a change of level. ...
Definition: MWAWContentListener.cxx:834
void insertTab()
adds a tab
Definition: MWAWContentListener.cxx:290
virtual ~MWAWContentListener()
destructor
Definition: MWAWContentListener.cxx:196
void _appendParagraphProperties(WPXPropertyList &propList, const bool isListElement=false)
Definition: MWAWContentListener.cxx:773
a structure used to define a cell and its format
Definition: MWAWCell.hxx:50
Vec2< int > Vec2i
Vec2 of int.
Definition: libmwaw_internal.hxx:592
shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:358
WPXDocumentInterface * m_documentInterface
the document interface
Definition: MWAWContentListener.hxx:249
void _handleFrameParameters(WPXPropertyList &propList, MWAWPosition const &pos)
Definition: MWAWContentListener.cxx:1219
bool canOpenSectionAddBreak() const
returns true if we can add open a section, add page break, ...
Definition: MWAWContentListener.cxx:638
shared_ptr< MWAWContentListenerInternal::State > m_ps
the actual local parse state
Definition: MWAWContentListener.hxx:243
bool canWriteText() const
returns true if we can add text data
Definition: MWAWContentListener.hxx:81
void closeTableRow()
closes this row
Definition: MWAWContentListener.cxx:1578
void addEmptyTableCell(Vec2i const &pos, Vec2i span=Vec2i(1, 1))
add empty cell
Definition: MWAWContentListener.cxx:1588
bool isPageSpanOpened() const
returns true if a page is opened
Definition: MWAWContentListener.cxx:523
a class to define the parser state
Definition: MWAWParser.hxx:51
BreakType
the different break type
Definition: MWAWListener.hxx:52
void insertUnicodeString(WPXString const &str)
adds a unicode string
Definition: MWAWContentListener.cxx:266
void endDocument(bool sendDelayedSubDoc=true)
ends the document
Definition: MWAWContentListener.cxx:492
void _openPageSpan(bool sendHeaderFooters=true)
Definition: MWAWContentListener.cxx:536
void insertBreak(BreakType breakType)
inserts a break type: ColumBreak, PageBreak, ..
Definition: MWAWContentListener.cxx:301
bool insertFooter(MWAWSubDocumentPtr subDocument, WPXPropertyList const &extras)
insert a footer
Definition: MWAWContentListener.cxx:612
void _resetParagraphState(const bool isListElement=false)
Definition: MWAWContentListener.cxx:765
void openTableCell(MWAWCell const &cell)
open a cell
Definition: MWAWContentListener.cxx:1607
void _closeSection()
Definition: MWAWContentListener.cxx:695
void _closeParagraph()
Definition: MWAWContentListener.cxx:744
void _openSpan()
Definition: MWAWContentListener.cxx:914
void _closeSpan()
Definition: MWAWContentListener.cxx:938
void _flushDeferredTabs()
Definition: MWAWContentListener.cxx:951
void openTable(MWAWTable const &table, WPXPropertyList tableExtras=WPXPropertyList())
open a table
Definition: MWAWContentListener.cxx:1518
void _openListElement()
open a list level
Definition: MWAWContentListener.cxx:786
void setParagraph(MWAWParagraph const &paragraph)
sets the paragraph
Definition: MWAWContentListener.cxx:390
a class which stores section properties
Definition: MWAWSection.hxx:45
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:348
void setFont(MWAWFont const &font)
sets the font
Definition: MWAWContentListener.cxx:364
a structure used to define a picture shape
Definition: MWAWGraphicShape.hxx:46
void _changeList()
update the list so that it corresponds to the actual level
Definition: MWAWContentListener.cxx:851
void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr subDocument, WPXPropertyList frameExtras=WPXPropertyList(), WPXPropertyList textboxExtras=WPXPropertyList())
adds a textbox in given position
Definition: MWAWContentListener.cxx:1080
MWAWFont const & getFont() const
returns the actual font
Definition: MWAWContentListener.cxx:380
class to store the paragraph properties
Definition: MWAWParagraph.hxx:82
void _endSubDocument()
Definition: MWAWContentListener.cxx:1504
void insertChar(uint8_t character)
adds a basic character, ..
Definition: MWAWContentListener.cxx:203
bool openFrame(MWAWPosition const &pos, WPXPropertyList extras=WPXPropertyList())
Definition: MWAWContentListener.cxx:1152
a field
Definition: libmwaw_internal.hxx:286
void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument)
insert a note
Definition: MWAWContentListener.cxx:1000
void _popParsingState()
resets the previous parsing state
Definition: MWAWContentListener.cxx:1658
bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const
returns try if a subdocument is open
Definition: MWAWContentListener.cxx:1490
MWAWParserState & m_parserState
the parser state
Definition: MWAWContentListener.hxx:247
a note
Definition: libmwaw_internal.hxx:304
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: MWAWPosition.hxx:47
This class contains a virtual interface to all listener.
Definition: MWAWListener.hxx:46
MWAWContentListener & operator=(const MWAWContentListener &)
void _startSubDocument()
Definition: MWAWContentListener.cxx:1498
This class contents the main functions needed to create a Writer Document.
Definition: MWAWContentListener.hxx:57
void _closePageSpan()
Definition: MWAWContentListener.cxx:579
void closeFrame()
Definition: MWAWContentListener.cxx:1208
shared_ptr< MWAWContentListenerInternal::State > _pushParsingState()
creates a new parsing state (copy of the actual state)
Definition: MWAWContentListener.cxx:1644
void insertPicture(MWAWPosition const &pos, const WPXBinaryData &binaryData, std::string type="image/pict", WPXPropertyList frameExtras=WPXPropertyList())
adds a picture in given position
Definition: MWAWContentListener.cxx:1127
std::vector< shared_ptr< MWAWContentListenerInternal::State > > m_psStack
stack of local state
Definition: MWAWContentListener.hxx:245
void closeTableCell()
close a cell
Definition: MWAWContentListener.cxx:1624
void setDocumentLanguage(std::string locale)
sets the documents language
Definition: MWAWContentListener.cxx:466
MWAWSection const & getSection() const
returns the actual section
Definition: MWAWContentListener.cxx:633
MWAWContentListener(MWAWParserState &parserState, std::vector< MWAWPageSpan > const &pageList, WPXDocumentInterface *documentInterface)
constructor
Definition: MWAWContentListener.cxx:190

Generated on Tue Mar 10 2015 17:32:08 for libmwaw by doxygen 1.8.5