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 <vector>
43
44 #include "libstaroffice_internal.hxx"
45 #include "StarObject.hxx"
46
47 namespace StarObjectModelInternal
48 {
49 class Layer;
50 class LayerSet;
51 class Page;
52 struct State;
53 }
54
55 class StarZone;
56
62 class StarObjectModel : public StarObject
63 {
64 public:
66 StarObjectModel(StarObject const &orig, bool duplicateState);
68 ~StarObjectModel() override;
70 bool read(StarZone &zone);
71
73 bool updatePageSpans(std::vector<STOFFPageSpan> &pageSpan, int &numPages) const;
75 bool sendMasterPages(STOFFGraphicListenerPtr listener);
77 bool sendPages(STOFFListenerPtr listener);
79 bool sendPage(int pageId, STOFFListenerPtr listener, bool masterPage=false);
81 friend std::ostream &operator<<(std::ostream &o, StarObjectModel const &model);
82 protected:
83 //
84 // low level
85 //
87 bool readSdrLayer(StarZone &zone, StarObjectModelInternal::Layer &layer);
89 bool readSdrLayerSet(StarZone &zone, StarObjectModelInternal::LayerSet &layers);
91 std::shared_ptr<StarObjectModelInternal::Page> readSdrPage(StarZone &zone);
92 /* try to read a Master Page descriptor zone: "DrMP' and add it the master page descriptor */
93 bool readSdrMPageDesc(StarZone &zone, StarObjectModelInternal::Page &page);
94 /* try to read a list of Master Page zone: "DrML' and add them in the master page descriptors */
95 bool readSdrMPageDescList(StarZone &zone, StarObjectModelInternal::Page &page);
97 bool readSdrPageUnknownZone1(StarZone &zone, long lastPos);
98
99
100 protected:
101 //
102 // data
103 //
104
106 std::shared_ptr<StarObjectModelInternal::State> m_modelState;
107 private:
108 StarObjectModel &operator=(StarObjectModel const &orig) = delete;
109 };
110 #endif
111 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
StarObjectModel::operator<<
friend std::ostream & operator<<(std::ostream &o, StarObjectModel const &model)
small operator<< to print the content of the model
Definition: StarObjectModel.cxx:345
StarObjectModel::operator=
StarObjectModel & operator=(StarObjectModel const &orig)=delete
StarObjectModel::m_modelState
std::shared_ptr< StarObjectModelInternal::State > m_modelState
the state
Definition: StarObjectModel.hxx:106
StarObjectModelInternal::Page
Internal: class used to store a page and its data.
Definition: StarObjectModel.cxx:136
StarObject.hxx
StarObjectModelInternal::LayerSet
Internal: class used to store a layer set and its data.
Definition: StarObjectModel.cxx:100
StarObjectModel::read
bool read(StarZone &zone)
try to read a SdrModel zone: "DrMd"
Definition: StarObjectModel.cxx:452
StarObjectModel
the main class to read a SdrModel zone
Definition: StarObjectModel.hxx:62
StarObjectModel::sendPages
bool sendPages(STOFFListenerPtr listener)
try to send the different page
Definition: StarObjectModel.cxx:382
StarObjectModel::readSdrLayerSet
bool readSdrLayerSet(StarZone &zone, StarObjectModelInternal::LayerSet &layers)
try to read a SdrLayerSet zone: "DrLS&#39;
Definition: StarObjectModel.cxx:784
StarObjectModel::updatePageSpans
bool updatePageSpans(std::vector< STOFFPageSpan > &pageSpan, int &numPages) const
try to update the page span (to create draw document)
Definition: StarObjectModel.cxx:354
StarObjectModel::sendPage
bool sendPage(int pageId, STOFFListenerPtr listener, bool masterPage=false)
try to send a page content
Definition: StarObjectModel.cxx:424
StarObjectModelInternal
Internal: the structures of a StarObjectModel.
Definition: StarObjectModel.cxx:57
StarObjectModel::readSdrPage
std::shared_ptr< StarObjectModelInternal::Page > readSdrPage(StarZone &zone)
try to read a Page/MasterPage zone: "DrPg&#39;
Definition: StarObjectModel.cxx:839
StarObjectModel::readSdrLayer
bool readSdrLayer(StarZone &zone, StarObjectModelInternal::Layer &layer)
try to read a SdrLayer zone: "DrLy&#39;
Definition: StarObjectModel.cxx:732
libstaroffice_internal.hxx
STOFFGraphicListenerPtr
std::shared_ptr< STOFFGraphicListener > STOFFGraphicListenerPtr
a smart pointer of STOFFGraphicListener
Definition: libstaroffice_internal.hxx:480
StarObjectModel::~StarObjectModel
~StarObjectModel() override
destructor
Definition: StarObjectModel.cxx:341
StarObjectModel::readSdrMPageDescList
bool readSdrMPageDescList(StarZone &zone, StarObjectModelInternal::Page &page)
Definition: StarObjectModel.cxx:1218
StarObjectModelInternal::Layer
Internal: class used to store a layer and its data.
Definition: StarObjectModel.cxx:73
StarObjectModel::StarObjectModel
StarObjectModel(StarObject const &orig, bool duplicateState)
constructor
Definition: StarObjectModel.cxx:335
STOFFListenerPtr
std::shared_ptr< STOFFListener > STOFFListenerPtr
a smart pointer of STOFFListener
Definition: libstaroffice_internal.hxx:486
StarObjectModel::readSdrPageUnknownZone1
bool readSdrPageUnknownZone1(StarZone &zone, long lastPos)
try to read a zone which appear at end of a zone: "DrPg&#39;
Definition: StarObjectModel.cxx:1114
StarObject
an object corresponding to an OLE directory
Definition: StarObject.hxx:64
StarZone
a zone in a StarOffice file
Definition: StarZone.hxx:56
StarObjectModel::readSdrMPageDesc
bool readSdrMPageDesc(StarZone &zone, StarObjectModelInternal::Page &page)
Definition: StarObjectModel.cxx:1180
StarObjectModel::sendMasterPages
bool sendMasterPages(STOFFGraphicListenerPtr listener)
try to send the master pages
Definition: StarObjectModel.cxx:399