RagTime5Layout.hxx
Go to the documentation of this file.
/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
/* libmwaw
* Version: MPL 2.0 / LGPLv2+
*
* The contents of this file are subject to the Mozilla Public License Version
* 2.0 (the "License"); you may not use this file except in compliance with
* the License or as specified alternatively below. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Major Contributor(s):
* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
* Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
* Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
* Copyright (C) 2006, 2007 Andrew Ziem
* Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
*
*
* All Rights Reserved.
*
* For minor contributions see the git repository.
*
* Alternatively, the contents of this file may be used under the terms of
* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
* in which case the provisions of the LGPLv2+ are applicable
* instead of those above.
*/
/*
* Parser to RagTime 5-6 document ( layout part )
*
*/
#ifndef RAGTIME5_LAYOUT
# define RAGTIME5_LAYOUT
#include <set>
#include <string>
#include <map>
#include <vector>
#include <librevenge/librevenge.h>
#include "libmwaw_internal.hxx"
#include "MWAWDebug.hxx"
#include "MWAWInputStream.hxx"
#include "MWAWPosition.hxx"
#include "RagTime5StructManager.hxx"
#include "RagTime5ClusterManager.hxx"
namespace RagTime5LayoutInternal
{
struct ClusterLayout;
struct State;
}
class RagTime5Document;
class RagTime5StructManager;
class RagTime5Zone;
class RagTime5Layout
{
friend class RagTime5Document;
public:
explicit RagTime5Layout(RagTime5Document &doc);
virtual ~RagTime5Layout();
int version() const;
int numPages() const;
protected:
void flushExtra();
// interface with main parser
std::shared_ptr<RagTime5ClusterManager::Cluster> readLayoutCluster(RagTime5Zone &zone, int zoneType);
//
// Intermediate level
//
void updateLayouts();
void updateLayout(RagTime5LayoutInternal::ClusterLayout &layout);
//
// low level
//
//
// send data
//
bool sendPageContents();
bool send(RagTime5LayoutInternal::ClusterLayout &cluster, MWAWListenerPtr listener, int page);
public:
static std::string printType(unsigned long fileType)
{
return RagTime5StructManager::printType(fileType);
}
private:
RagTime5Layout(RagTime5Layout const &orig) = delete;
RagTime5Layout &operator=(RagTime5Layout const &orig) = delete;
protected:
//
// data
//
RagTime5Document &m_document;
std::shared_ptr<RagTime5StructManager> m_structManager;
MWAWParserStatePtr m_parserState;
std::shared_ptr<RagTime5LayoutInternal::State> m_state;
};
#endif
// 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::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::RagTime5Layout
RagTime5Layout(RagTime5Document &doc)
constructor
Definition RagTime5Layout.cxx:144
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::RagTime5Document
friend class RagTime5Document
Definition RagTime5Layout.hxx:74
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
RagTime5LayoutInternal::State
Internal: the state of a RagTime5Layout.
Definition RagTime5Layout.cxx:120