STOFFSpreadsheetListener.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/* libstaroffice
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 STOFF_SPREADSHEET_LISTENER_H
41#define STOFF_SPREADSHEET_LISTENER_H
42
43#include <vector>
44
45#include <librevenge/librevenge.h>
46
48
49#include "STOFFListener.hxx"
50
51class STOFFCell;
53class STOFFChart;
55class STOFFTable;
56
58{
59struct DocumentState;
60struct State;
61}
62
65{
66public:
68 STOFFSpreadsheetListener(STOFFListManagerPtr &listManager, std::vector<STOFFPageSpan> const &pageList, librevenge::RVNGSpreadsheetInterface *documentInterface);
71
73 Type getType() const final
74 {
75 return Spreadsheet;
76 }
77
79 void setDocumentLanguage(std::string locale) final;
81 void setDocumentMetaData(const librevenge::RVNGPropertyList &list) final;
82
84 void startDocument() final;
86 void endDocument(bool sendDelayedSubDoc=true) final;
88 bool isDocumentStarted() const final;
89
91 void handleSubDocument(STOFFSubDocumentPtr subDocument, libstoff::SubDocumentType subDocumentType) final;
93 bool isSubDocumentOpened(libstoff::SubDocumentType &subdocType) const final;
95 bool openFrame(STOFFFrameStyle const &frame, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final;
97 void closeFrame() final;
99 bool openGroup(STOFFFrameStyle const &frame) final;
101 void closeGroup() final;
102
104 bool canWriteText() const final;
105
106 // ------ page --------
108 bool isPageSpanOpened() const final;
112 STOFFPageSpan const &getPageSpan() final;
113
114 // ------ header/footer --------
116 bool openHeader(librevenge::RVNGPropertyList const &extras) final;
118 bool openFooter(librevenge::RVNGPropertyList const &extras) final;
120 bool closeHeader() final;
122 bool closeFooter() final;
124 bool insertHeaderRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which) final;
126 bool insertFooterRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which) final;
128 bool isHeaderFooterOpened() const final;
129
130 // ------- sheet -----------------
132 void openSheet(std::vector<float> const &colWidth, librevenge::RVNGUnit unit,
133 std::vector<int> const &repeatColWidthNumber=std::vector<int>(), librevenge::RVNGString const &name="");
135 void closeSheet();
137 void openSheetRow(float h, librevenge::RVNGUnit unit, int numRepeated=1);
139 void closeSheetRow();
141 void openSheetCell(STOFFCell const &cell, STOFFCellContent const &content, int numRepeated=1);
143 void closeSheetCell();
144
145 // ------- chart -----------------
147 void insertChart(STOFFFrameStyle const &frame, STOFFChart &chart, STOFFGraphicStyle const &style=STOFFGraphicStyle());
148
149 // ------ text data -----------
150
152 void insertChar(uint8_t character) final;
155 void insertUnicode(uint32_t character) final;
157 void insertUnicodeString(librevenge::RVNGString const &str) final;
158
160 void insertTab() final;
162 void insertEOL(bool softBreak=false) final;
163
164 // ------ text format -----------
166 void setFont(STOFFFont const &font) final;
168 STOFFFont const &getFont() const final;
169
170 // ------ paragraph format -----------
172 bool isParagraphOpened() const final;
174 void setParagraph(STOFFParagraph const &paragraph) final;
176 STOFFParagraph const &getParagraph() const final;
177
178 // ------ style definition -----------
180 void defineStyle(STOFFFont const &style) final;
182 bool isFontStyleDefined(librevenge::RVNGString const &name) const final;
184 void defineStyle(STOFFGraphicStyle const &style) final;
186 bool isGraphicStyleDefined(librevenge::RVNGString const &name) const final;
188 void defineStyle(STOFFParagraph const &style) final;
190 bool isParagraphStyleDefined(librevenge::RVNGString const &name) const final;
191
192 // ------- fields ----------------
194 void insertField(STOFFField const &field) final;
195
196 // ------- link ----------------
198 void openLink(STOFFLink const &link) final;
200 void closeLink() final;
201
202 // ------- subdocument -----------------
204 void insertNote(STOFFNote const &note, STOFFSubDocumentPtr &subDocument) final;
206 void insertComment(STOFFSubDocumentPtr &subDocument, librevenge::RVNGString const &creator="", librevenge::RVNGString const &date="") final;
207
209 void insertPicture(STOFFFrameStyle const &frame, STOFFEmbeddedObject const &picture,
210 STOFFGraphicStyle const &style=STOFFGraphicStyle()) final;
212 void insertEquation(STOFFFrameStyle const &frame, librevenge::RVNGString const &equation,
213 STOFFGraphicStyle const &style=STOFFGraphicStyle()) final;
215 void insertShape(STOFFFrameStyle const &frame, STOFFGraphicShape const &shape, STOFFGraphicStyle const &style) final;
217 void insertTextBox(STOFFFrameStyle const &frame, STOFFSubDocumentPtr subDocument,
218 STOFFGraphicStyle const &frameStyle=STOFFGraphicStyle()) final;
219 // ------- table -----------------
221 void openTable(STOFFTable const &table) final;
223 void closeTable() final;
225 void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false) final;
227 void closeTableRow() final;
229 void openTableCell(STOFFCell const &cell) final;
231 void closeTableCell() final;
233 void addCoveredTableCell(STOFFVec2i const &pos) final;
235 void addEmptyTableCell(STOFFVec2i const &pos, STOFFVec2i span=STOFFVec2i(1,1)) final;
236
237 // ------- section ---------------
239 bool canOpenSectionAddBreak() const final
240 {
241 return false;
242 }
244 bool isSectionOpened() const final
245 {
246 return false;
247 }
249 STOFFSection const &getSection() const final;
251 bool openSection(STOFFSection const &section) final;
253 bool closeSection() final;
255 void insertBreak(BreakType breakType) final;
256
257protected:
259 void _openPageSpan(bool sendHeaderFooters=true);
261 void _closePageSpan();
262
263 void _startSubDocument();
264 void _endSubDocument();
265
266 void _handleFrameParameters(librevenge::RVNGPropertyList &propList, STOFFFrameStyle const &frame);
267
268 void _openParagraph();
269 void _closeParagraph();
270 void _resetParagraphState(const bool isListElement=false);
271
273 void _openListElement();
275 void _closeListElement();
277 void _changeList();
282 int _getListId() const;
283
284 void _openSpan();
285 void _closeSpan();
286
287 void _flushText();
288 void _flushDeferredTabs();
289
293 std::shared_ptr<STOFFSpreadsheetListenerInternal::State> _pushParsingState();
295 void _popParsingState();
296
297protected:
299 std::shared_ptr<STOFFSpreadsheetListenerInternal::DocumentState> m_ds;
301 std::shared_ptr<STOFFSpreadsheetListenerInternal::State> m_ps;
303 std::vector<std::shared_ptr<STOFFSpreadsheetListenerInternal::State> > m_psStack;
305 librevenge::RVNGSpreadsheetInterface *m_documentInterface;
306
307private:
312};
313
314#endif
315// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
small class use to define a sheet cell content
Definition STOFFCell.hxx:235
a structure used to define a cell and its format
Definition STOFFCell.hxx:54
a class used to store a chart associated to a spreadsheet ....
Definition STOFFChart.hxx:58
Class to store font.
Definition STOFFFont.hxx:44
Class to store a frame style.
Definition STOFFFrameStyle.hxx:46
a structure used to define a picture shape
Definition STOFFGraphicShape.hxx:46
Class to store a graphic style.
Definition STOFFGraphicStyle.hxx:45
This class contains a virtual interface to all listener.
Definition STOFFListener.hxx:51
Type
the listener type
Definition STOFFListener.hxx:57
@ Spreadsheet
Definition STOFFListener.hxx:57
BreakType
the different break type
Definition STOFFListener.hxx:59
A class which defines the page properties.
Definition STOFFPageSpan.hxx:76
class to store the paragraph properties
Definition STOFFParagraph.hxx:48
a class which stores section properties
Definition STOFFSection.hxx:46
This class contents the main functions needed to create a spreadsheet processing Document.
Definition STOFFSpreadsheetListener.hxx:65
void closeSheet()
closes this sheet
Definition STOFFSpreadsheetListener.cxx:1405
void _closeListElement()
close a list level
Definition STOFFSpreadsheetListener.cxx:814
Type getType() const final
returns the listener type
Definition STOFFSpreadsheetListener.hxx:73
void insertComment(STOFFSubDocumentPtr &subDocument, librevenge::RVNGString const &creator="", librevenge::RVNGString const &date="") final
adds comment
Definition STOFFSpreadsheetListener.cxx:1027
void _popParsingState()
resets the previous parsing state
Definition STOFFSpreadsheetListener.cxx:1752
void handleSubDocument(STOFFSubDocumentPtr subDocument, libstoff::SubDocumentType subDocumentType) final
function called to add a subdocument
Definition STOFFSpreadsheetListener.cxx:1275
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 STOFFSpreadsheetListener.cxx:1418
std::vector< std::shared_ptr< STOFFSpreadsheetListenerInternal::State > > m_psStack
stack of local state
Definition STOFFSpreadsheetListener.hxx:303
void insertField(STOFFField const &field) final
adds a field type
Definition STOFFSpreadsheetListener.cxx:448
void openTable(STOFFTable const &table) final
open a table
Definition STOFFSpreadsheetListener.cxx:1599
void addEmptyTableCell(STOFFVec2i const &pos, STOFFVec2i span=STOFFVec2i(1, 1)) final
add empty cell
Definition STOFFSpreadsheetListener.cxx:1685
void _handleFrameParameters(librevenge::RVNGPropertyList &propList, STOFFFrameStyle const &frame)
Definition STOFFSpreadsheetListener.cxx:1265
bool closeHeader() final
close a header
Definition STOFFSpreadsheetListener.cxx:667
void closeTableRow() final
closes this row
Definition STOFFSpreadsheetListener.cxx:1659
void insertEquation(STOFFFrameStyle const &frame, librevenge::RVNGString const &equation, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final
adds a equation given a position
Definition STOFFSpreadsheetListener.cxx:1096
void _endSubDocument()
Definition STOFFSpreadsheetListener.cxx:1352
void insertNote(STOFFNote const &note, STOFFSubDocumentPtr &subDocument) final
insert a note
Definition STOFFSpreadsheetListener.cxx:974
bool canOpenSectionAddBreak() const final
returns true if we can add open a section, add page break, ...
Definition STOFFSpreadsheetListener.hxx:239
void startDocument() final
starts the document
Definition STOFFSpreadsheetListener.cxx:517
void closeTableCell() final
close a cell
Definition STOFFSpreadsheetListener.cxx:1721
void _openSpan()
Definition STOFFSpreadsheetListener.cxx:897
bool insertHeaderRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which) final
insert a header
Definition STOFFSpreadsheetListener.cxx:649
STOFFFont const & getFont() const final
returns the actual font
Definition STOFFSpreadsheetListener.cxx:419
librevenge::RVNGSpreadsheetInterface * m_documentInterface
the document interface
Definition STOFFSpreadsheetListener.hxx:305
void insertChar(uint8_t character) final
adds a basic character, ..
Definition STOFFSpreadsheetListener.cxx:302
void insertPicture(STOFFFrameStyle const &frame, STOFFEmbeddedObject const &picture, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final
adds a picture with potential various representationin given position
Definition STOFFSpreadsheetListener.cxx:1081
void openSheet(std::vector< float > const &colWidth, librevenge::RVNGUnit unit, std::vector< int > const &repeatColWidthNumber=std::vector< int >(), librevenge::RVNGString const &name="")
open a sheet
Definition STOFFSpreadsheetListener.cxx:1368
STOFFSpreadsheetListener(STOFFListManagerPtr &listManager, std::vector< STOFFPageSpan > const &pageList, librevenge::RVNGSpreadsheetInterface *documentInterface)
constructor
Definition STOFFSpreadsheetListener.cxx:240
STOFFParagraph const & getParagraph() const final
returns the actual paragraph
Definition STOFFSpreadsheetListener.cxx:440
void openTableCell(STOFFCell const &cell) final
open a cell
Definition STOFFSpreadsheetListener.cxx:1704
void _flushText()
Definition STOFFSpreadsheetListener.cxx:943
void setParagraph(STOFFParagraph const &paragraph) final
sets the paragraph
Definition STOFFSpreadsheetListener.cxx:429
void setFont(STOFFFont const &font) final
sets the font
Definition STOFFSpreadsheetListener.cxx:412
void _openListElement()
open a list level
Definition STOFFSpreadsheetListener.cxx:792
void closeSheetCell()
close a cell
Definition STOFFSpreadsheetListener.cxx:1556
void defineStyle(STOFFFont const &style) final
defines a font styles
Definition STOFFSpreadsheetListener.cxx:253
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 STOFFSpreadsheetListener.cxx:1638
~STOFFSpreadsheetListener() final
destructor
Definition STOFFSpreadsheetListener.cxx:249
void insertTextBox(STOFFFrameStyle const &frame, STOFFSubDocumentPtr subDocument, STOFFGraphicStyle const &frameStyle=STOFFGraphicStyle()) final
adds a textbox in given position
Definition STOFFSpreadsheetListener.cxx:1062
bool isDocumentStarted() const final
returns true if a document is opened
Definition STOFFSpreadsheetListener.cxx:512
void _closeSpan()
Definition STOFFSpreadsheetListener.cxx:919
void setDocumentMetaData(const librevenge::RVNGPropertyList &list) final
sets the document meta data
Definition STOFFSpreadsheetListener.cxx:505
bool isPageSpanOpened() const final
returns true if a page is opened
Definition STOFFSpreadsheetListener.cxx:563
void insertBreak(BreakType breakType) final
inserts a break type: ColumBreak, PageBreak, ..
Definition STOFFSpreadsheetListener.cxx:387
void openLink(STOFFLink const &link) final
open a link
Definition STOFFSpreadsheetListener.cxx:463
void openSheetCell(STOFFCell const &cell, STOFFCellContent const &content, int numRepeated=1)
open a cell
Definition STOFFSpreadsheetListener.cxx:1449
bool isParagraphStyleDefined(librevenge::RVNGString const &name) const final
check if a paragraph style with a display name is already defined
Definition STOFFSpreadsheetListener.cxx:289
void _resetParagraphState(const bool isListElement=false)
Definition STOFFSpreadsheetListener.cxx:782
void insertChart(STOFFFrameStyle const &frame, STOFFChart &chart, STOFFGraphicStyle const &style=STOFFGraphicStyle())
adds a chart in given position
Definition STOFFSpreadsheetListener.cxx:1574
void setDocumentLanguage(std::string locale) final
sets the document language
Definition STOFFSpreadsheetListener.cxx:499
STOFFSection const & getSection() const final
returns the actual section
Definition STOFFSpreadsheetListener.cxx:722
void closeLink() final
close a link
Definition STOFFSpreadsheetListener.cxx:485
bool closeFooter() final
close a footer
Definition STOFFSpreadsheetListener.cxx:708
void closeGroup() final
close a group (not implemented)
Definition STOFFSpreadsheetListener.cxx:1181
bool isGraphicStyleDefined(librevenge::RVNGString const &name) const final
check if a graphic style with a display name is already defined
Definition STOFFSpreadsheetListener.cxx:284
void insertEOL(bool softBreak=false) final
adds an end of line ( by default an hard one)
Definition STOFFSpreadsheetListener.cxx:351
void closeFrame() final
tries to close a frame
Definition STOFFSpreadsheetListener.cxx:1254
STOFFPageSpan const & getPageSpan() final
returns the current page span
Definition STOFFSpreadsheetListener.cxx:568
void _changeList()
update the list so that it corresponds to the actual level
Definition STOFFSpreadsheetListener.cxx:843
void _openPageSpan(bool sendHeaderFooters=true)
does open a new page (low level)
Definition STOFFSpreadsheetListener.cxx:576
int _getListId() const
low level: find a list id which corresponds to actual list and a change of level.
Definition STOFFSpreadsheetListener.cxx:827
bool isSectionOpened() const final
returns true if a section is opened
Definition STOFFSpreadsheetListener.hxx:244
bool closeSection() final
close a section
Definition STOFFSpreadsheetListener.cxx:734
void addCoveredTableCell(STOFFVec2i const &pos) final
add covered cell
Definition STOFFSpreadsheetListener.cxx:1669
bool isSubDocumentOpened(libstoff::SubDocumentType &subdocType) const final
returns try if a subdocument is open
Definition STOFFSpreadsheetListener.cxx:1338
void insertShape(STOFFFrameStyle const &frame, STOFFGraphicShape const &shape, STOFFGraphicStyle const &style) final
adds a shape picture in given position
Definition STOFFSpreadsheetListener.cxx:1116
bool canWriteText() const final
returns true if we can add text data
Definition STOFFSpreadsheetListener.cxx:297
bool openFrame(STOFFFrameStyle const &frame, STOFFGraphicStyle const &style=STOFFGraphicStyle()) final
tries to open a frame
Definition STOFFSpreadsheetListener.cxx:1185
void closeTable() final
closes this table
Definition STOFFSpreadsheetListener.cxx:1624
void _closeParagraph()
Definition STOFFSpreadsheetListener.cxx:761
std::shared_ptr< STOFFSpreadsheetListenerInternal::State > _pushParsingState()
creates a new parsing state (copy of the actual state)
Definition STOFFSpreadsheetListener.cxx:1741
bool insertFooterRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which) final
insert a footer
Definition STOFFSpreadsheetListener.cxx:690
void _openParagraph()
Definition STOFFSpreadsheetListener.cxx:743
void _flushDeferredTabs()
Definition STOFFSpreadsheetListener.cxx:933
void insertUnicode(uint32_t character) final
adds an unicode character.
Definition STOFFSpreadsheetListener.cxx:317
void endDocument(bool sendDelayedSubDoc=true) final
ends the document
Definition STOFFSpreadsheetListener.cxx:530
void insertUnicodeString(librevenge::RVNGString const &str) final
adds a unicode string
Definition STOFFSpreadsheetListener.cxx:339
bool openGroup(STOFFFrameStyle const &frame) final
open a group (not implemented)
Definition STOFFSpreadsheetListener.cxx:1175
bool openSection(STOFFSection const &section) final
open a section if possible
Definition STOFFSpreadsheetListener.cxx:728
bool isFontStyleDefined(librevenge::RVNGString const &name) const final
check if a font style with a display name is already defined
Definition STOFFSpreadsheetListener.cxx:279
void _startSubDocument()
Definition STOFFSpreadsheetListener.cxx:1346
bool openFooter(librevenge::RVNGPropertyList const &extras) final
open a footer (interaction with STOFFPageSpan which fills the parameters for openFooter)
Definition STOFFSpreadsheetListener.cxx:678
void _closePageSpan()
does close a page (low level)
Definition STOFFSpreadsheetListener.cxx:620
void insertTab() final
adds a tab
Definition STOFFSpreadsheetListener.cxx:371
bool openHeader(librevenge::RVNGPropertyList const &extras) final
open a header (interaction with STOFFPageSpan which fills the parameters for openHeader)
Definition STOFFSpreadsheetListener.cxx:637
bool isParagraphOpened() const final
returns true if a paragraph or a list is opened
Definition STOFFSpreadsheetListener.cxx:424
std::shared_ptr< STOFFSpreadsheetListenerInternal::State > m_ps
the actual local parse state
Definition STOFFSpreadsheetListener.hxx:301
bool isHeaderFooterOpened() const final
returns true if the header/footer is open
Definition STOFFSpreadsheetListener.cxx:632
std::shared_ptr< STOFFSpreadsheetListenerInternal::DocumentState > m_ds
the main parse state
Definition STOFFSpreadsheetListener.hxx:299
void closeSheetRow()
closes this row
Definition STOFFSpreadsheetListener.cxx:1439
a class used to recreate the table structure using cell informations, ....
Definition STOFFTable.hxx:52
std::shared_ptr< STOFFSubDocument > STOFFSubDocumentPtr
a smart pointer of STOFFSubDocument
Definition libstaroffice_internal.hxx:499
std::shared_ptr< STOFFListManager > STOFFListManagerPtr
a smart pointer of STOFFListManager
Definition libstaroffice_internal.hxx:493
Internal and low level namespace to define the states of STOFFSpreadsheetListener.
Definition STOFFSpreadsheetListener.cxx:75
Definition STOFFDocument.hxx:43
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition libstaroffice_internal.cxx:51
small class use to define a embedded object
Definition libstaroffice_internal.hxx:408
a field
Definition libstaroffice_internal.hxx:363
a note
Definition libstaroffice_internal.hxx:389

Generated on Mon Apr 22 2024 12:48:55 for libstaroffice by doxygen 1.10.0