MWAWSpreadsheetListener.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 
40 #ifndef MWAW_SPREADSHEET_LISTENER_H
41 #define MWAW_SPREADSHEET_LISTENER_H
42 
43 #include <vector>
44 
45 #include <librevenge/librevenge.h>
46 
47 #include "libmwaw_internal.hxx"
48 
49 #include "MWAWListener.hxx"
50 
51 class MWAWCell;
52 class MWAWCellContent;
53 class MWAWChart;
54 class MWAWGraphicStyle;
55 class MWAWGraphicShape;
56 class MWAWTable;
57 
59 {
60 struct DocumentState;
61 struct State;
62 }
63 
66 {
67 public:
69  MWAWSpreadsheetListener(MWAWParserState &parserState, std::vector<MWAWPageSpan> const &pageList, librevenge::RVNGSpreadsheetInterface *documentInterface);
73  MWAWSpreadsheetListener(MWAWParserState &parserState, MWAWBox2f const &box, librevenge::RVNGSpreadsheetInterface *documentInterface);
76 
78  Type getType() const final
79  {
80  return Spreadsheet;
81  }
82 
84  void setDocumentMetaData(librevenge::RVNGPropertyList const &metadata) final;
86  void setDocumentLanguage(std::string const &locale) final;
87 
89  void startDocument() final;
91  void endDocument(bool sendDelayedSubDoc=true) final;
93  bool isDocumentStarted() const final;
94 
96  void handleSubDocument(MWAWSubDocumentPtr const &subDocument, libmwaw::SubDocumentType subDocumentType) final;
98  bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const final;
100  bool openFrame(MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final;
102  void closeFrame() final;
104  bool openGroup(MWAWPosition const &pos) final;
106  void closeGroup() final;
107 
109  bool canWriteText() const final;
110 
111  // ------ page --------
113  bool isPageSpanOpened() const final;
117  MWAWPageSpan const &getPageSpan() final;
118 
119  // ------ header/footer --------
121  bool insertHeader(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final;
123  bool insertFooter(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final;
125  bool isHeaderFooterOpened() const final;
126 
127  // ------- sheet -----------------
132  void openSheet(std::vector<float> const &colWidth, librevenge::RVNGUnit unit,
133  std::vector<int> const &repeatColWidthNumber=std::vector<int>(), std::string const &name="");
135  void closeSheet();
137  void openSheetRow(float h, librevenge::RVNGUnit unit, int numRepeated=1);
139  void closeSheetRow();
141  void openSheetCell(MWAWCell const &cell, MWAWCellContent const &content, int numRepeated=1);
143  void closeSheetCell();
144 
145  // ------- chart -----------------
147  void insertChart(MWAWPosition const &pos, MWAWChart &chart,
148  MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle());
149 
150  // ------ text data -----------
151 
153  void insertChar(uint8_t character) final;
156  void insertCharacter(unsigned char c) final;
162  int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1) final;
165  void insertUnicode(uint32_t character) final;
167  void insertUnicodeString(librevenge::RVNGString const &str) final;
168 
170  void insertTab() final;
172  void insertEOL(bool softBreak=false) final;
173 
174  // ------ text format -----------
176  void setFont(MWAWFont const &font) final;
178  MWAWFont const &getFont() const final;
179 
180  // ------ paragraph format -----------
182  bool isParagraphOpened() const final;
184  void setParagraph(MWAWParagraph const &paragraph) final;
186  MWAWParagraph const &getParagraph() const final;
187 
188  // ------- fields ----------------
190  void insertField(MWAWField const &field) final;
191 
192  // ------- link ----------------
194  void openLink(MWAWLink const &link) final;
196  void closeLink() final;
197 
198  // ------- subdocument -----------------
200  void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument) final;
201 
203  void insertComment(MWAWSubDocumentPtr &subDocument) final;
204 
206  void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture,
207  MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final;
209  void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape,
210  MWAWGraphicStyle const &style) final;
212  void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr const &subDocument,
213  MWAWGraphicStyle const &frameStyle=MWAWGraphicStyle::emptyStyle()) final;
214 
215  // ------- table -----------------
217  void insertTable(MWAWPosition const &pos, MWAWTable &table, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle());
219  void openTable(MWAWTable const &table) final;
221  void closeTable() final;
223  void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false) final;
225  void closeTableRow() final;
227  void openTableCell(MWAWCell const &cell) final;
229  void closeTableCell() final;
231  void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1,1)) final;
232 
233  // ------- section ---------------
235  bool canOpenSectionAddBreak() const final
236  {
237  return false;
238  }
240  bool isSectionOpened() const final
241  {
242  return false;
243  }
245  MWAWSection const &getSection() const final;
247  bool openSection(MWAWSection const &section) final;
249  bool closeSection() final;
251  void insertBreak(BreakType breakType) final;
252 
253 protected:
255  void _openPageSpan(bool sendHeaderFooters=true);
257  void _closePageSpan();
258 
259  void _startSubDocument();
260  void _endSubDocument();
261 
262  void _handleFrameParameters(librevenge::RVNGPropertyList &propList, MWAWPosition const &pos);
263 
264  void _openParagraph();
265  void _closeParagraph();
266  void _resetParagraphState(const bool isListElement=false);
267 
269  void _openListElement();
271  void _closeListElement();
273  void _changeList();
278  int _getListId() const;
279 
280  void _openSpan();
281  void _closeSpan();
282 
283  void _flushText();
284  void _flushDeferredTabs();
285 
289  std::shared_ptr<MWAWSpreadsheetListenerInternal::State> _pushParsingState();
291  void _popParsingState();
292 
293 protected:
295  std::shared_ptr<MWAWSpreadsheetListenerInternal::DocumentState> m_ds;
297  std::shared_ptr<MWAWSpreadsheetListenerInternal::State> m_ps;
299  std::vector<std::shared_ptr<MWAWSpreadsheetListenerInternal::State> > m_psStack;
303  librevenge::RVNGSpreadsheetInterface *m_documentInterface;
304 
305 private:
310 };
311 
312 #endif
313 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
void _resetParagraphState(const bool isListElement=false)
Definition: MWAWSpreadsheetListener.cxx:743
void _openListElement()
open a list level
Definition: MWAWSpreadsheetListener.cxx:753
void closeTableCell() final
close a cell
Definition: MWAWSpreadsheetListener.cxx:1984
void _flushText()
Definition: MWAWSpreadsheetListener.cxx:917
void _openPageSpan(bool sendHeaderFooters=true)
does open a new page (low level)
Definition: MWAWSpreadsheetListener.cxx:590
bool openFrame(MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final
tries to open a frame
Definition: MWAWSpreadsheetListener.cxx:1203
void _startSubDocument()
Definition: MWAWSpreadsheetListener.cxx:1602
std::vector< std::shared_ptr< MWAWSpreadsheetListenerInternal::State > > m_psStack
stack of local state
Definition: MWAWSpreadsheetListener.hxx:299
void closeSheetRow()
closes this row
Definition: MWAWSpreadsheetListener.cxx:1696
void closeLink() final
close a link
Definition: MWAWSpreadsheetListener.cxx:499
void closeFrame() final
tries to close a frame
Definition: MWAWSpreadsheetListener.cxx:1275
void _popParsingState()
resets the previous parsing state
Definition: MWAWSpreadsheetListener.cxx:2015
MWAWParagraph const & getParagraph() const final
returns the actual paragraph
Definition: MWAWSpreadsheetListener.cxx:448
void insertUnicode(uint32_t character) final
adds an unicode character.
Definition: MWAWSpreadsheetListener.cxx:340
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:98
void setParagraph(MWAWParagraph const &paragraph) final
sets the paragraph
Definition: MWAWSpreadsheetListener.cxx:441
Definition: MWAWDocument.hxx:56
void openLink(MWAWLink const &link) final
open a link
Definition: MWAWSpreadsheetListener.cxx:479
void _closeSpan()
Definition: MWAWSpreadsheetListener.cxx:883
void openTable(MWAWTable const &table) final
open a table
Definition: MWAWSpreadsheetListener.cxx:1879
void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) final
adds a picture with potential various representationin given position
Definition: MWAWSpreadsheetListener.cxx:1138
librevenge::RVNGSpreadsheetInterface * m_documentInterface
the document interface
Definition: MWAWSpreadsheetListener.hxx:303
std::shared_ptr< MWAWSpreadsheetListenerInternal::State > m_ps
the actual local parse state
Definition: MWAWSpreadsheetListener.hxx:297
std::shared_ptr< MWAWSpreadsheetListenerInternal::State > _pushParsingState()
creates a new parsing state (copy of the actual state)
Definition: MWAWSpreadsheetListener.cxx:2004
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:47
SubDocumentType
Definition: libmwaw_internal.hxx:188
a class used to recreate the table structure using cell informations, ....
Definition: MWAWTable.hxx:51
void handleSubDocument(MWAWSubDocumentPtr const &subDocument, libmwaw::SubDocumentType subDocumentType) final
function called to add a subdocument
Definition: MWAWSpreadsheetListener.cxx:1527
MWAWSection const & getSection() const final
returns the actual section
Definition: MWAWSpreadsheetListener.cxx:682
void insertEOL(bool softBreak=false) final
adds an end of line ( by default an hard one)
Definition: MWAWSpreadsheetListener.cxx:367
void insertComment(MWAWSubDocumentPtr &subDocument) final
adds comment
Definition: MWAWSpreadsheetListener.cxx:1001
bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const final
returns try if a subdocument is open
Definition: MWAWSpreadsheetListener.cxx:1594
void insertUnicodeString(librevenge::RVNGString const &str) final
adds a unicode string
Definition: MWAWSpreadsheetListener.cxx:355
void closeSheet()
closes this sheet
Definition: MWAWSpreadsheetListener.cxx:1662
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libmwaw_internal.cxx:50
bool isDocumentStarted() const final
returns true if a document is opened
Definition: MWAWSpreadsheetListener.cxx:526
bool isSectionOpened() const final
returns true if a section is opened
Definition: MWAWSpreadsheetListener.hxx:240
Type
the listener type
Definition: MWAWListener.hxx:56
a structure used to define a cell and its format
Definition: MWAWCell.hxx:52
bool insertFooter(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final
insert a footer
Definition: MWAWSpreadsheetListener.cxx:666
bool openSection(MWAWSection const &section) final
open a section if possible
Definition: MWAWSpreadsheetListener.cxx:688
small class use to define a sheet cell content
Definition: MWAWCell.hxx:393
void openSheet(std::vector< float > const &colWidth, librevenge::RVNGUnit unit, std::vector< int > const &repeatColWidthNumber=std::vector< int >(), std::string const &name="")
opens a sheet
Definition: MWAWSpreadsheetListener.cxx:1624
bool isParagraphOpened() const final
returns true if a paragraph or a list is opened
Definition: MWAWSpreadsheetListener.cxx:436
void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape, MWAWGraphicStyle const &style) final
adds a shape picture in given position
Definition: MWAWSpreadsheetListener.cxx:1053
bool insertHeader(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras) final
insert a header
Definition: MWAWSpreadsheetListener.cxx:653
void _handleFrameParameters(librevenge::RVNGPropertyList &propList, MWAWPosition const &pos)
Definition: MWAWSpreadsheetListener.cxx:1286
MWAWFont const & getFont() const final
returns the actual font
Definition: MWAWSpreadsheetListener.cxx:431
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
void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr const &subDocument, MWAWGraphicStyle const &frameStyle=MWAWGraphicStyle::emptyStyle()) final
adds a textbox in given position
Definition: MWAWSpreadsheetListener.cxx:1034
void startDocument() final
starts the document
Definition: MWAWSpreadsheetListener.cxx:531
void insertField(MWAWField const &field) final
adds a field type
Definition: MWAWSpreadsheetListener.cxx:456
void closeGroup() final
close a group (not implemented)
Definition: MWAWSpreadsheetListener.cxx:1192
~MWAWSpreadsheetListener() final
destructor
Definition: MWAWSpreadsheetListener.cxx:259
This class contents the main functions needed to create a spreadsheet processing Document.
Definition: MWAWSpreadsheetListener.hxx:65
void insertChar(uint8_t character) final
adds a basic character, ..
Definition: MWAWSpreadsheetListener.cxx:271
void _openParagraph()
Definition: MWAWSpreadsheetListener.cxx:703
void insertChart(MWAWPosition const &pos, MWAWChart &chart, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle())
adds a chart in given position
Definition: MWAWSpreadsheetListener.cxx:1854
void insertTable(MWAWPosition const &pos, MWAWTable &table, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle())
adds a table in given position
Definition: MWAWSpreadsheetListener.cxx:1824
bool canWriteText() const final
returns true if we can add text data
Definition: MWAWSpreadsheetListener.cxx:266
bool closeSection() final
close a section
Definition: MWAWSpreadsheetListener.cxx:694
Type getType() const final
returns the listener type
Definition: MWAWSpreadsheetListener.hxx:78
void _closeParagraph()
Definition: MWAWSpreadsheetListener.cxx:722
void _changeList()
update the list so that it corresponds to the actual level
Definition: MWAWSpreadsheetListener.cxx:804
void closeTable() final
closes this table
Definition: MWAWSpreadsheetListener.cxx:1903
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: MWAWSpreadsheetListener.cxx:1917
small class use to define a embedded object
Definition: libmwaw_internal.hxx:467
void _openSpan()
Definition: MWAWSpreadsheetListener.cxx:862
void setDocumentLanguage(std::string const &locale) final
sets the documents language
Definition: MWAWSpreadsheetListener.cxx:520
MWAWPageSpan const & getPageSpan() final
returns the current page span
Definition: MWAWSpreadsheetListener.cxx:582
a class which stores section properties
Definition: MWAWSection.hxx:45
bool canOpenSectionAddBreak() const final
returns true if we can add open a section, add page break, ...
Definition: MWAWSpreadsheetListener.hxx:235
Definition: MWAWListener.hxx:56
bool openGroup(MWAWPosition const &pos) final
open a group (not implemented)
Definition: MWAWSpreadsheetListener.cxx:1166
void closeSheetCell()
close a cell
Definition: MWAWSpreadsheetListener.cxx:1810
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
void endDocument(bool sendDelayedSubDoc=true) final
ends the document
Definition: MWAWSpreadsheetListener.cxx:544
a structure used to define a picture shape
Definition: MWAWGraphicShape.hxx:45
std::shared_ptr< MWAWSpreadsheetListenerInternal::DocumentState > m_ds
the main parse state
Definition: MWAWSpreadsheetListener.hxx:295
class to store the paragraph properties
Definition: MWAWParagraph.hxx:84
a field
Definition: libmwaw_internal.hxx:399
Internal and low level namespace to define the states of MWAWSpreadsheetListener. ...
Definition: MWAWSpreadsheetListener.cxx:71
MWAWSpreadsheetListener(MWAWParserState &parserState, std::vector< MWAWPageSpan > const &pageList, librevenge::RVNGSpreadsheetInterface *documentInterface)
constructor
Definition: MWAWSpreadsheetListener.cxx:233
void insertTab() final
adds a tab
Definition: MWAWSpreadsheetListener.cxx:390
bool isHeaderFooterOpened() const final
returns true if the header/footer is open
Definition: MWAWSpreadsheetListener.cxx:648
void openSheetCell(MWAWCell const &cell, MWAWCellContent const &content, int numRepeated=1)
open a cell
Definition: MWAWSpreadsheetListener.cxx:1706
a note
Definition: libmwaw_internal.hxx:445
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: MWAWPosition.hxx:47
void setFont(MWAWFont const &font) final
sets the font
Definition: MWAWSpreadsheetListener.cxx:415
This class contains a virtual interface to all listener.
Definition: MWAWListener.hxx:49
void _flushDeferredTabs()
Definition: MWAWSpreadsheetListener.cxx:897
void _endSubDocument()
Definition: MWAWSpreadsheetListener.cxx:1608
std::shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:565
void _closeListElement()
close a list level
Definition: MWAWSpreadsheetListener.cxx:775
void insertCharacter(unsigned char c) final
insert a character using the font converter to find the utf8 character
Definition: MWAWSpreadsheetListener.cxx:286
MWAWParserState & m_parserState
the parser state
Definition: MWAWSpreadsheetListener.hxx:301
void _closePageSpan()
does close a page (low level)
Definition: MWAWSpreadsheetListener.cxx:636
bool isPageSpanOpened() const final
returns true if a page is opened
Definition: MWAWSpreadsheetListener.cxx:577
void closeTableRow() final
closes this row
Definition: MWAWSpreadsheetListener.cxx:1938
void openTableCell(MWAWCell const &cell) final
open a cell
Definition: MWAWSpreadsheetListener.cxx:1967
a class used to store a chart associated to a spreadsheet ....
Definition: MWAWChart.hxx:57
void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1, 1)) final
add empty cell
Definition: MWAWSpreadsheetListener.cxx:1948
int _getListId() const
low level: find a list id which corresponds to actual list and a change of level. ...
Definition: MWAWSpreadsheetListener.cxx:788
void setDocumentMetaData(librevenge::RVNGPropertyList const &metadata) final
sets the documents metadata
Definition: MWAWSpreadsheetListener.cxx:513
void insertBreak(BreakType breakType) final
inserts a break type: ColumBreak, PageBreak, ..
Definition: MWAWSpreadsheetListener.cxx:406
void openSheetRow(float h, librevenge::RVNGUnit unit, int numRepeated=1)
open a row with given height ( if h < 0.0, set min-row-height = -h )
Definition: MWAWSpreadsheetListener.cxx:1675
void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument) final
insert a note
Definition: MWAWSpreadsheetListener.cxx:948

Generated for libmwaw by doxygen 1.8.14