MWAWGraphicListener.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_GRAPHIC_LISTENER_H
35 #define MWAW_GRAPHIC_LISTENER_H
36 
37 #include <vector>
38 
39 #include <librevenge/librevenge.h>
40 
41 #include "libmwaw_internal.hxx"
42 
43 #include "MWAWGraphicStyle.hxx"
44 
45 #include "MWAWListener.hxx"
46 
47 class MWAWGraphicShape;
48 
50 {
51 struct GraphicState;
52 struct State;
53 }
54 
60 {
61 public:
63  MWAWGraphicListener(MWAWParserState &parserState, std::vector<MWAWPageSpan> const &pageList, librevenge::RVNGDrawingInterface *documentInterface);
67  MWAWGraphicListener(MWAWParserState &parserState, MWAWBox2f const &box, librevenge::RVNGDrawingInterface *documentInterface);
69  virtual ~MWAWGraphicListener();
70 
72  Type getType() const
73  {
74  return Graphic;
75  }
76 
78  void setDocumentLanguage(std::string locale);
80  void startDocument();
82  void endDocument(bool delayed=true);
83 
84  // ------ general information --------
86  bool canWriteText() const;
88  bool isDocumentStarted() const;
89 
91  void handleSubDocument(MWAWVec2f const &orig, MWAWSubDocumentPtr subDocument, libmwaw::SubDocumentType subDocumentType);
94  {
95  handleSubDocument(MWAWVec2f(0,0), subDocument, subDocumentType);
96  }
98  bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const;
100  bool openFrame(MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle());
102  void closeFrame();
104  bool openGroup(MWAWPosition const &pos);
106  void closeGroup();
108  bool openLayer(librevenge::RVNGString const &name);
110  void closeLayer();
111 
112  // ------ page --------
114  bool openMasterPage(MWAWPageSpan &masterPage);
117  {
118  _closePageSpan(true);
119  }
121  bool isPageSpanOpened() const;
125  MWAWPageSpan const &getPageSpan();
126 
127  // ------ header/footer --------
129  bool insertHeader(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras);
131  bool insertFooter(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras);
133  bool isHeaderFooterOpened() const;
134 
135  // ------ text data -----------
137  void insertChar(uint8_t character);
140  void insertCharacter(unsigned char c);
146  int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1);
149  void insertUnicode(uint32_t character);
151  void insertUnicodeString(librevenge::RVNGString const &str);
152 
154  void insertTab();
156  void insertEOL(bool softBreak=false);
157 
158  // ------ text format -----------
160  void setFont(MWAWFont const &font);
162  MWAWFont const &getFont() const;
163 
164  // ------ paragraph format -----------
166  bool isParagraphOpened() const;
168  void setParagraph(MWAWParagraph const &paragraph);
170  MWAWParagraph const &getParagraph() const;
171 
172  // ------- fields ----------------
174  void insertField(MWAWField const &field);
175 
176  // ------- link ----------------
178  void openLink(MWAWLink const &link);
180  void closeLink();
181 
182  // ------- subdocument -----------------
184  void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture,
187  void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape, MWAWGraphicStyle const &style);
189  void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr subDocument, MWAWGraphicStyle const &style);
191  void insertGroup(MWAWBox2f const &bdbox, MWAWSubDocumentPtr subDocument);
195  void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument);
199  void insertComment(MWAWSubDocumentPtr &subDocument);
200 
201  // ------- table -----------------
202 
204  void insertTable(MWAWPosition const &pos, MWAWTable &table, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle());
206  void openTable(MWAWTable const &table);
208  void openTable(MWAWPosition const &pos, MWAWTable const &table, MWAWGraphicStyle const &style);
210  void closeTable();
212  void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false);
214  void closeTableRow();
216  void openTableCell(MWAWCell const &cell);
218  void closeTableCell();
220  void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1,1));
221 
222  // ------- section ---------------
223 
226  {
227  return false;
228  }
230  bool isSectionOpened() const
231  {
232  return false;
233  }
235  MWAWSection const &getSection() const;
237  bool openSection(MWAWSection const &section);
240  {
241  return false;
242  }
244  void insertBreak(BreakType breakType);
245 
246 protected:
248  void _openPageSpan(bool sendHeaderFooters=true);
250  void _closePageSpan(bool masterPage=false);
251 
252  void _startSubDocument();
253  void _endSubDocument();
254 
258  void _handleFrameParameters(librevenge::RVNGPropertyList &propList, MWAWPosition const &pos, MWAWGraphicStyle const &style);
259 
260  void _openParagraph();
261  void _closeParagraph();
262  void _resetParagraphState(const bool isListElement=false);
263 
265  void _openListElement();
267  void _closeListElement();
269  void _changeList();
274  int _getListId() const;
275 
276  void _openSpan();
277  void _closeSpan();
278 
279  void _flushText();
280 
284  shared_ptr<MWAWGraphicListenerInternal::State> _pushParsingState();
286  void _popParsingState();
287 
288 protected:
290  shared_ptr<MWAWGraphicListenerInternal::GraphicState> m_ds;
292  shared_ptr<MWAWGraphicListenerInternal::State> m_ps;
294  std::vector<shared_ptr<MWAWGraphicListenerInternal::State> > m_psStack;
298  librevenge::RVNGDrawingInterface *m_documentInterface;
299 
300 private:
302  MWAWGraphicListener &operator=(const MWAWGraphicListener &);
303 };
304 
305 #endif
306 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:95
bool canOpenSectionAddBreak() const
returns true if we can add open a section, add page break, ...
Definition: MWAWGraphicListener.hxx:225
Internal and low level namespace to define the states of MWAWGraphicListener.
Definition: MWAWGraphicListener.cxx:62
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:47
This class contains the code needed to create Graphic document.
Definition: MWAWGraphicListener.hxx:59
SubDocumentType
Definition: libmwaw_internal.hxx:172
a class used to recreate the table structure using cell informations, ....
Definition: MWAWTable.hxx:51
librevenge::RVNGDrawingInterface * m_documentInterface
the document interface
Definition: MWAWGraphicListener.hxx:298
MWAWVec2< int > MWAWVec2i
MWAWVec2 of int.
Definition: libmwaw_internal.hxx:774
Type
the listener type
Definition: MWAWListener.hxx:56
bool closeSection()
close a section
Definition: MWAWGraphicListener.hxx:239
bool isSectionOpened() const
returns true if a section is opened
Definition: MWAWGraphicListener.hxx:230
a structure used to define a cell and its format
Definition: MWAWCell.hxx:52
void handleSubDocument(MWAWSubDocumentPtr subDocument, libmwaw::SubDocumentType subDocumentType)
function called to add a subdocument
Definition: MWAWGraphicListener.hxx:93
shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:510
Type getType() const
returns the listener type
Definition: MWAWGraphicListener.hxx:72
Class to store font.
Definition: MWAWFont.hxx:43
a class to define the parser state
Definition: MWAWParser.hxx:49
BreakType
the different break type
Definition: MWAWListener.hxx:58
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:778
void closeMasterPage()
close a master page
Definition: MWAWGraphicListener.hxx:116
shared_ptr< MWAWGraphicListenerInternal::GraphicState > m_ds
the actual global state
Definition: MWAWGraphicListener.hxx:290
std::vector< shared_ptr< MWAWGraphicListenerInternal::State > > m_psStack
stack of local state
Definition: MWAWGraphicListener.hxx:294
small class use to define a embedded object
Definition: libmwaw_internal.hxx:419
a class which stores section properties
Definition: MWAWSection.hxx:45
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:496
a structure used to define a picture shape
Definition: MWAWGraphicShape.hxx:45
MWAWParserState & m_parserState
the parser state
Definition: MWAWGraphicListener.hxx:296
class to store the paragraph properties
Definition: MWAWParagraph.hxx:81
a field
Definition: libmwaw_internal.hxx:363
a note
Definition: libmwaw_internal.hxx:400
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:49
shared_ptr< MWAWGraphicListenerInternal::State > m_ps
the actual local parse state
Definition: MWAWGraphicListener.hxx:292
static MWAWGraphicStyle emptyStyle()
returns an empty style.
Definition: MWAWGraphicStyle.hxx:269

Generated on Thu Feb 4 2016 07:38:15 for libmwaw by doxygen 1.8.11