FullWrtGraph.hxx Source File documentation

FullWrtGraph.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 FullWrite Text document ( graphic part )
36 *
37 */
38#ifndef FULL_WRT_GRAPH
39# define FULL_WRT_GRAPH
40
41#include <string>
42#include <vector>
43
44#include <librevenge/librevenge.h>
45
46#include "libmwaw_internal.hxx"
47
48#include "MWAWDebug.hxx"
49#include "MWAWInputStream.hxx"
50
51#include "FullWrtStruct.hxx"
52
53namespace FullWrtGraphInternal
54{
55struct SideBar;
56struct State;
57class SubDocument;
58}
59
60class FullWrtParser;
61
67 class FullWrtGraph
68{
69 friend class FullWrtParser;
70 friend class FullWrtGraphInternal::SubDocument;
71
72public:
74 explicit FullWrtGraph(FullWrtParser &parser);
76 virtual ~FullWrtGraph();
77
79 int version() const;
80
82 int numPages() const;
83
84protected:
86 void flushExtra();
87
89 bool sendPageGraphics();
90
92 bool getBorder(int bId, FullWrtStruct::Border &border) const;
93
94 //
95 // Intermediate level
96 //
97
98 // interface with main parser
99
101 bool send(int fileId, MWAWColor const &fontColor);
102
103 //
104 // low level
105 //
106
108 bool readBorderDocInfo(FullWrtStruct::EntryPtr zone);
109
111 std::shared_ptr<FullWrtStruct::ZoneHeader> readSideBar
112 (FullWrtStruct::EntryPtr zone, FullWrtStruct::ZoneHeader const &doc);
114 bool readSideBarPosition(FullWrtStruct::EntryPtr zone, FullWrtGraphInternal::SideBar &frame);
116 bool readSideBarFormat(FullWrtStruct::EntryPtr zone, FullWrtGraphInternal::SideBar &frame);
118 bool readSideBarUnknown(FullWrtStruct::EntryPtr zone, FullWrtGraphInternal::SideBar &frame);
120 bool sendSideBar(FullWrtGraphInternal::SideBar const &frame);
122 bool readGraphic(FullWrtStruct::EntryPtr zone);
124 bool sendGraphic(int fId);
126 bool sendGraphic(FullWrtStruct::EntryPtr zone);
127
129 std::shared_ptr<FullWrtStruct::ZoneHeader> readGraphicData
130 (FullWrtStruct::EntryPtr zone, FullWrtStruct::ZoneHeader &doc);
131private:
132 FullWrtGraph(FullWrtGraph const &orig) = delete;
133 FullWrtGraph &operator=(FullWrtGraph const &orig) = delete;
134
135protected:
136 //
137 // data
138 //
140 MWAWParserStatePtr m_parserState;
141
143 std::shared_ptr<FullWrtGraphInternal::State> m_state;
144
146 FullWrtParser *m_mainParser;
147};
148#endif
149// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
FullWrtStruct.hxx
MWAWDebug.hxx
MWAWInputStream.hxx
FullWrtGraphInternal::SubDocument
Internal: the subdocument of a FullWrtGraph.
Definition: FullWrtGraph.cxx:104
FullWrtGraph
the main class to read the graphic part of a FullWrite Text file
Definition: FullWrtGraph.hxx:68
FullWrtGraph::~FullWrtGraph
virtual ~FullWrtGraph()
destructor
Definition: FullWrtGraph.cxx:170
FullWrtGraph::sendGraphic
bool sendGraphic(int fId)
send a graphic knowing the graphic fileId
Definition: FullWrtGraph.cxx:694
FullWrtGraph::m_state
std::shared_ptr< FullWrtGraphInternal::State > m_state
the state
Definition: FullWrtGraph.hxx:143
FullWrtGraph::send
bool send(int fileId, MWAWColor const &fontColor)
try to send the child of a zone
Definition: FullWrtGraph.cxx:206
FullWrtGraph::readSideBar
std::shared_ptr< FullWrtStruct::ZoneHeader > readSideBar(FullWrtStruct::EntryPtr zone, FullWrtStruct::ZoneHeader const &doc)
try to read a sidebar data (zone 13 or zone 14)
Definition: FullWrtGraph.cxx:275
FullWrtGraph::readBorderDocInfo
bool readBorderDocInfo(FullWrtStruct::EntryPtr zone)
try to read the border definiton (at the end of doc info)
Definition: FullWrtGraph.cxx:223
FullWrtGraph::readGraphic
bool readGraphic(FullWrtStruct::EntryPtr zone)
check if a zone is a graphic zone
Definition: FullWrtGraph.cxx:635
FullWrtGraph::readSideBarFormat
bool readSideBarFormat(FullWrtStruct::EntryPtr zone, FullWrtGraphInternal::SideBar &frame)
try to read the sidebar second zone
Definition: FullWrtGraph.cxx:423
FullWrtGraph::sendPageGraphics
bool sendPageGraphics()
try to send the page graphic
Definition: FullWrtGraph.cxx:774
FullWrtGraph::version
int version() const
returns the file version
Definition: FullWrtGraph.cxx:174
FullWrtGraph::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: FullWrtGraph.cxx:785
FullWrtGraph::readSideBarPosition
bool readSideBarPosition(FullWrtStruct::EntryPtr zone, FullWrtGraphInternal::SideBar &frame)
try to read the sidebar position zone
Definition: FullWrtGraph.cxx:356
FullWrtGraph::sendSideBar
bool sendSideBar(FullWrtGraphInternal::SideBar const &frame)
try to send a sidebar
Definition: FullWrtGraph.cxx:530
FullWrtGraph::readSideBarUnknown
bool readSideBarUnknown(FullWrtStruct::EntryPtr zone, FullWrtGraphInternal::SideBar &frame)
try to read the sidebar third zone
Definition: FullWrtGraph.cxx:483
FullWrtGraph::FullWrtGraph
FullWrtGraph(FullWrtGraph const &orig)=delete
FullWrtGraph::m_mainParser
FullWrtParser * m_mainParser
the main parser;
Definition: FullWrtGraph.hxx:146
FullWrtGraph::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: FullWrtGraph.hxx:140
FullWrtGraph::operator=
FullWrtGraph & operator=(FullWrtGraph const &orig)=delete
FullWrtGraph::numPages
int numPages() const
returns the number of pages
Definition: FullWrtGraph.cxx:181
FullWrtGraph::readGraphicData
std::shared_ptr< FullWrtStruct::ZoneHeader > readGraphicData(FullWrtStruct::EntryPtr zone, FullWrtStruct::ZoneHeader &doc)
try to read the graphic data
Definition: FullWrtGraph.cxx:556
FullWrtGraph::getBorder
bool getBorder(int bId, FullWrtStruct::Border &border) const
try to return a border corresponding to an id
Definition: FullWrtGraph.cxx:195
FullWrtParser
the main class to read a FullWrite file
Definition: FullWrtParser.hxx:67
libmwaw_internal.hxx
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
FullWrtGraphInternal
Internal: the structures of a FullWrtGraph.
Definition: FullWrtGraph.cxx:55
FullWrtStruct::EntryPtr
std::shared_ptr< Entry > EntryPtr
Definition: FullWrtStruct.hxx:153
FullWrtGraphInternal::SideBar
Internal: the sidebar of a FullWrtGraph.
Definition: FullWrtGraph.cxx:58
FullWrtStruct::Border
Internal: class to store a border which appear in docInfo.
Definition: FullWrtStruct.hxx:60
FullWrtStruct::ZoneHeader
a structure used to store the data of a zone header in a FullWrite file
Definition: FullWrtStruct.hxx:156
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192