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
48
50{
51struct GraphicState;
52struct State;
53}
54
60{
61public:
63 MWAWGraphicListener(MWAWParserState &parserState, std::vector<MWAWPageSpan> const &pageList, librevenge::RVNGDrawingInterface *documentInterface);
67 MWAWGraphicListener(MWAWParserState &parserState, MWAWBox2f const &box, librevenge::RVNGDrawingInterface *documentInterface);
70
72 Type getType() const final
73 {
74 return Graphic;
75 }
76
78 void setDocumentMetaData(librevenge::RVNGPropertyList const &metadata) final;
80 void setDocumentLanguage(std::string const &locale) final;
82 void startDocument() final;
84 void endDocument(bool delayed=true) final;
85
86 // ------ general information --------
88 bool canWriteText() const final;
90 bool isDocumentStarted() const final;
91
93 void handleSubDocument(MWAWVec2f const &orig, MWAWSubDocumentPtr const &subDocument, libmwaw::SubDocumentType subDocumentType);
95 void handleSubDocument(MWAWSubDocumentPtr const &subDocument, libmwaw::SubDocumentType subDocumentType) final
96 {
97 handleSubDocument(MWAWVec2f(0,0), subDocument, subDocumentType);
98 }
100 bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const final;
102 bool openFrame(MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final;
104 void closeFrame() final;
106 bool openGroup(MWAWPosition const &pos) final;
108 void closeGroup() final;
110 bool openLayer(librevenge::RVNGString const &name);
112 void closeLayer();
113
114 // ------ page --------
116 bool openMasterPage(MWAWPageSpan const &masterPage);
119 {
120 _closePageSpan(true);
121 }
123 bool isPageSpanOpened() const final;
127 MWAWPageSpan const &getPageSpan() final;
128
129 // ------ header/footer --------
131 bool insertHeader(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final;
133 bool insertFooter(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final;
135 bool isHeaderFooterOpened() const final;
136
137 // ------ text data -----------
139 void insertChar(uint8_t character) final;
142 void insertCharacter(unsigned char c) final;
148 int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1) final;
151 void insertUnicode(uint32_t character) final;
153 void insertUnicodeString(librevenge::RVNGString const &str) final;
154
156 void insertTab() final;
158 void insertEOL(bool softBreak=false) final;
159
160 // ------ text format -----------
162 void setFont(MWAWFont const &font) final;
164 MWAWFont const &getFont() const final;
165
166 // ------ paragraph format -----------
168 bool isParagraphOpened() const final;
170 void setParagraph(MWAWParagraph const &paragraph) final;
172 MWAWParagraph const &getParagraph() const final;
173
174 // ------- fields ----------------
176 void insertField(MWAWField const &field) final;
177
178 // ------- link ----------------
180 void openLink(MWAWLink const &link) final;
182 void closeLink() final;
183
184 // ------- subdocument -----------------
186 void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture,
187 MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final;
189 void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape, MWAWGraphicStyle const &style) final;
191 void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr const &subDocument, MWAWGraphicStyle const &style) final;
193 void insertGroup(MWAWBox2f const &bdbox, MWAWSubDocumentPtr const &subDocument);
197 void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument) final;
201 void insertComment(MWAWSubDocumentPtr &subDocument) final;
202
203 // ------- table -----------------
204
206 void insertTable(MWAWPosition const &pos, MWAWTable &table, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle());
208 void openTable(MWAWTable const &table) final;
210 void openTable(MWAWPosition const &pos, MWAWTable const &table, MWAWGraphicStyle const &style);
212 void closeTable() final;
214 void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false) final;
216 void closeTableRow() final;
218 void openTableCell(MWAWCell const &cell) final;
220 void closeTableCell() final;
222 void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1,1)) final;
223
224 // ------- section ---------------
225
227 bool canOpenSectionAddBreak() const final
228 {
229 return false;
230 }
232 bool isSectionOpened() const final
233 {
234 return false;
235 }
237 MWAWSection const &getSection() const final;
239 bool openSection(MWAWSection const &section) final;
241 bool closeSection() final
242 {
243 return false;
244 }
246 void insertBreak(BreakType breakType) final;
247
248protected:
250 void _openPageSpan(bool sendHeaderFooters=true);
252 void _closePageSpan(bool masterPage=false);
253
254 void _startSubDocument();
255 void _endSubDocument();
256
260 void _handleFrameParameters(librevenge::RVNGPropertyList &propList, MWAWPosition const &pos, MWAWGraphicStyle const &style);
261
262 void _openParagraph();
263 void _closeParagraph();
264 void _resetParagraphState(const bool isListElement=false);
265
267 void _openListElement();
269 void _closeListElement();
271 void _changeList();
276 int _getListId() const;
277
278 void _openSpan();
279 void _closeSpan();
280
281 void _flushText();
282
286 std::shared_ptr<MWAWGraphicListenerInternal::State> _pushParsingState();
288 void _popParsingState();
289
290protected:
292 std::shared_ptr<MWAWGraphicListenerInternal::GraphicState> m_ds;
294 std::shared_ptr<MWAWGraphicListenerInternal::State> m_ps;
296 std::vector<std::shared_ptr<MWAWGraphicListenerInternal::State> > m_psStack;
300 librevenge::RVNGDrawingInterface *m_documentInterface;
301
302private:
305};
306
307#endif
308// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
a structure used to define a cell and its format
Definition: MWAWCell.hxx:53
Class to store font.
Definition: MWAWFont.hxx:44
This class contains the code needed to create Graphic document.
Definition: MWAWGraphicListener.hxx:60
bool canOpenSectionAddBreak() const final
returns true if we can add open a section, add page break, ...
Definition: MWAWGraphicListener.hxx:227
bool openSection(MWAWSection const &section) final
open a section if possible
Definition: MWAWGraphicListener.cxx:959
bool openFrame(MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final
store the position and the style (which will be needed further to insert a textbox or a table with op...
Definition: MWAWGraphicListener.cxx:1336
bool isHeaderFooterOpened() const final
returns true if the header/footer is open
Definition: MWAWGraphicListener.cxx:900
std::shared_ptr< MWAWGraphicListenerInternal::State > _pushParsingState()
creates a new parsing state (copy of the actual state)
Definition: MWAWGraphicListener.cxx:1703
void insertTab() final
adds a tab
Definition: MWAWGraphicListener.cxx:353
void startDocument() final
starts a new document
Definition: MWAWGraphicListener.cxx:471
void _handleFrameParameters(librevenge::RVNGPropertyList &propList, MWAWPosition const &pos, MWAWGraphicStyle const &style)
adds in propList the frame parameters.
Definition: MWAWGraphicListener.cxx:1441
bool isParagraphOpened() const final
returns true if a paragraph or a list is opened
Definition: MWAWGraphicListener.cxx:392
void closeLink() final
close a link
Definition: MWAWGraphicListener.cxx:457
bool insertFooter(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final
insert a footer
Definition: MWAWGraphicListener.cxx:926
MWAWGraphicListener & operator=(const MWAWGraphicListener &)=delete
void _startSubDocument()
Definition: MWAWGraphicListener.cxx:1679
void handleSubDocument(MWAWVec2f const &orig, MWAWSubDocumentPtr const &subDocument, libmwaw::SubDocumentType subDocumentType)
function called to add a subdocument and modify the origin
Definition: MWAWGraphicListener.cxx:1614
void closeLayer()
close a layer
Definition: MWAWGraphicListener.cxx:1430
bool insertHeader(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final
insert a header
Definition: MWAWGraphicListener.cxx:905
void closeTableCell() final
close a cell
Definition: MWAWGraphicListener.cxx:1318
void _openSpan()
Definition: MWAWGraphicListener.cxx:821
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: MWAWGraphicListener.cxx:1251
void insertEOL(bool softBreak=false) final
adds an end of line ( by default an hard one)
Definition: MWAWGraphicListener.cxx:334
bool isDocumentStarted() const final
returns true if a document is opened
Definition: MWAWGraphicListener.cxx:515
bool isSectionOpened() const final
returns true if a section is opened
Definition: MWAWGraphicListener.hxx:232
void insertUnicode(uint32_t character) final
adds an unicode character.
Definition: MWAWGraphicListener.cxx:311
void _openListElement()
open a list level
Definition: MWAWGraphicListener.cxx:705
MWAWPageSpan const & getPageSpan() final
returns the current page span
Definition: MWAWGraphicListener.cxx:533
void closeGroup() final
close a group
Definition: MWAWGraphicListener.cxx:1392
MWAWSection const & getSection() const final
returns the actual section
Definition: MWAWGraphicListener.cxx:953
void _endSubDocument()
Definition: MWAWGraphicListener.cxx:1685
bool isPageSpanOpened() const final
returns true if a page is opened
Definition: MWAWGraphicListener.cxx:528
void insertGroup(MWAWBox2f const &bdbox, MWAWSubDocumentPtr const &subDocument)
adds a group: ie.
Definition: MWAWGraphicListener.cxx:1157
void closeMasterPage()
close a master page
Definition: MWAWGraphicListener.hxx:118
void closeTable() final
closes this table
Definition: MWAWGraphicListener.cxx:1237
void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr const &subDocument, MWAWGraphicStyle const &style) final
adds a textbox in given position
Definition: MWAWGraphicListener.cxx:1114
void openTableCell(MWAWCell const &cell) final
open a cell
Definition: MWAWGraphicListener.cxx:1301
bool openLayer(librevenge::RVNGString const &name)
open a layer
Definition: MWAWGraphicListener.cxx:1403
MWAWParserState & m_parserState
the parser state
Definition: MWAWGraphicListener.hxx:298
void openLink(MWAWLink const &link) final
open a link
Definition: MWAWGraphicListener.cxx:437
void setDocumentMetaData(librevenge::RVNGPropertyList const &metadata) final
sets the documents metadata
Definition: MWAWGraphicListener.cxx:502
bool closeSection() final
close a section
Definition: MWAWGraphicListener.hxx:241
void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final
adds a picture with potential various representationin given position
Definition: MWAWGraphicListener.cxx:1079
void insertField(MWAWField const &field) final
adds a field type
Definition: MWAWGraphicListener.cxx:416
void _closePageSpan(bool masterPage=false)
does close a page (low level)
Definition: MWAWGraphicListener.cxx:614
MWAWParagraph const & getParagraph() const final
returns the actual paragraph
Definition: MWAWGraphicListener.cxx:408
void insertCharacter(unsigned char c) final
insert a character using the font converter to find the utf8 character
Definition: MWAWGraphicListener.cxx:257
void insertBreak(BreakType breakType) final
inserts a break type: ColumBreak, PageBreak, ..
Definition: MWAWGraphicListener.cxx:965
void _closeListElement()
close a list level
Definition: MWAWGraphicListener.cxx:731
bool openGroup(MWAWPosition const &pos) final
open a group
Definition: MWAWGraphicListener.cxx:1367
librevenge::RVNGDrawingInterface * m_documentInterface
the document interface
Definition: MWAWGraphicListener.hxx:300
bool openMasterPage(MWAWPageSpan const &masterPage)
opens a master page
Definition: MWAWGraphicListener.cxx:540
void openTable(MWAWTable const &table) final
open a table (using the last parameters of openFrame for the position )
Definition: MWAWGraphicListener.cxx:1197
void _openPageSpan(bool sendHeaderFooters=true)
does open a new page (low level)
Definition: MWAWGraphicListener.cxx:563
void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument) final
insert a note
Definition: MWAWGraphicListener.cxx:1012
void closeTableRow() final
closes this row
Definition: MWAWGraphicListener.cxx:1272
void _resetParagraphState(const bool isListElement=false)
Definition: MWAWGraphicListener.cxx:696
~MWAWGraphicListener() final
destructor
Definition: MWAWGraphicListener.cxx:236
void setParagraph(MWAWParagraph const &paragraph) final
sets the paragraph
Definition: MWAWGraphicListener.cxx:397
void insertComment(MWAWSubDocumentPtr &subDocument) final
adds comment
Definition: MWAWGraphicListener.cxx:994
bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const final
returns try if a subdocument is open
Definition: MWAWGraphicListener.cxx:1671
int _getListId() const
low level: find a list id which corresponds to actual list and a change of level.
Definition: MWAWGraphicListener.cxx:744
void _flushText()
Definition: MWAWGraphicListener.cxx:869
void _popParsingState()
resets the previous parsing state
Definition: MWAWGraphicListener.cxx:1711
void _closeParagraph()
Definition: MWAWGraphicListener.cxx:674
void endDocument(bool delayed=true) final
ends the actual document
Definition: MWAWGraphicListener.cxx:482
MWAWGraphicListener(const MWAWGraphicListener &)=delete
void _changeList()
update the list so that it corresponds to the actual level
Definition: MWAWGraphicListener.cxx:760
bool canWriteText() const final
returns true if a text zone is opened
Definition: MWAWGraphicListener.cxx:520
void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1, 1)) final
add empty cell
Definition: MWAWGraphicListener.cxx:1282
void _closeSpan()
Definition: MWAWGraphicListener.cxx:850
void closeFrame() final
close a frame
Definition: MWAWGraphicListener.cxx:1358
std::vector< std::shared_ptr< MWAWGraphicListenerInternal::State > > m_psStack
stack of local state
Definition: MWAWGraphicListener.hxx:296
std::shared_ptr< MWAWGraphicListenerInternal::GraphicState > m_ds
the actual global state
Definition: MWAWGraphicListener.hxx:292
void insertTable(MWAWPosition const &pos, MWAWTable &table, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle())
adds a table in given position
Definition: MWAWGraphicListener.cxx:1172
MWAWFont const & getFont() const final
returns the actual font
Definition: MWAWGraphicListener.cxx:387
void setFont(MWAWFont const &font) final
sets the font
Definition: MWAWGraphicListener.cxx:367
Type getType() const final
returns the listener type
Definition: MWAWGraphicListener.hxx:72
void _openParagraph()
Definition: MWAWGraphicListener.cxx:653
void setDocumentLanguage(std::string const &locale) final
sets the documents language
Definition: MWAWGraphicListener.cxx:509
void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape, MWAWGraphicStyle const &style) final
adds a shape picture in given position
Definition: MWAWGraphicListener.cxx:1035
std::shared_ptr< MWAWGraphicListenerInternal::State > m_ps
the actual local parse state
Definition: MWAWGraphicListener.hxx:294
void insertUnicodeString(librevenge::RVNGString const &str) final
adds a unicode string
Definition: MWAWGraphicListener.cxx:324
void insertChar(uint8_t character) final
adds a basic character, ..
Definition: MWAWGraphicListener.cxx:243
a structure used to define a picture shape
Definition: MWAWGraphicShape.hxx:46
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:48
static MWAWGraphicStyle emptyStyle()
returns an empty style.
Definition: MWAWGraphicStyle.hxx:477
This class contains a virtual interface to all listener.
Definition: MWAWListener.hxx:50
Type
the listener type
Definition: MWAWListener.hxx:56
@ Graphic
Definition: MWAWListener.hxx:56
BreakType
the different break type
Definition: MWAWListener.hxx:58
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:99
class to store the paragraph properties
Definition: MWAWParagraph.hxx:85
a class to define the parser state
Definition: MWAWParser.hxx:50
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
a class which stores section properties
Definition: MWAWSection.hxx:46
a class used to recreate the table structure using cell informations, ....
Definition: MWAWTable.hxx:52
std::shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:565
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:842
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
Internal and low level namespace to define the states of MWAWGraphicListener.
Definition: MWAWGraphicListener.cxx:63
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libmwaw_internal.cxx:51
SubDocumentType
Definition: libmwaw_internal.hxx:188
Definition: MWAWDocument.hxx:57
small class use to define a embedded object
Definition: libmwaw_internal.hxx:467
a field
Definition: libmwaw_internal.hxx:399
a note
Definition: libmwaw_internal.hxx:445

Generated on Wed May 3 2023 07:18:29 for libmwaw by doxygen 1.9.6