ClarisWksPresentation.hxx Source File documentation

ClarisWksPresentation.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/*
35 * Parser to Claris Works text document ( presentation part )
36 *
37 */
38#ifndef CLARIS_WKS_PRESENTATION
39# define CLARIS_WKS_PRESENTATION
40
41#include <vector>
42
43#include "MWAWEntry.hxx"
44#include "MWAWSubDocument.hxx"
45
46#include "MWAWDebug.hxx"
47#include "MWAWInputStream.hxx"
48
49#include "MWAWParser.hxx"
50
51#include "ClarisWksStruct.hxx"
52
53namespace ClarisWksPresentationInternal
54{
55struct Presentation;
56struct State;
57
58class SubDocument;
59}
60
61class ClarisWksPRParser;
62
63class ClarisWksDocument;
64
70 class ClarisWksPresentation
71{
72 friend class ClarisWksDocument;
73 friend class ClarisWksPRParser;
74 friend class ClarisWksPresentationInternal::SubDocument;
75
76public:
78 explicit ClarisWksPresentation(ClarisWksDocument &document);
80 virtual ~ClarisWksPresentation();
81
83 int version() const;
84
86 int numPages() const;
88 bool updatePageSpanList(MWAWPageSpan const &page, std::vector<MWAWPageSpan> &spanList);
89
91 std::shared_ptr<ClarisWksStruct::DSET> readPresentationZone
92 (ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete);
93
95 void updateSlideTypes() const;
96
98 void disconnectMasterFromContents() const;
99
100protected:
102 bool sendMaster();
104 bool sendZone(int number);
105
107 void flushExtra();
108
109 // interface with main parser
110
112 void askToSend(int number);
113
114 //
115 // Intermediate level
116 //
117
119 bool readZone1(ClarisWksPresentationInternal::Presentation &pres);
120
122 bool readZone2(ClarisWksPresentationInternal::Presentation &pres);
123
124
125 //
126 // low level
127 //
128
129private:
130 ClarisWksPresentation(ClarisWksPresentation const &orig) = delete;
131 ClarisWksPresentation &operator=(ClarisWksPresentation const &orig) = delete;
132
133protected:
134 //
135 // data
136 //
137
139 ClarisWksDocument &m_document;
140
142 MWAWParserStatePtr m_parserState;
143
145 std::shared_ptr<ClarisWksPresentationInternal::State> m_state;
146
148 MWAWParser *m_mainParser;
149};
150#endif
151// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
ClarisWksStruct.hxx
MWAWDebug.hxx
MWAWEntry.hxx
MWAWInputStream.hxx
MWAWParser.hxx
MWAWSubDocument.hxx
ClarisWksDocument
main document information used to create a ClarisWorks file
Definition ClarisWksDocument.hxx:74
ClarisWksPRParser
the main class to create presentation Claris Works file
Definition ClarisWksPRParser.hxx:68
ClarisWksPresentationInternal::SubDocument
Internal: the subdocument of a ClarisWksPresentation.
Definition ClarisWksPresentation.cxx:125
ClarisWksPresentation::readPresentationZone
std::shared_ptr< ClarisWksStruct::DSET > readPresentationZone(ClarisWksStruct::DSET const &zone, MWAWEntry const &entry, bool &complete)
reads the zone presentation DSET
Definition ClarisWksPresentation.cxx:297
ClarisWksPresentation::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition ClarisWksPresentation.hxx:142
ClarisWksPresentation::operator=
ClarisWksPresentation & operator=(ClarisWksPresentation const &orig)=delete
ClarisWksPresentation::updateSlideTypes
void updateSlideTypes() const
update the slide zone types
Definition ClarisWksPresentation.cxx:227
ClarisWksPresentation::disconnectMasterFromContents
void disconnectMasterFromContents() const
disconnect the master zone to the content zones
Definition ClarisWksPresentation.cxx:256
ClarisWksPresentation::ClarisWksPRParser
friend class ClarisWksPRParser
Definition ClarisWksPresentation.hxx:73
ClarisWksPresentation::ClarisWksPresentation
ClarisWksPresentation(ClarisWksDocument &document)
constructor
Definition ClarisWksPresentation.cxx:178
ClarisWksPresentation::m_document
ClarisWksDocument & m_document
the document
Definition ClarisWksPresentation.hxx:139
ClarisWksPresentation::m_state
std::shared_ptr< ClarisWksPresentationInternal::State > m_state
the state
Definition ClarisWksPresentation.hxx:145
ClarisWksPresentation::ClarisWksDocument
friend class ClarisWksDocument
Definition ClarisWksPresentation.hxx:72
ClarisWksPresentation::readZone1
bool readZone1(ClarisWksPresentationInternal::Presentation &pres)
try to read the first presentation zone ( the slide name ?
Definition ClarisWksPresentation.cxx:364
ClarisWksPresentation::ClarisWksPresentation
ClarisWksPresentation(ClarisWksPresentation const &orig)=delete
ClarisWksPresentation::askToSend
void askToSend(int number)
ask the main parser to send a zone
Definition ClarisWksPresentation.cxx:219
ClarisWksPresentation::numPages
int numPages() const
returns the number of pages
Definition ClarisWksPresentation.cxx:194
ClarisWksPresentation::m_mainParser
MWAWParser * m_mainParser
the main parser;
Definition ClarisWksPresentation.hxx:148
ClarisWksPresentation::sendMaster
bool sendMaster()
sends the master zone (ie. the background zone)
Definition ClarisWksPresentation.cxx:483
ClarisWksPresentation::~ClarisWksPresentation
virtual ~ClarisWksPresentation()
destructor
Definition ClarisWksPresentation.cxx:186
ClarisWksPresentation::readZone2
bool readZone2(ClarisWksPresentationInternal::Presentation &pres)
try to read the second presentation zone ( title )
Definition ClarisWksPresentation.cxx:436
ClarisWksPresentation::sendZone
bool sendZone(int number)
sends the zone data to the listener (if it exists )
Definition ClarisWksPresentation.cxx:493
ClarisWksPresentation::updatePageSpanList
bool updatePageSpanList(MWAWPageSpan const &page, std::vector< MWAWPageSpan > &spanList)
updates the page span list and returns true if this is possible
Definition ClarisWksPresentation.cxx:201
ClarisWksPresentation::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition ClarisWksPresentation.cxx:548
ClarisWksPresentation::version
int version() const
returns the file version
Definition ClarisWksPresentation.cxx:189
MWAWEntry
basic class to store an entry in a file This contained :
Definition MWAWEntry.hxx:47
MWAWPageSpan
A class which defines the page properties.
Definition MWAWPageSpan.hxx:99
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition MWAWParser.hxx:100
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition libmwaw_internal.hxx:557
ClarisWksPresentationInternal
Internal: the structures of a ClarisWksPresentation.
Definition ClarisWksPresentation.cxx:58
ClarisWksPresentationInternal::Presentation
Internal the presentation.
Definition ClarisWksPresentation.cxx:60
ClarisWksPresentationInternal::State
Internal: the state of a ClarisWksPresentation.
Definition ClarisWksPresentation.cxx:109
ClarisWksStruct::DSET
main structure which correspond to a document part
Definition ClarisWksStruct.hxx:87