MWAWSpreadsheetListener.hxx Source File documentation

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
58 namespace MWAWSpreadsheetListenerInternal
59 {
60 struct DocumentState;
61 struct State;
62 }
63
65 class MWAWSpreadsheetListener : public MWAWListener
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);
75 virtual ~MWAWSpreadsheetListener();
76
78 Type getType() const
79 {
80 return Spreadsheet;
81 }
82
84 void setDocumentMetaData(librevenge::RVNGPropertyList const &metadata);
86 void setDocumentLanguage(std::string const &locale);
87
89 void startDocument();
91 void endDocument(bool sendDelayedSubDoc=true);
93 bool isDocumentStarted() const;
94
96 void handleSubDocument(MWAWSubDocumentPtr subDocument, libmwaw::SubDocumentType subDocumentType);
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();
107
109 bool canWriteText() const;
110
111 // ------ page --------
113 bool isPageSpanOpened() const;
117 MWAWPageSpan const &getPageSpan();
118
119 // ------ header/footer --------
121 bool insertHeader(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras);
123 bool insertFooter(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras);
125 bool isHeaderFooterOpened() const;
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);
156 void insertCharacter(unsigned char c);
162 int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1);
165 void insertUnicode(uint32_t character);
167 void insertUnicodeString(librevenge::RVNGString const &str);
168
170 void insertTab();
172 void insertEOL(bool softBreak=false);
173
174 // ------ text format -----------
176 void setFont(MWAWFont const &font);
178 MWAWFont const &getFont() const;
179
180 // ------ paragraph format -----------
182 bool isParagraphOpened() const;
184 void setParagraph(MWAWParagraph const &paragraph);
186 MWAWParagraph const &getParagraph() const;
187
188 // ------- fields ----------------
190 void insertField(MWAWField const &field);
191
192 // ------- link ----------------
194 void openLink(MWAWLink const &link);
196 void closeLink();
197
198 // ------- subdocument -----------------
200 void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument);
201
203 void insertComment(MWAWSubDocumentPtr &subDocument);
204
206 void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture,
207 MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle());
209 void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape,
210 MWAWGraphicStyle const &style);
212 void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr subDocument,
213 MWAWGraphicStyle const &frameStyle=MWAWGraphicStyle::emptyStyle());
214
215 // ------- table -----------------
217 void insertTable(MWAWPosition const &pos, MWAWTable &table, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle());
219 void openTable(MWAWTable const &table);
221 void closeTable();
223 void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false);
225 void closeTableRow();
227 void openTableCell(MWAWCell const &cell);
229 void closeTableCell();
231 void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1,1));
232
233 // ------- section ---------------
235 bool canOpenSectionAddBreak() const
236 {
237 return false;
238 }
240 bool isSectionOpened() const
241 {
242 return false;
243 }
245 MWAWSection const &getSection() const;
247 bool openSection(MWAWSection const &section);
249 bool closeSection();
251 void insertBreak(BreakType breakType);
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 shared_ptr<MWAWSpreadsheetListenerInternal::State> _pushParsingState();
291 void _popParsingState();
292
293 protected:
295 shared_ptr<MWAWSpreadsheetListenerInternal::DocumentState> m_ds;
297 shared_ptr<MWAWSpreadsheetListenerInternal::State> m_ps;
299 std::vector<shared_ptr<MWAWSpreadsheetListenerInternal::State> > m_psStack;
301 MWAWParserState &m_parserState;
303 librevenge::RVNGSpreadsheetInterface *m_documentInterface;
304
305 private:
307 MWAWSpreadsheetListener(const MWAWSpreadsheetListener &);
309 MWAWSpreadsheetListener &operator=(const MWAWSpreadsheetListener &);
310 };
311
312 #endif
313 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWPageSpan
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:95
MWAWSpreadsheetListener::isSectionOpened
bool isSectionOpened() const
returns true if a section is opened
Definition: MWAWSpreadsheetListener.hxx:240
libmwaw_internal.hxx
MWAWLink
a link
Definition: libmwaw_internal.hxx:406
MWAWSpreadsheetListener::m_documentInterface
librevenge::RVNGSpreadsheetInterface * m_documentInterface
the document interface
Definition: MWAWSpreadsheetListener.hxx:303
MWAWGraphicStyle
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:47
libmwaw::SubDocumentType
SubDocumentType
Definition: libmwaw_internal.hxx:192
MWAWTable
a class used to recreate the table structure using cell informations, ....
Definition: MWAWTable.hxx:51
MWAWVec2i
MWAWVec2< int > MWAWVec2i
MWAWVec2 of int.
Definition: libmwaw_internal.hxx:795
MWAWListener::Type
Type
the listener type
Definition: MWAWListener.hxx:56
MWAWSpreadsheetListener::m_ps
shared_ptr< MWAWSpreadsheetListenerInternal::State > m_ps
the actual local parse state
Definition: MWAWSpreadsheetListener.hxx:297
MWAWCell
a structure used to define a cell and its format
Definition: MWAWCell.hxx:52
MWAWSubDocumentPtr
shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:531
MWAWCellContent
small class use to define a sheet cell content
Definition: MWAWCell.hxx:355
HanMacWrdKTextInternal::getSection
Section getSection(const State &state, const long id)
Definition: HanMacWrdKText.cxx:249
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
MWAWBox2< float >
MWAWParserState
a class to define the parser state
Definition: MWAWParser.hxx:49
MWAWListener::BreakType
BreakType
the different break type
Definition: MWAWListener.hxx:58
MWAWSpreadsheetListener::getType
Type getType() const
returns the listener type
Definition: MWAWSpreadsheetListener.hxx:78
MWAWSpreadsheetListener
This class contents the main functions needed to create a spreadsheet processing Document.
Definition: MWAWSpreadsheetListener.hxx:65
MWAWSpreadsheetListener::canOpenSectionAddBreak
bool canOpenSectionAddBreak() const
returns true if we can add open a section, add page break, ...
Definition: MWAWSpreadsheetListener.hxx:235
MWAWEmbeddedObject
small class use to define a embedded object
Definition: libmwaw_internal.hxx:439
MWAWSection
a class which stores section properties
Definition: MWAWSection.hxx:45
MWAWInputStreamPtr
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:517
MWAWSpreadsheetListener::m_psStack
std::vector< shared_ptr< MWAWSpreadsheetListenerInternal::State > > m_psStack
stack of local state
Definition: MWAWSpreadsheetListener.hxx:299
MWAWListener.hxx
MWAWGraphicShape
a structure used to define a picture shape
Definition: MWAWGraphicShape.hxx:45
MWAWSpreadsheetListener::m_ds
shared_ptr< MWAWSpreadsheetListenerInternal::DocumentState > m_ds
the main parse state
Definition: MWAWSpreadsheetListener.hxx:295
MWAWParagraph
class to store the paragraph properties
Definition: MWAWParagraph.hxx:81
MWAWField
a field
Definition: libmwaw_internal.hxx:383
MWAWSpreadsheetListenerInternal
Internal and low level namespace to define the states of MWAWSpreadsheetListener. ...
Definition: MWAWSpreadsheetListener.cxx:71
MWAWNote
a note
Definition: libmwaw_internal.hxx:420
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: MWAWPosition.hxx:47
MWAWListener
This class contains a virtual interface to all listener.
Definition: MWAWListener.hxx:49
MWAWSpreadsheetListener::m_parserState
MWAWParserState & m_parserState
the parser state
Definition: MWAWSpreadsheetListener.hxx:301
MWAWChart
a class used to store a chart associated to a spreadsheet ....
Definition: MWAWChart.hxx:57
MWAWVec2< int >
MWAWGraphicStyle::emptyStyle
static MWAWGraphicStyle emptyStyle()
returns an empty style.
Definition: MWAWGraphicStyle.hxx:268