FWStruct.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 FP_MWAW_STRUCT
39 # define FP_MWAW_STRUCT
40 
41 #include <libwpd/libwpd.h>
42 
43 #include "libmwaw_internal.hxx"
44 
45 #include "MWAWDebug.hxx"
46 #include "MWAWEntry.hxx"
47 
49 namespace FWStruct
50 {
51 
52 // basic
53 struct Entry;
55 bool getColor(int color, MWAWColor &col);
57 std::string getTypeName(int type);
58 
60 struct Border {
63  m_shadowColor(MWAWColor::black()), m_shadowDepl(0,0), m_flags(0), m_extra("") {
65  for (int w=0; w < 3; w++) m_type[w]=0;
66  }
68  static MWAWBorder getBorder(int type);
70  void addToFrame(WPXPropertyList &pList) const;
72  bool hasShadow() const {
73  return m_shadowDepl[0]||m_shadowDepl[1];
74  }
76  bool read(shared_ptr<FWStruct::Entry> zone, int fSz);
78  std::vector<Variable<MWAWBorder> > getParagraphBorders() const;
80  friend std::ostream &operator<<(std::ostream &o, Border const &p);
81 
83  int m_type[3];
97  int m_flags;
99  std::string m_extra;
100 };
101 
103 struct Entry : public MWAWEntry {
104  Entry(MWAWInputStreamPtr input);
105  ~Entry();
106 
108  friend std::ostream &operator<<(std::ostream &o, Entry const &entry);
109 
111  bool valid() const;
113  void update();
115  void closeDebugFile();
116 
120  bool operator==(const Entry &a) const;
122  bool operator!=(const Entry &a) const {
123  return !operator==(a);
124  }
125 
129  int m_nextId;
131  int m_type;
133  int m_typeId;
135  int m_values[3];
137  WPXBinaryData m_data;
139  shared_ptr<libmwaw::DebugFile> m_asciiFile;
140 private:
141  Entry(Entry const &);
142  Entry &operator=(Entry const &);
143 };
144 typedef shared_ptr<Entry> EntryPtr;
145 
147 struct ZoneHeader {
149  ZoneHeader() : m_type(-1), m_docId(-1), m_fileId(-1), m_wrapping(-1), m_extra("") {}
151  virtual ~ZoneHeader() { }
153  bool read(shared_ptr<FWStruct::Entry> zone);
155  friend std::ostream &operator<<(std::ostream &o, ZoneHeader const &dt);
157  int m_type;
159  int m_docId;
161  int m_fileId;
165  std::string m_extra;
166 };
167 }
168 
169 #endif
170 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
int m_type
the zone type
Definition: FWStruct.hxx:157
shared_ptr< Entry > EntryPtr
Definition: FWStruct.hxx:144
MWAWColor m_color[2]
the colors line + ?
Definition: FWStruct.hxx:95
MWAWBorder m_frameBorder
the frame border
Definition: FWStruct.hxx:85
bool hasShadow() const
return true if we have a shadow
Definition: FWStruct.hxx:72
Entry & operator=(Entry const &)
int m_fileId
the file id
Definition: FWStruct.hxx:161
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:66
int m_docId
the doc id
Definition: FWStruct.hxx:159
a structure used to store the data of a zone header in a FullWrite file
Definition: FWStruct.hxx:147
the definition of a zone in a FullWrite file
Definition: FWStruct.hxx:103
int m_type[3]
the type (border, horizontal and vertical separators)
Definition: FWStruct.hxx:83
int m_typeId
the type id (find in FZoneFlags)
Definition: FWStruct.hxx:133
Border()
constructor
Definition: FWStruct.hxx:62
int m_values[3]
some unknown values
Definition: FWStruct.hxx:135
int m_wrapping
the wrapping type
Definition: FWStruct.hxx:163
friend std::ostream & operator<<(std::ostream &o, Entry const &entry)
operator&lt;&lt;
Definition: FWStruct.cxx:309
std::vector< Variable< MWAWBorder > > getParagraphBorders() const
returns the list of border order MWAWBorder::Pos
Definition: FWStruct.cxx:221
bool read(shared_ptr< FWStruct::Entry > zone, int fSz)
try to read a border definiton
Definition: FWStruct.cxx:142
bool getColor(int color, MWAWColor &col)
try to convert a file data to a color
Definition: FWStruct.cxx:44
the class to store a color
Definition: libmwaw_internal.hxx:166
void update()
create a inputstream, ... if needed
Definition: FWStruct.cxx:359
void addToFrame(WPXPropertyList &pList) const
add to frame properties
Definition: FWStruct.cxx:125
static MWAWBorder getBorder(int type)
return a border corresponding to a type
Definition: FWStruct.cxx:116
Entry(MWAWInputStreamPtr input)
Definition: FWStruct.cxx:299
Vec2i m_shadowDepl
the shadow depl ( if shadow)
Definition: FWStruct.hxx:93
friend std::ostream & operator<<(std::ostream &o, Border const &p)
operator&lt;&lt;
Definition: FWStruct.cxx:240
a border
Definition: libmwaw_internal.hxx:237
MWAWInputStreamPtr m_input
the input
Definition: FWStruct.hxx:127
MWAWColor m_shadowColor
the shadow color
Definition: FWStruct.hxx:91
friend std::ostream & operator<<(std::ostream &o, ZoneHeader const &dt)
the operator&lt;&lt;
Definition: FWStruct.cxx:510
std::string getTypeName(int type)
returns the type name
Definition: FWStruct.cxx:64
ZoneHeader()
constructor
Definition: FWStruct.hxx:149
Definition: libmwaw_internal.hxx:239
~Entry()
Definition: FWStruct.cxx:304
libmwaw::DebugFile & getAsciiFile()
returns a reference to the ascii file
Definition: FWStruct.cxx:385
bool operator==(const Entry &a) const
basic operator==
Definition: FWStruct.cxx:390
int m_type
the zone type id find in DStruct
Definition: FWStruct.hxx:131
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:348
Style m_style
the border style
Definition: libmwaw_internal.hxx:270
virtual ~ZoneHeader()
destructor
Definition: FWStruct.hxx:151
Internal: class to store a border which appear in docInfo.
Definition: FWStruct.hxx:60
MWAWColor m_frontColor
the front color (used for layout )
Definition: FWStruct.hxx:87
std::string m_extra
some extra data
Definition: FWStruct.hxx:165
int m_nextId
the next entry id
Definition: FWStruct.hxx:129
bool valid() const
returns true if the entry and the input is valid
Definition: FWStruct.cxx:354
MWAWColor m_backColor
the back color (used for layout )
Definition: FWStruct.hxx:89
std::string m_extra
some extra data
Definition: FWStruct.hxx:99
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
WPXBinaryData m_data
the main data ( if the entry comes from several zone )
Definition: FWStruct.hxx:137
shared_ptr< libmwaw::DebugFile > m_asciiFile
the debug file
Definition: FWStruct.hxx:139
bool read(shared_ptr< FWStruct::Entry > zone)
try to read the data header of a classical zone
Definition: FWStruct.cxx:406
int m_flags
the flags
Definition: FWStruct.hxx:97
bool operator!=(const Entry &a) const
basic operator!=
Definition: FWStruct.hxx:122
void closeDebugFile()
write the debug file, ...
Definition: FWStruct.cxx:379

Generated on Tue Mar 10 2015 17:32:08 for libmwaw by doxygen 1.8.5