StarObjectModel.hxx Source File documentation

StarObjectModel.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/* libstaroffice
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 convert a SdrModel zone/OLE in a StarOffice document
36 *
37 */
38#ifndef STAR_OBJECT_MODEL
39# define STAR_OBJECT_MODEL
40
41#include <ostream>
42#include <set>
43#include <vector>
44
45#include "libstaroffice_internal.hxx"
46#include "StarObject.hxx"
47
48namespace StarObjectModelInternal
49{
50class Layer;
51class LayerSet;
52class Page;
53struct State;
54}
55
56class StarState;
57class StarZone;
58
64 class StarObjectModel : public StarObject
65{
66public:
68 StarObjectModel(StarObject const &orig, bool duplicateState);
70 ~StarObjectModel() override;
72 bool read(StarZone &zone);
77 void updateObjectIds(std::set<long> &unusedId);
79 bool updatePageSpans(std::vector<STOFFPageSpan> &pageSpan, int &numPages, bool usePage0=false) const;
81 bool sendMasterPages(STOFFGraphicListenerPtr listener);
83 bool sendPages(STOFFListenerPtr listener);
85 bool sendPage(int pageId, STOFFListenerPtr listener, bool masterPage=false);
87 bool sendObject(int id, STOFFListenerPtr listener, StarState const &state);
88
90 friend std::ostream &operator<<(std::ostream &o, StarObjectModel const &model);
91protected:
92 //
93 // low level
94 //
96 bool readSdrLayer(StarZone &zone, StarObjectModelInternal::Layer &layer);
98 bool readSdrLayerSet(StarZone &zone, StarObjectModelInternal::LayerSet &layers);
100 std::shared_ptr<StarObjectModelInternal::Page> readSdrPage(StarZone &zone);
101 /* try to read a Master Page descriptor zone: "DrMP' and add it the master page descriptor */
102 bool readSdrMPageDesc(StarZone &zone, StarObjectModelInternal::Page &page);
103 /* try to read a list of Master Page zone: "DrML' and add them in the master page descriptors */
104 bool readSdrMPageDescList(StarZone &zone, StarObjectModelInternal::Page &page);
106 bool readSdrPageUnknownZone1(StarZone &zone, long lastPos);
107
108
109protected:
110 //
111 // data
112 //
113
115 std::shared_ptr<StarObjectModelInternal::State> m_modelState;
116private:
117 StarObjectModel &operator=(StarObjectModel const &orig) = delete;
118};
119#endif
120// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
StarObject.hxx
StarObjectModelInternal::LayerSet
Internal: class used to store a layer set and its data.
Definition StarObjectModel.cxx:103
StarObjectModelInternal::Layer
Internal: class used to store a layer and its data.
Definition StarObjectModel.cxx:76
StarObjectModelInternal::Page
Internal: class used to store a page and its data.
Definition StarObjectModel.cxx:139
StarObjectModel
the main class to read a SdrModel zone
Definition StarObjectModel.hxx:65
StarObjectModel::updateObjectIds
void updateObjectIds(std::set< long > &unusedId)
try to update the object id of page 0
Definition StarObjectModel.cxx:398
StarObjectModel::readSdrPageUnknownZone1
bool readSdrPageUnknownZone1(StarZone &zone, long lastPos)
try to read a zone which appear at end of a zone: "DrPg'
Definition StarObjectModel.cxx:1151
StarObjectModel::StarObjectModel
StarObjectModel(StarObject const &orig, bool duplicateState)
constructor
Definition StarObjectModel.cxx:341
StarObjectModel::read
bool read(StarZone &zone)
try to read a SdrModel zone: "DrMd"
Definition StarObjectModel.cxx:494
StarObjectModel::readSdrPage
std::shared_ptr< StarObjectModelInternal::Page > readSdrPage(StarZone &zone)
try to read a Page/MasterPage zone: "DrPg'
Definition StarObjectModel.cxx:881
StarObjectModel::readSdrLayer
bool readSdrLayer(StarZone &zone, StarObjectModelInternal::Layer &layer)
try to read a SdrLayer zone: "DrLy'
Definition StarObjectModel.cxx:774
StarObjectModel::updatePageSpans
bool updatePageSpans(std::vector< STOFFPageSpan > &pageSpan, int &numPages, bool usePage0=false) const
try to update the page span (to create draw document)
Definition StarObjectModel.cxx:360
StarObjectModel::sendPage
bool sendPage(int pageId, STOFFListenerPtr listener, bool masterPage=false)
try to send a page content
Definition StarObjectModel.cxx:466
StarObjectModel::sendObject
bool sendObject(int id, STOFFListenerPtr listener, StarState const &state)
try to send an object
Definition StarObjectModel.cxx:412
StarObjectModel::sendPages
bool sendPages(STOFFListenerPtr listener)
try to send the different page
Definition StarObjectModel.cxx:422
StarObjectModel::m_modelState
std::shared_ptr< StarObjectModelInternal::State > m_modelState
the state
Definition StarObjectModel.hxx:115
StarObjectModel::operator=
StarObjectModel & operator=(StarObjectModel const &orig)=delete
StarObjectModel::readSdrMPageDesc
bool readSdrMPageDesc(StarZone &zone, StarObjectModelInternal::Page &page)
Definition StarObjectModel.cxx:1217
StarObjectModel::sendMasterPages
bool sendMasterPages(STOFFGraphicListenerPtr listener)
try to send the master pages
Definition StarObjectModel.cxx:439
StarObjectModel::readSdrMPageDescList
bool readSdrMPageDescList(StarZone &zone, StarObjectModelInternal::Page &page)
Definition StarObjectModel.cxx:1255
StarObjectModel::~StarObjectModel
~StarObjectModel() override
destructor
Definition StarObjectModel.cxx:347
StarObjectModel::readSdrLayerSet
bool readSdrLayerSet(StarZone &zone, StarObjectModelInternal::LayerSet &layers)
try to read a SdrLayerSet zone: "DrLS'
Definition StarObjectModel.cxx:826
StarObjectModel::operator<<
friend std::ostream & operator<<(std::ostream &o, StarObjectModel const &model)
small operator<< to print the content of the model
Definition StarObjectModel.cxx:351
StarObject
an object corresponding to an OLE directory
Definition StarObject.hxx:65
StarState
class to store an state: ie.
Definition StarState.hxx:68
StarZone
a zone in a StarOffice file
Definition StarZone.hxx:57
libstaroffice_internal.hxx
STOFFGraphicListenerPtr
std::shared_ptr< STOFFGraphicListener > STOFFGraphicListenerPtr
a smart pointer of STOFFGraphicListener
Definition libstaroffice_internal.hxx:487
STOFFListenerPtr
std::shared_ptr< STOFFListener > STOFFListenerPtr
a smart pointer of STOFFListener
Definition libstaroffice_internal.hxx:491
StarObjectModelInternal
Internal: the structures of a StarObjectModel.
Definition StarObjectModel.cxx:60