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
53 namespace ClarisWksPresentationInternal
54 {
55 struct Presentation;
56 struct State;
57
58 class SubDocument;
59 }
60
61 class ClarisWksPRParser;
62
63 class ClarisWksDocument;
64
70 class ClarisWksPresentation
71 {
72 friend class ClarisWksDocument;
73 friend class ClarisWksPRParser;
74 friend class ClarisWksPresentationInternal::SubDocument;
75
76 public:
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
100 protected:
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
129 private:
130 ClarisWksPresentation(ClarisWksPresentation const &orig) = delete;
131 ClarisWksPresentation &operator=(ClarisWksPresentation const &orig) = delete;
132
133 protected:
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:
ClarisWksPresentationInternal::State::State
State()
constructor
Definition: ClarisWksPresentation.cxx:111
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
ClarisWksStruct::DSET::m_id
int m_id
the zone identificator
Definition: ClarisWksStruct.hxx:199
ClarisWksPresentationInternal::SubDocument::SubDocument
SubDocument(SubDocument const &orig)=delete
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
ClarisWksPresentationInternal::Presentation::m_contentIdList
std::vector< int > m_contentIdList
the list of main zone id
Definition: ClarisWksPresentation.cxx:91
MWAWPageSpan::setPageSpan
void setPageSpan(const int pageSpan)
set the page span ( default 1)
Definition: MWAWPageSpan.hxx:268
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
MWAWVec2f
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:842
ClarisWksStruct.hxx
libmwaw::DebugFile::addDelimiter
void addDelimiter(long pos, char c)
adds a not breaking delimiter in position pos
Definition: MWAWDebug.cxx:73
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::sendMaster
bool sendMaster()
sends the master zone (ie. the background zone)
Definition: ClarisWksPresentation.cxx:483
ClarisWksPresentationInternal::SubDocument
Internal: the subdocument of a ClarisWksPresentation.
Definition: ClarisWksPresentation.cxx:125
ClarisWksPresentationInternal::Presentation::removeChild
void removeChild(int cId, bool normalChild) final
remove a child from a list.
Definition: ClarisWksPresentation.cxx:84
ClarisWksDocument::getZone
std::shared_ptr< ClarisWksStruct::DSET > getZone(int zId) const
return the zone corresponding to an id ( low level)
Definition: ClarisWksDocument.cxx:415
ClarisWksPresentation.hxx
MWAWEntry.hxx
MWAWFontConverter.hxx
libmwaw::appendUnicode
void appendUnicode(uint32_t val, librevenge::RVNGString &buffer)
adds an unicode character to a string
Definition: libmwaw_internal.cxx:63
MWAWListener::Presentation
@ Presentation
Definition: MWAWListener.hxx:56
ClarisWksDocument::sendZone
bool sendZone(int zoneId, MWAWListenerPtr listener=MWAWListenerPtr(), MWAWPosition pos=MWAWPosition())
try to send a zone
Definition: ClarisWksDocument.cxx:453
ClarisWksPresentation::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: ClarisWksPresentation.cxx:548
ClarisWksPresentationInternal::SubDocument::operator!=
bool operator!=(MWAWSubDocument const &doc) const final
operator!=
Definition: ClarisWksPresentation.cxx:136
ClarisWksDocument
main document information used to create a ClarisWorks file
Definition: ClarisWksDocument.hxx:74
ClarisWksPresentationInternal::SubDocument::m_id
int m_id
the subdocument id
Definition: ClarisWksPresentation.cxx:153
ClarisWksPresentation::disconnectMasterFromContents
void disconnectMasterFromContents() const
disconnect the master zone to the content zones
Definition: ClarisWksPresentation.cxx:256
ClarisWksPresentation::readZone1
bool readZone1(ClarisWksPresentationInternal::Presentation &pres)
try to read the first presentation zone ( the slide name ? )
Definition: ClarisWksPresentation.cxx:364
libmwaw::DebugFile::addNote
void addNote(char const *note)
adds a note in the file, in actual position
Definition: MWAWDebug.cxx:59
MWAWSubDocument
abstract class used to store a subdocument (with a comparison function)
Definition: MWAWSubDocument.hxx:42
ClarisWksStruct
namespace to store the main structure which appears in a ClarisDraw/ClarisWorks file
Definition: ClarisWksStruct.cxx:50
ClarisWksPresentation::numPages
int numPages() const
returns the number of pages
Definition: ClarisWksPresentation.cxx:194
ClarisWksPresentationInternal
Internal: the structures of a ClarisWksPresentation.
Definition: ClarisWksPresentation.cxx:58
MWAWPresentationListenerPtr
std::shared_ptr< MWAWPresentationListener > MWAWPresentationListenerPtr
a smart pointer of MWAWPresentationListener
Definition: libmwaw_internal.hxx:559
MWAWPresentationListener.hxx
ClarisWksPresentationInternal::Presentation::Presentation
Presentation(ClarisWksStruct::DSET const &dset=ClarisWksStruct::DSET())
Definition: ClarisWksPresentation.cxx:62
MWAWSubDocument.hxx
ClarisWksPresentationInternal::SubDocument::m_presentationParser
ClarisWksPresentation * m_presentationParser
the presentation parser
Definition: ClarisWksPresentation.cxx:149
ClarisWksPresentation::m_state
std::shared_ptr< ClarisWksPresentationInternal::State > m_state
the state
Definition: ClarisWksPresentation.hxx:145
ClarisWksPresentation::m_mainParser
MWAWParser * m_mainParser
the main parser;
Definition: ClarisWksPresentation.hxx:148
libmwaw::SubDocumentType
SubDocumentType
Definition: libmwaw_internal.hxx:188
MWAWSubDocument::m_input
std::shared_ptr< MWAWInputStream > m_input
the input
Definition: MWAWSubDocument.hxx:77
MWAWDocument::MWAW_K_PRESENTATION
@ MWAW_K_PRESENTATION
presentation graphic
Definition: MWAWDocument.hxx:85
ClarisWksPRParser
the main class to create presentation Claris Works file
Definition: ClarisWksPRParser.hxx:68
ClarisWksStruct::DSET::m_otherChilds
std::vector< int > m_otherChilds
the list of other child
Definition: ClarisWksStruct.hxx:217
ClarisWksPresentationInternal::Presentation::m_thumbnailsIdList
std::vector< int > m_thumbnailsIdList
the list of thumbnail zone id
Definition: ClarisWksPresentation.cxx:95
ClarisWksStyleManager.hxx
ClarisWksPresentationInternal::State
Internal: the state of a ClarisWksPresentation.
Definition: ClarisWksPresentation.cxx:109
MWAWPosition.hxx
ClarisWksPresentation
the main class to read the text part of Claris Works file
Definition: ClarisWksPresentation.hxx:71
ClarisWksPresentationInternal::SubDocument::parse
void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType type) final
the parser function
Definition: ClarisWksPresentation.cxx:159
ClarisWksPresentation::ClarisWksPresentation
ClarisWksPresentation(ClarisWksPresentation const &orig)=delete
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
ClarisWksPresentationInternal::Presentation::m_masterDetached
bool m_masterDetached
true if the auxiliary zone is detached
Definition: ClarisWksPresentation.cxx:101
ClarisWksStruct::DSET::m_fileType
int m_fileType
the type ( 0: text, -1: graphic, ...)
Definition: ClarisWksStruct.hxx:189
ClarisWksPresentation::m_document
ClarisWksDocument & m_document
the document
Definition: ClarisWksPresentation.hxx:139
ClarisWksPresentationInternal::Presentation::m_titleList
std::vector< librevenge::RVNGString > m_titleList
the list of title
Definition: ClarisWksPresentation.cxx:97
ClarisWksDocument.hxx
MWAWEntry::length
long length() const
returns the length of the zone
Definition: MWAWEntry.hxx:93
ClarisWksPresentationInternal::Presentation::m_noteIdList
std::vector< int > m_noteIdList
the list of notes zone id
Definition: ClarisWksPresentation.cxx:93
MWAWListener::PageBreak
@ PageBreak
Definition: MWAWListener.hxx:58
ClarisWksPresentationInternal::State::m_presentation
std::shared_ptr< Presentation > m_presentation
the main presentation
Definition: ClarisWksPresentation.cxx:117
MWAWDebug.hxx
MWAWEntry::begin
long begin() const
returns the begin offset
Definition: MWAWEntry.hxx:83
ClarisWksStruct::DSET
main structure which correspond to a document part
Definition: ClarisWksStruct.hxx:87
ClarisWksPresentation::ClarisWksPresentation
ClarisWksPresentation(ClarisWksDocument &document)
constructor
Definition: ClarisWksPresentation.cxx:178
ClarisWksPresentation::version
int version() const
returns the file version
Definition: ClarisWksPresentation.cxx:189
ClarisWksPresentationInternal::SubDocument::~SubDocument
~SubDocument() final
destructor
Definition: ClarisWksPresentation.cxx:133
ClarisWksStruct::DSET::DSET
DSET()
constructor
Definition: ClarisWksStruct.hxx:99
MWAWPageSpan::setPageName
void setPageName(librevenge::RVNGString const &name)
set the page name
Definition: MWAWPageSpan.hxx:228
ClarisWksPresentation::~ClarisWksPresentation
virtual ~ClarisWksPresentation()
destructor
Definition: ClarisWksPresentation.cxx:186
MWAWHeader.hxx
Defines MWAWHeader (document's type, version, kind)
ClarisWksStruct::DSET::P_SlideNote
@ P_SlideNote
Definition: ClarisWksStruct.hxx:93
ClarisWksStruct::DSET::P_SlideThumbnail
@ P_SlideThumbnail
Definition: ClarisWksStruct.hxx:93
MWAWEntry::end
long end() const
returns the end offset
Definition: MWAWEntry.hxx:88
libmwaw::DOC_TEXT_BOX
@ DOC_TEXT_BOX
Definition: libmwaw_internal.hxx:188
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
ClarisWksStruct::DSET::Position
Position
the zone position
Definition: ClarisWksStruct.hxx:91
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:100
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
ClarisWksStruct::DSET::m_numData
long m_numData
the number of header
Definition: ClarisWksStruct.hxx:180
ClarisWksPresentationInternal::State::m_presentationMap
std::map< int, std::shared_ptr< Presentation > > m_presentationMap
map zId to presentation
Definition: ClarisWksPresentation.cxx:119
ClarisWksStruct::DSET::m_dataSz
long m_dataSz
the data size
Definition: ClarisWksStruct.hxx:182
MWAWPosition::Page
@ Page
Definition: MWAWPosition.hxx:51
ClarisWksStruct::DSET::C_Zone
@ C_Zone
Definition: ClarisWksStruct.hxx:96
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
libmwaw::DebugFile::addPos
void addPos(long pos)
adds a new position in the file
Definition: MWAWDebug.cxx:53
ClarisWksPresentationInternal::Presentation::m_masterId
int m_masterId
the master zone (background + header/footer)
Definition: ClarisWksPresentation.cxx:99
MWAWEntry::valid
bool valid() const
returns true if the zone length is positive
Definition: MWAWEntry.hxx:99
ClarisWksPresentationInternal::Presentation::~Presentation
~Presentation() final
destructor
Definition: ClarisWksPresentation.cxx:104
libmwaw::DebugFile
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:66
ClarisWksPresentation::operator=
ClarisWksPresentation & operator=(ClarisWksPresentation const &orig)=delete
ClarisWksPresentationInternal::SubDocument::operator=
SubDocument & operator=(SubDocument const &orig)=delete
ClarisWksPresentation::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: ClarisWksPresentation.hxx:142
MWAWInputStream.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
MWAWFont.hxx
MWAWPosition::m_anchorTo
AnchorTo m_anchorTo
anchor position
Definition: MWAWPosition.hxx:270
ClarisWksStruct::DSET::P_SlideMaster
@ P_SlideMaster
Definition: ClarisWksStruct.hxx:93
ClarisWksStruct::DSET::m_headerSz
long m_headerSz
the header size
Definition: ClarisWksStruct.hxx:184
ClarisWksPresentation::updateSlideTypes
void updateSlideTypes() const
update the slide zone types
Definition: ClarisWksPresentation.cxx:227
ClarisWksPresentationInternal::SubDocument::SubDocument
SubDocument(ClarisWksPresentation &pars, MWAWInputStreamPtr const &input, int zoneId)
Definition: ClarisWksPresentation.cxx:127
libmwaw::DebugStream
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:61
MWAWParser.hxx
ClarisWksPresentation::askToSend
void askToSend(int number)
ask the main parser to send a zone
Definition: ClarisWksPresentation.cxx:219
ClarisWksDocument::forceParsed
void forceParsed(int zoneId)
indicates that a zone is parser
Definition: ClarisWksDocument.cxx:2580
ClarisWksStruct::DSET::P_Slide
@ P_Slide
Definition: ClarisWksStruct.hxx:93
MWAWPageSpan
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:99
ClarisWksPresentationInternal::Presentation
Internal the presentation.
Definition: ClarisWksPresentation.cxx:60