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() :m_frameBorder(), m_frontColor(MWAWColor::black()), m_backColor(MWAWColor::white()),
63 m_shadowColor(MWAWColor::black()), m_shadowDepl(0,0), m_flags(0), m_extra("")
64 {
65 m_frameBorder.m_style=MWAWBorder::None;
66 for (int w=0; w < 3; w++) m_type[w]=0;
67 }
69 static MWAWBorder getBorder(int type);
71 void addTo(MWAWGraphicStyle &style) const;
73 bool hasShadow() const
74 {
75 return m_shadowDepl[0]||m_shadowDepl[1];
76 }
78 bool read(shared_ptr<FullWrtStruct::Entry> zone, int fSz);
80 std::vector<MWAWVariable<MWAWBorder> > getParagraphBorders() const;
82 friend std::ostream &operator<<(std::ostream &o, Border const &p);
83
85 int m_type[3];
87 MWAWBorder m_frameBorder;
89 MWAWColor m_frontColor;
91 MWAWColor m_backColor;
93 MWAWColor m_shadowColor;
95 MWAWVec2i m_shadowDepl;
97 MWAWColor m_color[2];
99 int m_flags;
101 std::string m_extra;
102 };
103
105 struct Entry : public MWAWEntry {
106 explicit Entry(MWAWInputStreamPtr input);
107 ~Entry();
108
110 friend std::ostream &operator<<(std::ostream &o, Entry const &entry);
111
113 bool valid() const;
115 void update();
117 void closeDebugFile();
118
120 libmwaw::DebugFile &getAsciiFile();
122 bool operator==(const Entry &a) const;
124 bool operator!=(const Entry &a) const
125 {
126 return !operator==(a);
127 }
128
130 MWAWInputStreamPtr m_input;
132 int m_nextId;
134 int m_type;
136 int m_typeId;
138 int m_values[3];
140 librevenge::RVNGBinaryData m_data;
142 shared_ptr<libmwaw::DebugFile> m_asciiFile;
143 private:
144 Entry(Entry const &);
145 Entry &operator=(Entry const &);
146 };
147 typedef shared_ptr<Entry> EntryPtr;
148
150 struct ZoneHeader {
152 ZoneHeader() : m_type(-1), m_docId(-1), m_fileId(-1), m_wrapping(-1), m_extra("") {}
154 virtual ~ZoneHeader();
156 bool read(shared_ptr<FullWrtStruct::Entry> zone);
158 friend std::ostream &operator<<(std::ostream &o, ZoneHeader const &dt);
160 int m_type;
162 int m_docId;
164 int m_fileId;
166 int m_wrapping;
168 std::string m_extra;
169 };
170 }
171
172 #endif
173 // 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:150
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:136
FullWrtStruct::Border::m_shadowColor
MWAWColor m_shadowColor
the shadow color
Definition: FullWrtStruct.hxx:93
FullWrtStruct::Entry::m_asciiFile
shared_ptr< libmwaw::DebugFile > m_asciiFile
the debug file
Definition: FullWrtStruct.hxx:142
FullWrtStruct::Border::m_frontColor
MWAWColor m_frontColor
the front color (used for layout )
Definition: FullWrtStruct.hxx:89
FullWrtStruct::Entry::m_data
librevenge::RVNGBinaryData m_data
the main data ( if the entry comes from several zone )
Definition: FullWrtStruct.hxx:140
MWAWEntry.hxx
libmwaw_internal.hxx
FullWrtStruct::ZoneHeader::m_fileId
int m_fileId
the file id
Definition: FullWrtStruct.hxx:164
FullWrtStruct::ZoneHeader::m_type
int m_type
the zone type
Definition: FullWrtStruct.hxx:160
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::EntryPtr
shared_ptr< Entry > EntryPtr
Definition: FullWrtStruct.hxx:147
MWAWGraphicStyle
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:47
FullWrtStruct::Border::m_frameBorder
MWAWBorder m_frameBorder
the frame border
Definition: FullWrtStruct.hxx:87
FullWrtStruct::ZoneHeader::ZoneHeader
ZoneHeader()
constructor
Definition: FullWrtStruct.hxx:152
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:182
FullWrtStruct::Entry::m_type
int m_type
the zone type id find in DStruct
Definition: FullWrtStruct.hxx:134
MWAWBorder
a border
Definition: libmwaw_internal.hxx:314
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:132
FullWrtStruct::Border::m_backColor
MWAWColor m_backColor
the back color (used for layout )
Definition: FullWrtStruct.hxx:91
FullWrtStruct::Border::m_flags
int m_flags
the flags
Definition: FullWrtStruct.hxx:99
FullWrtStruct::ZoneHeader::m_wrapping
int m_wrapping
the wrapping type
Definition: FullWrtStruct.hxx:166
FullWrtStruct::Entry::operator!=
bool operator!=(const Entry &a) const
basic operator!=
Definition: FullWrtStruct.hxx:124
MWAWBorder::None
Definition: libmwaw_internal.hxx:316
FullWrtStruct::Border::m_type
int m_type[3]
the type (border, horizontal and vertical separators)
Definition: FullWrtStruct.hxx:85
FullWrtStruct::Border::m_extra
std::string m_extra
some extra data
Definition: FullWrtStruct.hxx:101
FullWrtStruct::Border::m_shadowDepl
MWAWVec2i m_shadowDepl
the shadow depl ( if shadow)
Definition: FullWrtStruct.hxx:95
FullWrtStruct::Border::m_color
MWAWColor m_color[2]
the colors line + ?
Definition: FullWrtStruct.hxx:97
FullWrtStruct::ZoneHeader::m_docId
int m_docId
the doc id
Definition: FullWrtStruct.hxx:162
FullWrtStruct::Border::addTo
void addTo(MWAWGraphicStyle &style) const
add to frame properties
Definition: FullWrtStruct.cxx:127
MWAWInputStreamPtr
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:503
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:350
FullWrtStruct::Border::operator<<
friend std::ostream & operator<<(std::ostream &o, Border const &p)
operator<<
Definition: FullWrtStruct.cxx:243
FullWrtStruct::Border::read
bool read(shared_ptr< FullWrtStruct::Entry > zone, int fSz)
try to read a border definiton
Definition: FullWrtStruct.cxx:142
FullWrtStruct
a namespace use to define common structure in a FullWrite file
Definition: FullWrtStruct.cxx:43
MWAWDebug.hxx
FullWrtStruct::getColor
bool getColor(int color, MWAWColor &col)
try to convert a file data to a color
Definition: FullWrtStruct.cxx:45
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:105
FullWrtStruct::ZoneHeader::m_extra
std::string m_extra
some extra data
Definition: FullWrtStruct.hxx:168
FullWrtStruct::Border::hasShadow
bool hasShadow() const
return true if we have a shadow
Definition: FullWrtStruct.hxx:73
FullWrtStruct::Entry::m_input
MWAWInputStreamPtr m_input
the input
Definition: FullWrtStruct.hxx:130
MWAWVec2< int >