RagTime5Layout.hxx Source File documentation

RagTime5Layout.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 RagTime 5-6 document ( layout part )
36 *
37 */
38#ifndef RAGTIME5_LAYOUT
39# define RAGTIME5_LAYOUT
40
41#include <set>
42#include <string>
43#include <map>
44#include <vector>
45
46#include <librevenge/librevenge.h>
47
48#include "libmwaw_internal.hxx"
49
50#include "MWAWDebug.hxx"
51#include "MWAWInputStream.hxx"
52#include "MWAWPosition.hxx"
53
54#include "RagTime5StructManager.hxx"
55#include "RagTime5ClusterManager.hxx"
56
57namespace RagTime5LayoutInternal
58{
59struct ClusterLayout;
60struct State;
61}
62
63class RagTime5Document;
64class RagTime5StructManager;
65class RagTime5Zone;
66
72 class RagTime5Layout
73{
74 friend class RagTime5Document;
75
76public:
77
79 explicit RagTime5Layout(RagTime5Document &doc);
81 virtual ~RagTime5Layout();
82
84 int version() const;
85
87 int numPages() const;
88
89protected:
90
92 void flushExtra();
93
94 // interface with main parser
95
97 std::shared_ptr<RagTime5ClusterManager::Cluster> readLayoutCluster(RagTime5Zone &zone, int zoneType);
98
99 //
100 // Intermediate level
101 //
102
104 void updateLayouts();
105
107 void updateLayout(RagTime5LayoutInternal::ClusterLayout &layout);
108 //
109 // low level
110 //
111
112 //
113 // send data
114 //
115
117 bool sendPageContents();
119 bool send(RagTime5LayoutInternal::ClusterLayout &cluster, MWAWListenerPtr listener, int page);
120
121public:
123 static std::string printType(unsigned long fileType)
124 {
125 return RagTime5StructManager::printType(fileType);
126 }
127
128private:
129 RagTime5Layout(RagTime5Layout const &orig) = delete;
130 RagTime5Layout &operator=(RagTime5Layout const &orig) = delete;
131
132protected:
133 //
134 // data
135 //
137 RagTime5Document &m_document;
138
140 std::shared_ptr<RagTime5StructManager> m_structManager;
142 MWAWParserStatePtr m_parserState;
143
145 std::shared_ptr<RagTime5LayoutInternal::State> m_state;
146};
147#endif
148// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWPosition.hxx
RagTime5ClusterManager.hxx
RagTime5StructManager.hxx
RagTime5Document
the main class to read a RagTime v5 file
Definition: RagTime5Document.hxx:77
RagTime5Layout
the main class to read the text part of RagTime 56 file
Definition: RagTime5Layout.hxx:73
RagTime5Layout::updateLayouts
void updateLayouts()
update all internal data: list of master layout, ...
Definition: RagTime5Layout.cxx:211
RagTime5Layout::send
bool send(RagTime5LayoutInternal::ClusterLayout &cluster, MWAWListenerPtr listener, int page)
try to send the cluster zone
Definition: RagTime5Layout.cxx:277
RagTime5Layout::readLayoutCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readLayoutCluster(RagTime5Zone &zone, int zoneType)
try to read a layout cluster
Definition: RagTime5Layout.cxx:1167
RagTime5Layout::RagTime5Layout
RagTime5Layout(RagTime5Layout const &orig)=delete
RagTime5Layout::version
int version() const
returns the file version
Definition: RagTime5Layout.cxx:156
RagTime5Layout::updateLayout
void updateLayout(RagTime5LayoutInternal::ClusterLayout &layout)
check that a layout is valid, ...
Definition: RagTime5Layout.cxx:235
RagTime5Layout::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Layout.hxx:140
RagTime5Layout::numPages
int numPages() const
returns the number of pages
Definition: RagTime5Layout.cxx:161
RagTime5Layout::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Layout.hxx:142
RagTime5Layout::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5Layout.hxx:123
RagTime5Layout::operator=
RagTime5Layout & operator=(RagTime5Layout const &orig)=delete
RagTime5Layout::m_document
RagTime5Document & m_document
the parser
Definition: RagTime5Layout.hxx:137
RagTime5Layout::~RagTime5Layout
virtual ~RagTime5Layout()
destructor
Definition: RagTime5Layout.cxx:152
RagTime5Layout::m_state
std::shared_ptr< RagTime5LayoutInternal::State > m_state
the state
Definition: RagTime5Layout.hxx:145
RagTime5Layout::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: RagTime5Layout.cxx:272
RagTime5Layout::sendPageContents
bool sendPageContents()
try to send the page content corresponding to the layout
Definition: RagTime5Layout.cxx:168
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:175
RagTime5StructManager::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5StructManager.cxx:94
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:51
libmwaw_internal.hxx
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
RagTime5LayoutInternal
Internal: the structures of a RagTime5Layout.
Definition: RagTime5Layout.cxx:63
RagTime5LayoutInternal::ClusterLayout
the layout cluster ( 4001 zone)
Definition: RagTime5Layout.cxx:65