MWAWSubDocument.hxx Source File documentation

MWAWSubDocument.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_SUB_DOCUMENT_HXX
35 #define MWAW_SUB_DOCUMENT_HXX
36
37 #include "libmwaw_internal.hxx"
38 #include "MWAWEntry.hxx"
39
41 class MWAWSubDocument
42 {
43 public:
45 MWAWSubDocument(MWAWParser *pars, MWAWInputStreamPtr ip, MWAWEntry const &z);
47 explicit MWAWSubDocument(MWAWSubDocument const &doc);
49 MWAWSubDocument &operator=(MWAWSubDocument const &doc);
51 virtual ~MWAWSubDocument();
52
54 virtual bool operator!=(MWAWSubDocument const &doc) const;
56 bool operator==(MWAWSubDocument const &doc) const
57 {
58 return !operator!=(doc);
59 }
61 bool operator!=(shared_ptr<MWAWSubDocument> const &doc) const;
63 bool operator==(shared_ptr<MWAWSubDocument> const &doc) const
64 {
65 return !operator!=(doc);
66 }
67
71 virtual void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType subDocumentType) = 0;
72
73 protected:
75 MWAWParser *m_parser;
77 shared_ptr<MWAWInputStream> m_input;
79 MWAWEntry m_zone;
80 };
81
82 #endif
83 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWListenerPtr
shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:519
MWAWSubDocument::operator==
bool operator==(MWAWSubDocument const &doc) const
comparison operator==
Definition: MWAWSubDocument.hxx:56
MWAWEntry.hxx
libmwaw_internal.hxx
libmwaw::SubDocumentType
SubDocumentType
Definition: libmwaw_internal.hxx:192
MWAWSubDocument::operator!=
virtual bool operator!=(MWAWSubDocument const &doc) const
comparison operator!=
Definition: MWAWSubDocument.cxx:62
MWAWSubDocument::m_parser
MWAWParser * m_parser
the main zone parser
Definition: MWAWSubDocument.hxx:75
MWAWSubDocument::operator=
MWAWSubDocument & operator=(MWAWSubDocument const &doc)
copy operator
Definition: MWAWSubDocument.cxx:52
MWAWSubDocument::parse
virtual void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType subDocumentType)=0
virtual parse function
MWAWSubDocument
abstract class used to store a subdocument (with a comparison function)
Definition: MWAWSubDocument.hxx:41
MWAWSubDocument::MWAWSubDocument
MWAWSubDocument(MWAWParser *pars, MWAWInputStreamPtr ip, MWAWEntry const &z)
constructor from parser, input stream and zone in the input
Definition: MWAWSubDocument.cxx:38
MWAWInputStreamPtr
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:517
MWAWSubDocument::operator==
bool operator==(shared_ptr< MWAWSubDocument > const &doc) const
comparison operator==
Definition: MWAWSubDocument.hxx:63
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:99
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MWAWSubDocument::m_input
shared_ptr< MWAWInputStream > m_input
the input
Definition: MWAWSubDocument.hxx:77
MWAWSubDocument::~MWAWSubDocument
virtual ~MWAWSubDocument()
virtual destructor
Definition: MWAWSubDocument.cxx:48
MWAWSubDocument::m_zone
MWAWEntry m_zone
if valid the zone to parse
Definition: MWAWSubDocument.hxx:79