FullWrtStruct.hxx Source File documentation

FullWrtStruct.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 * basic structure used to code zone when converting FullWrite document
36 *
37 */
38 #ifndef FULL_WRT_STRUCT
39 # define FULL_WRT_STRUCT
40
41 #include <librevenge/librevenge.h>
42
43 #include "libmwaw_internal.hxx"
44
45 #include "MWAWDebug.hxx"
46 #include "MWAWEntry.hxx"
47
49 namespace FullWrtStruct
50 {
51
52 // basic
53 struct Entry;
55 bool getColor(int color, MWAWColor &col);
57 std::string getTypeName(int type);
58
60 struct Border {
62 Border()
63 : m_frameBorder()
64 , m_frontColor(MWAWColor::black())
65 , m_backColor(MWAWColor::white())
66 , m_shadowColor(MWAWColor::black())
67 , m_shadowDepl(0,0)
68 , m_flags(0)
69 , m_extra("")
70 {
71 m_frameBorder.m_style=MWAWBorder::None;
72 for (auto &type : m_type) type=0;
73 }
75 static MWAWBorder getBorder(int type);
77 void addTo(MWAWGraphicStyle &style) const;
79 bool hasShadow() const
80 {
81 return m_shadowDepl[0]||m_shadowDepl[1];
82 }
84 bool read(std::shared_ptr<FullWrtStruct::Entry> zone, int fSz);
86 std::vector<MWAWVariable<MWAWBorder> > getParagraphBorders() const;
88 friend std::ostream &operator<<(std::ostream &o, Border const &p);
89
91 int m_type[3];
93 MWAWBorder m_frameBorder;
95 MWAWColor m_frontColor;
97 MWAWColor m_backColor;
99 MWAWColor m_shadowColor;
101 MWAWVec2i m_shadowDepl;
103 MWAWColor m_color[2];
105 int m_flags;
107 std::string m_extra;
108 };
109
111 struct Entry : public MWAWEntry {
112 explicit Entry(MWAWInputStreamPtr const &input);
113 ~Entry() final;
114
116 friend std::ostream &operator<<(std::ostream &o, Entry const &entry);
117
119 bool valid() const;
121 void update();
123 void closeDebugFile();
124
126 libmwaw::DebugFile &getAsciiFile();
128 bool operator==(const Entry &a) const;
130 bool operator!=(const Entry &a) const
131 {
132 return !operator==(a);
133 }
134
136 MWAWInputStreamPtr m_input;
138 int m_nextId;
140 int m_type;
142 int m_typeId;
144 int m_values[3];
146 librevenge::RVNGBinaryData m_data;
148 std::shared_ptr<libmwaw::DebugFile> m_asciiFile;
149 private:
150 Entry(Entry const &) = delete;
151 Entry &operator=(Entry const &) = delete;
152 };
153 typedef std::shared_ptr<Entry> EntryPtr;
154
156 struct ZoneHeader {
158 ZoneHeader()
159 : m_type(-1)
160 , m_docId(-1)
161 , m_fileId(-1)
162 , m_wrapping(-1)
163 , m_extra("") {}
165 virtual ~ZoneHeader();
167 bool read(std::shared_ptr<FullWrtStruct::Entry> zone);
169 friend std::ostream &operator<<(std::ostream &o, ZoneHeader const &dt);
171 int m_type;
173 int m_docId;
175 int m_fileId;
177 int m_wrapping;
179 std::string m_extra;
180 };
181 }
182
183 #endif
184 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
FullWrtStruct::ZoneHeader
a structure used to store the data of a zone header in a FullWrite file
Definition: FullWrtStruct.hxx:156
FullWrtStruct::Border::Border
Border()
constructor
Definition: FullWrtStruct.hxx:62
FullWrtStruct::getTypeName
std::string getTypeName(int type)
returns the type name
Definition: FullWrtStruct.cxx:66
FullWrtStruct::Entry::m_typeId
int m_typeId
the type id (find in FZoneFlags)
Definition: FullWrtStruct.hxx:142
FullWrtStruct::ZoneHeader::~ZoneHeader
virtual ~ZoneHeader()
destructor
Definition: FullWrtStruct.cxx:415
FullWrtStruct::Border::m_shadowColor
MWAWColor m_shadowColor
the shadow color
Definition: FullWrtStruct.hxx:99
FullWrtStruct::Border::m_frontColor
MWAWColor m_frontColor
the front color (used for layout )
Definition: FullWrtStruct.hxx:95
FullWrtStruct::Entry::m_data
librevenge::RVNGBinaryData m_data
the main data ( if the entry comes from several zone )
Definition: FullWrtStruct.hxx:146
MWAWEntry.hxx
libmwaw_internal.hxx
FullWrtStruct::ZoneHeader::m_fileId
int m_fileId
the file id
Definition: FullWrtStruct.hxx:175
FullWrtStruct::Entry::update
void update()
create a inputstream, ... if needed
Definition: FullWrtStruct.cxx:368
FullWrtStruct::ZoneHeader::m_type
int m_type
the zone type
Definition: FullWrtStruct.hxx:171
libmwaw::DebugFile
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:65
FullWrtStruct::Entry::operator<<
friend std::ostream & operator<<(std::ostream &o, Entry const &entry)
operator<<
Definition: FullWrtStruct.cxx:318
MWAWGraphicStyle
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:47
FullWrtStruct::Entry::Entry
Entry(MWAWInputStreamPtr const &input)
Definition: FullWrtStruct.cxx:302
FullWrtStruct::Border::m_frameBorder
MWAWBorder m_frameBorder
the frame border
Definition: FullWrtStruct.hxx:93
FullWrtStruct::ZoneHeader::ZoneHeader
ZoneHeader()
constructor
Definition: FullWrtStruct.hxx:158
FullWrtStruct::Entry::getAsciiFile
libmwaw::DebugFile & getAsciiFile()
returns a reference to the ascii file
Definition: FullWrtStruct.cxx:394
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192
FullWrtStruct::Entry::operator=
Entry & operator=(Entry const &)=delete
FullWrtStruct::Entry::m_type
int m_type
the zone type id find in DStruct
Definition: FullWrtStruct.hxx:140
MWAWBorder
a border
Definition: libmwaw_internal.hxx:333
FullWrtStruct::Border::getBorder
static MWAWBorder getBorder(int type)
return a border corresponding to a type
Definition: FullWrtStruct.cxx:118
FullWrtStruct::Entry::m_nextId
int m_nextId
the next entry id
Definition: FullWrtStruct.hxx:138
FullWrtStruct::Border::m_backColor
MWAWColor m_backColor
the back color (used for layout )
Definition: FullWrtStruct.hxx:97
FullWrtStruct::Border::m_flags
int m_flags
the flags
Definition: FullWrtStruct.hxx:105
FullWrtStruct::ZoneHeader::m_wrapping
int m_wrapping
the wrapping type
Definition: FullWrtStruct.hxx:177
FullWrtStruct::Entry::operator==
bool operator==(const Entry &a) const
basic operator==
Definition: FullWrtStruct.cxx:399
FullWrtStruct::Entry::m_asciiFile
std::shared_ptr< libmwaw::DebugFile > m_asciiFile
the debug file
Definition: FullWrtStruct.hxx:148
FullWrtStruct::Entry::operator!=
bool operator!=(const Entry &a) const
basic operator!=
Definition: FullWrtStruct.hxx:130
FullWrtStruct::Entry::valid
bool valid() const
returns true if the entry and the input is valid
Definition: FullWrtStruct.cxx:363
MWAWBorder::None
Definition: libmwaw_internal.hxx:335
FullWrtStruct::ZoneHeader::operator<<
friend std::ostream & operator<<(std::ostream &o, ZoneHeader const &dt)
the operator<<
Definition: FullWrtStruct.cxx:523
FullWrtStruct::Border::m_type
int m_type[3]
the type (border, horizontal and vertical separators)
Definition: FullWrtStruct.hxx:91
FullWrtStruct::Border::m_extra
std::string m_extra
some extra data
Definition: FullWrtStruct.hxx:107
FullWrtStruct::Border::m_shadowDepl
MWAWVec2i m_shadowDepl
the shadow depl ( if shadow)
Definition: FullWrtStruct.hxx:101
FullWrtStruct::Border::m_color
MWAWColor m_color[2]
the colors line + ?
Definition: FullWrtStruct.hxx:103
FullWrtStruct::ZoneHeader::m_docId
int m_docId
the doc id
Definition: FullWrtStruct.hxx:173
FullWrtStruct::Border::addTo
void addTo(MWAWGraphicStyle &style) const
add to frame properties
Definition: FullWrtStruct.cxx:127
FullWrtStruct::Border::getParagraphBorders
std::vector< MWAWVariable< MWAWBorder > > getParagraphBorders() const
returns the list of border order MWAWBorder::Pos
Definition: FullWrtStruct.cxx:224
MWAWBorder::m_style
Style m_style
the border style
Definition: libmwaw_internal.hxx:380
FullWrtStruct::Border::operator<<
friend std::ostream & operator<<(std::ostream &o, Border const &p)
operator<<
Definition: FullWrtStruct.cxx:243
FullWrtStruct
a namespace use to define common structure in a FullWrite file
Definition: FullWrtStruct.cxx:43
MWAWDebug.hxx
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:547
FullWrtStruct::Border::read
bool read(std::shared_ptr< FullWrtStruct::Entry > zone, int fSz)
try to read a border definiton
Definition: FullWrtStruct.cxx:142
FullWrtStruct::getColor
bool getColor(int color, MWAWColor &col)
try to convert a file data to a color
Definition: FullWrtStruct.cxx:45
FullWrtStruct::EntryPtr
std::shared_ptr< Entry > EntryPtr
Definition: FullWrtStruct.hxx:153
FullWrtStruct::Entry::closeDebugFile
void closeDebugFile()
write the debug file, ...
Definition: FullWrtStruct.cxx:388
FullWrtStruct::ZoneHeader::read
bool read(std::shared_ptr< FullWrtStruct::Entry > zone)
try to read the data header of a classical zone
Definition: FullWrtStruct.cxx:419
FullWrtStruct::Border
Internal: class to store a border which appear in docInfo.
Definition: FullWrtStruct.hxx:60
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
FullWrtStruct::Entry
the definition of a zone in a FullWrite file
Definition: FullWrtStruct.hxx:111
FullWrtStruct::ZoneHeader::m_extra
std::string m_extra
some extra data
Definition: FullWrtStruct.hxx:179
FullWrtStruct::Border::hasShadow
bool hasShadow() const
return true if we have a shadow
Definition: FullWrtStruct.hxx:79
FullWrtStruct::Entry::m_input
MWAWInputStreamPtr m_input
the input
Definition: FullWrtStruct.hxx:136
FullWrtStruct::Entry::~Entry
~Entry() final
Definition: FullWrtStruct.cxx:313
FullWrtStruct::Entry::m_values
int m_values[3]
some unknown values
Definition: FullWrtStruct.hxx:144
MWAWVec2< int >