MWAWTextListener.hxx Source File documentation

MWAWTextListener.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_TEXT_LISTENER_H
41 #define MWAW_TEXT_LISTENER_H
42
43 #include <vector>
44
45 #include <librevenge/librevenge.h>
46
47 #include "libmwaw_internal.hxx"
48 #include "MWAWGraphicStyle.hxx"
49
50 #include "MWAWListener.hxx"
51
52 class MWAWCell;
53 class MWAWGraphicStyle;
54 class MWAWGraphicShape;
55 class MWAWTable;
56
57 namespace MWAWTextListenerInternal
58 {
59 struct DocumentState;
60 struct State;
61 }
62
64 class MWAWTextListener : public MWAWListener
65 {
66 public:
68 MWAWTextListener(MWAWParserState &parserState, std::vector<MWAWPageSpan> const &pageList, librevenge::RVNGTextInterface *documentInterface);
70 virtual ~MWAWTextListener();
71
73 Type getType() const
74 {
75 return Text;
76 }
77
79 void setDocumentMetaData(librevenge::RVNGPropertyList const &metadata);
81 void setDocumentLanguage(std::string const &locale);
82
84 void startDocument();
86 void endDocument(bool sendDelayedSubDoc=true);
88 bool isDocumentStarted() const;
89
91 void handleSubDocument(MWAWSubDocumentPtr subDocument, libmwaw::SubDocumentType subDocumentType);
93 bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const;
95 bool openFrame(MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle());
97 void closeFrame();
99 bool openGroup(MWAWPosition const &pos);
101 void closeGroup();
102
104 bool canWriteText() const
105 {
106 return MWAWTextListener::isDocumentStarted();
107 }
108
109 // ------ page --------
111 bool isPageSpanOpened() const;
115 MWAWPageSpan const &getPageSpan();
116
117 // ------ header/footer --------
119 bool insertHeader(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras);
121 bool insertFooter(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras);
123 bool isHeaderFooterOpened() const;
124
125 // ------ text data -----------
126
128 void insertChar(uint8_t character);
131 void insertCharacter(unsigned char c);
137 int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1);
140 void insertUnicode(uint32_t character);
142 void insertUnicodeString(librevenge::RVNGString const &str);
143
145 void insertTab();
147 void insertEOL(bool softBreak=false);
148
149 // ------ text format -----------
151 void setFont(MWAWFont const &font);
153 MWAWFont const &getFont() const;
154
155 // ------ paragraph format -----------
157 bool isParagraphOpened() const;
159 void setParagraph(MWAWParagraph const &paragraph);
161 MWAWParagraph const &getParagraph() const;
162
163 // ------- fields ----------------
165 void insertField(MWAWField const &field);
166
167 // ------- link ----------------
169 void openLink(MWAWLink const &link);
171 void closeLink();
172
173 // ------- subdocument -----------------
175 void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument);
176
178 void insertComment(MWAWSubDocumentPtr &subDocument);
179
181 void insertPicture(MWAWPosition const &pos, MWAWEmbeddedObject const &picture,
182 MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle());
184 void insertShape(MWAWPosition const &pos, MWAWGraphicShape const &shape,
185 MWAWGraphicStyle const &style);
187 void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr subDocument,
188 MWAWGraphicStyle const &frameStyle=MWAWGraphicStyle::emptyStyle());
189
190 // ------- table -----------------
192 void openTable(MWAWTable const &table);
194 void closeTable();
196 void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false);
198 void closeTableRow();
200 void openTableCell(MWAWCell const &cell);
202 void closeTableCell();
204 void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1,1));
205
206 // ------- section ---------------
208 bool canOpenSectionAddBreak() const;
210 bool isSectionOpened() const;
212 MWAWSection const &getSection() const;
214 bool openSection(MWAWSection const &section);
216 bool closeSection();
218 void insertBreak(BreakType breakType);
219
220 protected:
222 void _openSection();
224 void _closeSection();
226 void _openPageSpan(bool sendHeaderFooters=true);
228 void _closePageSpan();
229
230 void _startSubDocument();
231 void _endSubDocument();
232
233 void _handleFrameParameters(librevenge::RVNGPropertyList &propList, MWAWPosition const &pos);
234
235 void _openParagraph();
236 void _closeParagraph();
237 void _appendParagraphProperties(librevenge::RVNGPropertyList &propList, const bool isListElement=false);
238 void _resetParagraphState(const bool isListElement=false);
239
241 void _openListElement();
243 void _closeListElement();
245 void _changeList();
250 int _getListId() const;
251
253 void _openSpan();
255 void _closeSpan();
256
258 void _flushText();
260 void _flushDeferredTabs();
261
262 void _insertBreakIfNecessary(librevenge::RVNGPropertyList &propList);
263
267 shared_ptr<MWAWTextListenerInternal::State> _pushParsingState();
269 void _popParsingState();
270
271 protected:
273 shared_ptr<MWAWTextListenerInternal::DocumentState> m_ds;
275 shared_ptr<MWAWTextListenerInternal::State> m_ps;
277 std::vector<shared_ptr<MWAWTextListenerInternal::State> > m_psStack;
279 MWAWParserState &m_parserState;
281 librevenge::RVNGTextInterface *m_documentInterface;
282
283 private:
285 MWAWTextListener(const MWAWTextListener &);
287 MWAWTextListener &operator=(const MWAWTextListener &);
288 };
289
290 #endif
291 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWTextListener::isDocumentStarted
bool isDocumentStarted() const
returns true if a document is opened
Definition: MWAWTextListener.cxx:490
MWAWTextListener::m_parserState
MWAWParserState & m_parserState
the parser state
Definition: MWAWTextListener.hxx:279
MWAWPageSpan
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:95
libmwaw_internal.hxx
MWAWTextListener
This class contents the main functions needed to create a Word processing Document.
Definition: MWAWTextListener.hxx:64
MWAWLink
a link
Definition: libmwaw_internal.hxx:406
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
MWAWTextListener::getType
Type getType() const
returns the listener type
Definition: MWAWTextListener.hxx:73
MWAWListener::Type
Type
the listener type
Definition: MWAWListener.hxx:56
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
HanMacWrdKTextInternal::getSection
Section getSection(const State &state, const long id)
Definition: HanMacWrdKText.cxx:249
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
MWAWParserState
a class to define the parser state
Definition: MWAWParser.hxx:49
MWAWListener::BreakType
BreakType
the different break type
Definition: MWAWListener.hxx:58
MWAWTextListener::m_ds
shared_ptr< MWAWTextListenerInternal::DocumentState > m_ds
the main parse state
Definition: MWAWTextListener.hxx:273
MWAWTextListenerInternal
Internal and low level namespace to define the states of MWAWTextListener.
Definition: MWAWTextListener.cxx:70
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
MWAWListener.hxx
MWAWGraphicShape
a structure used to define a picture shape
Definition: MWAWGraphicShape.hxx:45
MWAWParagraph
class to store the paragraph properties
Definition: MWAWParagraph.hxx:81
MWAWField
a field
Definition: libmwaw_internal.hxx:383
MWAWTextListener::m_ps
shared_ptr< MWAWTextListenerInternal::State > m_ps
the actual local parse state
Definition: MWAWTextListener.hxx:275
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
MWAWTextListener::m_documentInterface
librevenge::RVNGTextInterface * m_documentInterface
the document interface
Definition: MWAWTextListener.hxx:281
MWAWTextListener::m_psStack
std::vector< shared_ptr< MWAWTextListenerInternal::State > > m_psStack
stack of local state
Definition: MWAWTextListener.hxx:277
MWAWTextListener::canWriteText
bool canWriteText() const
returns true if we can add text data
Definition: MWAWTextListener.hxx:104
MWAWGraphicStyle.hxx
MWAWVec2< int >
MWAWGraphicStyle::emptyStyle
static MWAWGraphicStyle emptyStyle()
returns an empty style.
Definition: MWAWGraphicStyle.hxx:268