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 
51 class STOFFCell;
52 class STOFFCellContent;
53 class STOFFChart;
54 class STOFFGraphicStyle;
55 class STOFFTable;
56 
58 {
59 struct DocumentState;
60 struct State;
61 }
62 
65 {
66 public:
68  STOFFSpreadsheetListener(STOFFListManagerPtr listManager, std::vector<STOFFPageSpan> const &pageList, librevenge::RVNGSpreadsheetInterface *documentInterface);
70  virtual ~STOFFSpreadsheetListener();
71 
73  Type getType() const
74  {
75  return Spreadsheet;
76  }
77 
79  void setDocumentLanguage(std::string locale);
81  void setDocumentMetaData(const librevenge::RVNGPropertyList &list);
82 
84  void startDocument();
86  void endDocument(bool sendDelayedSubDoc=true);
88  bool isDocumentStarted() const;
89 
91  void handleSubDocument(STOFFSubDocumentPtr subDocument, libstoff::SubDocumentType subDocumentType);
93  bool isSubDocumentOpened(libstoff::SubDocumentType &subdocType) const;
95  bool openFrame(STOFFPosition const &pos, STOFFGraphicStyle const &style=STOFFGraphicStyle());
97  void closeFrame();
99  bool openGroup(STOFFPosition const &pos);
101  void closeGroup();
102 
104  bool canWriteText() const;
105 
106  // ------ page --------
108  bool isPageSpanOpened() const;
112  STOFFPageSpan const &getPageSpan();
113 
114  // ------ header/footer --------
116  bool openHeader(librevenge::RVNGPropertyList const &extras);
118  bool openFooter(librevenge::RVNGPropertyList const &extras);
120  bool closeHeader();
122  bool closeFooter();
124  bool insertHeaderRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which);
126  bool insertFooterRegion(STOFFSubDocumentPtr subDocument, librevenge::RVNGString const &which);
128  bool isHeaderFooterOpened() const;
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(STOFFPosition const &pos, STOFFChart &chart, STOFFGraphicStyle const &style=STOFFGraphicStyle());
148 
149  // ------ text data -----------
150 
152  void insertChar(uint8_t character);
155  void insertUnicode(uint32_t character);
157  void insertUnicodeString(librevenge::RVNGString const &str);
158 
160  void insertTab();
162  void insertEOL(bool softBreak=false);
163 
164  // ------ text format -----------
166  void setFont(STOFFFont const &font);
168  STOFFFont const &getFont() const;
169 
170  // ------ paragraph format -----------
172  bool isParagraphOpened() const;
174  void setParagraph(STOFFParagraph const &paragraph);
176  STOFFParagraph const &getParagraph() const;
177 
178  // ------ style definition -----------
180  void defineStyle(STOFFFont const &style);
182  bool isFontStyleDefined(librevenge::RVNGString const &name) const;
184  void defineStyle(STOFFGraphicStyle const &style);
186  bool isGraphicStyleDefined(librevenge::RVNGString const &name) const;
188  void defineStyle(STOFFParagraph const &style);
190  bool isParagraphStyleDefined(librevenge::RVNGString const &name) const;
191 
192  // ------- fields ----------------
194  void insertField(STOFFField const &field);
195 
196  // ------- link ----------------
198  void openLink(STOFFLink const &link);
200  void closeLink();
201 
202  // ------- subdocument -----------------
204  void insertNote(STOFFNote const &note, STOFFSubDocumentPtr &subDocument);
206  void insertComment(STOFFSubDocumentPtr &subDocument, librevenge::RVNGString const &creator="", librevenge::RVNGString const &date="");
207 
209  void insertPicture(STOFFPosition const &pos, STOFFEmbeddedObject const &picture,
210  STOFFGraphicStyle const &style=STOFFGraphicStyle());
212  void insertShape(STOFFGraphicShape const &shape, STOFFGraphicStyle const &style, STOFFPosition const &pos);
214  void insertTextBox(STOFFPosition const &pos, STOFFSubDocumentPtr subDocument,
215  STOFFGraphicStyle const &frameStyle=STOFFGraphicStyle());
216  // ------- table -----------------
218  void openTable(STOFFTable const &table);
220  void closeTable();
222  void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false);
224  void closeTableRow();
226  void openTableCell(STOFFCell const &cell);
228  void closeTableCell();
230  void addCoveredTableCell(STOFFVec2i const &pos);
232  void addEmptyTableCell(STOFFVec2i const &pos, STOFFVec2i span=STOFFVec2i(1,1));
233 
234  // ------- section ---------------
237  {
238  return false;
239  }
241  bool isSectionOpened() const
242  {
243  return false;
244  }
246  STOFFSection const &getSection() const;
248  bool openSection(STOFFSection const &section);
250  bool closeSection();
252  void insertBreak(BreakType breakType);
253 
254 protected:
256  void _openPageSpan(bool sendHeaderFooters=true);
258  void _closePageSpan();
259 
260  void _startSubDocument();
261  void _endSubDocument();
262 
263  void _handleFrameParameters(librevenge::RVNGPropertyList &propList, STOFFPosition const &pos);
264 
265  void _openParagraph();
266  void _closeParagraph();
267  void _resetParagraphState(const bool isListElement=false);
268 
270  void _openListElement();
272  void _closeListElement();
274  void _changeList();
279  int _getListId() const;
280 
281  void _openSpan();
282  void _closeSpan();
283 
284  void _flushText();
285  void _flushDeferredTabs();
286 
290  shared_ptr<STOFFSpreadsheetListenerInternal::State> _pushParsingState();
292  void _popParsingState();
293 
294 protected:
296  shared_ptr<STOFFSpreadsheetListenerInternal::DocumentState> m_ds;
298  shared_ptr<STOFFSpreadsheetListenerInternal::State> m_ps;
300  std::vector<shared_ptr<STOFFSpreadsheetListenerInternal::State> > m_psStack;
302  librevenge::RVNGSpreadsheetInterface *m_documentInterface;
303 
304 private:
309 };
310 
311 #endif
312 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
shared_ptr< STOFFSpreadsheetListenerInternal::DocumentState > m_ds
the main parse state
Definition: STOFFSpreadsheetListener.hxx:296
bool canOpenSectionAddBreak() const
returns true if we can add open a section, add page break, ...
Definition: STOFFSpreadsheetListener.hxx:236
a structure used to define a cell and its format
Definition: STOFFCell.hxx:53
Type
the listener type
Definition: STOFFListener.hxx:57
small class use to define a sheet cell content
Definition: STOFFCell.hxx:226
bool isSectionOpened() const
returns true if a section is opened
Definition: STOFFSpreadsheetListener.hxx:241
Internal and low level namespace to define the states of STOFFSpreadsheetListener.
Definition: STOFFSpreadsheetListener.cxx:73
a class used to recreate the table structure using cell informations, ....
Definition: STOFFTable.hxx:51
a note
Definition: libstaroffice_internal.hxx:379
class to store the paragraph properties
Definition: STOFFParagraph.hxx:47
std::vector< shared_ptr< STOFFSpreadsheetListenerInternal::State > > m_psStack
stack of local state
Definition: STOFFSpreadsheetListener.hxx:300
librevenge::RVNGSpreadsheetInterface * m_documentInterface
the document interface
Definition: STOFFSpreadsheetListener.hxx:302
This class contents the main functions needed to create a spreadsheet processing Document.
Definition: STOFFSpreadsheetListener.hxx:64
shared_ptr< STOFFListManager > STOFFListManagerPtr
a smart pointer of STOFFListManager
Definition: libstaroffice_internal.hxx:478
a class used to store a chart associated to a spreadsheet ....
Definition: STOFFChart.hxx:56
SubDocumentType
Definition: libstaroffice_internal.hxx:175
shared_ptr< STOFFSubDocument > STOFFSubDocumentPtr
a smart pointer of STOFFSubDocument
Definition: libstaroffice_internal.hxx:484
a class which stores section properties
Definition: STOFFSection.hxx:45
a field
Definition: libstaroffice_internal.hxx:353
a structure used to define a picture shape
Definition: STOFFGraphicShape.hxx:45
small class use to define a embedded object
Definition: libstaroffice_internal.hxx:398
STOFFVec2< int > STOFFVec2i
STOFFVec2 of int.
Definition: libstaroffice_internal.hxx:748
Class to store font.
Definition: STOFFFont.hxx:43
shared_ptr< STOFFSpreadsheetListenerInternal::State > m_ps
the actual local parse state
Definition: STOFFSpreadsheetListener.hxx:298
A class which defines the page properties.
Definition: STOFFPageSpan.hxx:75
BreakType
the different break type
Definition: STOFFListener.hxx:59
This class contains a virtual interface to all listener.
Definition: STOFFListener.hxx:50
Class to store a graphic style.
Definition: STOFFGraphicStyle.hxx:44
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: STOFFPosition.hxx:47
Type getType() const
returns the listener type
Definition: STOFFSpreadsheetListener.hxx:73

Generated on Wed Feb 22 2017 09:37:10 for libstaroffice by doxygen 1.8.11