MWAWListener.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 
34 #ifndef MWAW_LISTENER_H
35 #define MWAW_LISTENER_H
36 
37 #include <vector>
38 
39 #include <libwpd/libwpd.h>
40 
41 #include "libmwaw_internal.hxx"
42 
47 {
48 public:
49  virtual ~MWAWListener() {}
50 
53 
55  virtual bool isDocumentStarted() const =0;
57  virtual bool canWriteText() const =0;
59  virtual bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const = 0;
60 
61  // ------ text data -----------
63  virtual void insertChar(uint8_t character)=0;
66  virtual void insertCharacter(unsigned char c)=0;
72  virtual int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1)=0;
75  virtual void insertUnicode(uint32_t character)=0;
77  virtual void insertUnicodeString(WPXString const &str)=0;
78 
80  virtual void insertTab()=0;
82  virtual void insertEOL(bool softBreak=false)=0;
83 
84  // ------ text format -----------
86  virtual void setFont(MWAWFont const &font)=0;
88  virtual MWAWFont const &getFont() const=0;
89 
90  // ------ paragraph format -----------
92  virtual bool isParagraphOpened() const=0;
94  virtual void setParagraph(MWAWParagraph const &paragraph)=0;
96  virtual MWAWParagraph const &getParagraph() const=0;
97 
98  // ------- fields ----------------
100  virtual void insertField(MWAWField const &field)=0;
101 
102  // ------- section ---------------
104  virtual bool canOpenSectionAddBreak() const =0;
106  virtual bool isSectionOpened() const=0;
108  virtual MWAWSection const &getSection() const=0;
110  virtual bool openSection(MWAWSection const &section)=0;
112  virtual bool closeSection()=0;
114  virtual void insertBreak(BreakType breakType)=0;
115 
116 };
117 
118 #endif
119 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
virtual bool canOpenSectionAddBreak() const =0
returns true if we can add open a section, add page break, ...
virtual void insertCharacter(unsigned char c)=0
insert a character using the font converter to find the utf8 character
virtual bool openSection(MWAWSection const &section)=0
open a section if possible
virtual bool isSectionOpened() const =0
returns true if a section is opened
virtual bool isParagraphOpened() const =0
returns true if a paragraph or a list is opened
virtual ~MWAWListener()
Definition: MWAWListener.hxx:49
virtual void insertUnicodeString(WPXString const &str)=0
adds a unicode string
Definition: MWAWListener.hxx:52
virtual void insertUnicode(uint32_t character)=0
adds an unicode character.
virtual void setParagraph(MWAWParagraph const &paragraph)=0
sets the paragraph
virtual void setFont(MWAWFont const &font)=0
sets the font
SubDocumentType
Definition: libmwaw_internal.hxx:162
Definition: MWAWListener.hxx:52
virtual MWAWFont const & getFont() const =0
returns the actual font
virtual bool isDocumentStarted() const =0
returns true if a document is opened
virtual void insertChar(uint8_t character)=0
adds a basic character, ..
virtual void insertBreak(BreakType breakType)=0
inserts a break type: ColumBreak, PageBreak, ..
BreakType
the different break type
Definition: MWAWListener.hxx:52
virtual bool canWriteText() const =0
returns true if we can add text data
virtual void insertEOL(bool softBreak=false)=0
adds an end of line ( by default an hard one)
virtual MWAWSection const & getSection() const =0
returns the actual section
Definition: MWAWListener.hxx:52
a class which stores section properties
Definition: MWAWSection.hxx:45
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:348
virtual void insertField(MWAWField const &field)=0
adds a field type
virtual MWAWParagraph const & getParagraph() const =0
returns the actual paragraph
virtual bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const =0
returns true if a subdocument is open
class to store the paragraph properties
Definition: MWAWParagraph.hxx:82
a field
Definition: libmwaw_internal.hxx:286
virtual void insertTab()=0
adds a tab
This class contains a virtual interface to all listener.
Definition: MWAWListener.hxx:46
virtual bool closeSection()=0
close a section

Generated on Tue Mar 10 2015 17:32:09 for libmwaw by doxygen 1.8.5