ClarisWksStyleManager.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  * Class used to read main style by AppleWorks/ClarisWorks parser
36  *
37  */
38 #ifndef CLARIS_WKS_STYLE_MANAGER
39 # define CLARIS_WKS_STYLE_MANAGER
40 
41 #include <iostream>
42 #include <string>
43 #include <vector>
44 
45 #include "libmwaw_internal.hxx"
46 
47 #include "MWAWCell.hxx"
48 #include "MWAWDebug.hxx"
49 #include "MWAWGraphicStyle.hxx"
50 #include "MWAWInputStream.hxx"
51 
52 class ClarisWksDocument;
53 
55 {
56 struct State;
57 }
58 
61 {
62 public:
63  struct CellFormat;
64  struct KSEN;
65  struct Style;
66 public:
68  ClarisWksStyleManager(MWAWParserStatePtr const &parserState, ClarisWksDocument *document=nullptr);
71 
73  bool readColorList(MWAWEntry const &entry);
75  bool readPatternList(long endPos=-1);
77  bool readGradientList(long endPos=-1);
79  bool readStyles(MWAWEntry const &entry);
81  bool readFontNames();
83  bool updateGradient(int grad, MWAWGraphicStyle &style) const;
85  bool updateWallPaper(int wall, MWAWGraphicStyle &style) const;
86 
88  int getFontId(int localId) const;
90  bool getColor(int id, MWAWColor &col) const;
92  bool getPattern(int id, MWAWGraphicStyle::Pattern &pattern, float &percent) const;
94  bool getRulerName(int id, std::string &name) const;
95 
97  bool get(int styleId, Style &style) const;
99  bool get(int fontId, MWAWFont &font) const;
101  bool get(int formatId, CellFormat &format) const;
103  bool get(int ksenId, KSEN &ksen) const;
105  bool get(int graphId, MWAWGraphicStyle &graph) const;
106 
108  bool readFont(int id, int fontSize, MWAWFont &font);
110  bool readFontAndPos(int id, int &posC, MWAWFont &font);
111 
112 protected:
114  int version() const;
115 
117  bool readGenStyle(int id);
118 
120  bool readStylesDef(int N, int fSz);
122  bool readLookUp(int N, int fSz);
123 
124  /* read the STYL CELL sequence */
125  bool readCellStyles(int N, int fSz);
127  bool readFontNames(int N, int fSz);
129  bool readGraphStyles(int N, int fSz);
131  bool readKSEN(int N, int fSz);
133  bool readStyleNames(int N, int fSz);
135  bool readStyleFonts(int N, int fSz);
136 
137 protected:
143  std::shared_ptr<ClarisWksStyleManagerInternal::State> m_state;
144 
145 private:
146  ClarisWksStyleManager(ClarisWksStyleManager const &orig) = delete;
148 
149 public:
151  struct CellFormat final : public MWAWCell::Format {
153  explicit CellFormat(MWAWCell::Format const &format=MWAWCell::Format())
154  : MWAWCell::Format(format)
155  , m_hAlign(MWAWCell::HALIGN_DEFAULT)
156  , m_fileFormat(-1)
157  , m_borders(0)
158  , m_wrap(false)
159  , m_extra("")
160  {
161  }
162  CellFormat(CellFormat const &)=default;
163  CellFormat &operator=(CellFormat const &)=default;
164  CellFormat &operator=(CellFormat &&)=default;
166  ~CellFormat() final;
168  friend std::ostream &operator<<(std::ostream &o, CellFormat const &form);
170  MWAWCell::HorizontalAlignment m_hAlign;
176  bool m_wrap;
178  std::string m_extra;
179  };
180 
182  struct KSEN {
185  : m_valign(0)
186  , m_lineType(MWAWBorder::Simple)
187  , m_lineRepeat(MWAWBorder::Single)
188  , m_lines(0)
189  , m_extra("")
190  {
191  }
193  friend std::ostream &operator<<(std::ostream &o, KSEN const &ksen);
195  int m_valign;
201  int m_lines;
203  std::string m_extra;
204  };
205 
207  struct Style {
210  : m_fontId(-1)
211  , m_cellFormatId(-1)
212  , m_rulerId(-1)
213  , m_rulerPId(-1)
214  , m_nameId(-1)
215  , m_ksenId(-1), m_graphicId(-1)
216  , m_localStyleId(-1)
217  , m_styleId(-1)
218  , m_extra("")
219  {
220  }
221 
223  friend std::ostream &operator<<(std::ostream &o, Style const &style);
224 
226  int m_fontId;
234  int m_nameId;
236  int m_ksenId;
244  std::string m_extra;
245  };
246 };
247 
248 #endif
bool updateWallPaper(int wall, MWAWGraphicStyle &style) const
update a style using a wall paper id
Definition: ClarisWksStyleManager.cxx:1736
ClarisWksStyleManager(MWAWParserStatePtr const &parserState, ClarisWksDocument *document=nullptr)
constructor
Definition: ClarisWksStyleManager.cxx:1592
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
CellFormat & operator=(CellFormat const &)=default
int m_graphicId
the graphic (checkme)
Definition: ClarisWksStyleManager.hxx:238
bool getRulerName(int id, std::string &name) const
return the name corresponding to a styleId
Definition: ClarisWksStyleManager.cxx:1610
Format()
constructor
Definition: MWAWCell.hxx:62
bool m_wrap
true if the cell content is wrapped
Definition: ClarisWksStyleManager.hxx:176
bool readColorList(MWAWEntry const &entry)
reads a color map zone ( v4-v6)
Definition: ClarisWksStyleManager.cxx:1872
bool readFont(int id, int fontSize, MWAWFont &font)
try to read a named font
Definition: ClarisWksStyleManager.cxx:2305
CellFormat(MWAWCell::Format const &format=MWAWCell::Format())
constructor from cell
Definition: ClarisWksStyleManager.hxx:153
a structure uses to define the format of a cell content
Definition: MWAWCell.hxx:60
int m_fontId
the char
Definition: ClarisWksStyleManager.hxx:226
int m_localStyleId
a local style id
Definition: ClarisWksStyleManager.hxx:240
the KSEN structure a structure related to paragraph and cell style
Definition: ClarisWksStyleManager.hxx:182
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:47
ClarisWksDocument * m_document
the document
Definition: ClarisWksStyleManager.hxx:139
MWAWParserStatePtr m_parserState
the parser state
Definition: ClarisWksStyleManager.hxx:141
int m_fileFormat
the field format: number, string, currency, ..
Definition: ClarisWksStyleManager.hxx:172
friend std::ostream & operator<<(std::ostream &o, CellFormat const &form)
operator<<
Definition: ClarisWksStyleManager.cxx:2805
bool readGradientList(long endPos=-1)
reads a gradient map zone ( v2)
Definition: ClarisWksStyleManager.cxx:1799
int m_ksenId
the ksen id
Definition: ClarisWksStyleManager.hxx:236
int m_rulerId
the ruler
Definition: ClarisWksStyleManager.hxx:230
bool getColor(int id, MWAWColor &col) const
return the color which corresponds to an id (if possible)
Definition: ClarisWksStyleManager.cxx:1637
std::string m_extra
extra data
Definition: ClarisWksStyleManager.hxx:244
bool readStylesDef(int N, int fSz)
try to read the style definition zone
Definition: ClarisWksStyleManager.cxx:2073
a structure to store the style list and the lookup zone
Definition: ClarisWksStyleManager.hxx:60
Type
the line repetition
Definition: libmwaw_internal.hxx:337
MWAWBorder::Style m_lineType
the line type
Definition: ClarisWksStyleManager.hxx:197
a structure used to define a cell and its format
Definition: MWAWCell.hxx:52
the class to store a color
Definition: libmwaw_internal.hxx:192
std::string m_extra
extra data
Definition: ClarisWksStyleManager.hxx:178
bool readStyleFonts(int N, int fSz)
read a STYL_CHAR Font sequence
Definition: ClarisWksStyleManager.cxx:2484
Style
the line style
Definition: libmwaw_internal.hxx:335
~ClarisWksStyleManager()
destructor
Definition: ClarisWksStyleManager.cxx:1600
bool getPattern(int id, MWAWGraphicStyle::Pattern &pattern, float &percent) const
return the pattern which corresponds to an id.
Definition: ClarisWksStyleManager.cxx:1650
int m_borders
the borders
Definition: ClarisWksStyleManager.hxx:174
Class to store font.
Definition: MWAWFont.hxx:43
a border
Definition: libmwaw_internal.hxx:333
main document information used to create a ClarisWorks file
Definition: ClarisWksDocument.hxx:73
MWAWBorder::Type m_lineRepeat
the line repetition
Definition: ClarisWksStyleManager.hxx:199
bool readStyles(MWAWEntry const &entry)
try to read the styles definition (in v4-6)
Definition: ClarisWksStyleManager.cxx:1921
bool readGenStyle(int id)
try to read a STYL_ subzone (in v4-6)
Definition: ClarisWksStyleManager.cxx:1970
int m_styleId
the style id
Definition: ClarisWksStyleManager.hxx:242
int m_rulerPId
the ruler parent id ( or maybe the style parent)
Definition: ClarisWksStyleManager.hxx:232
bool readPatternList(long endPos=-1)
reads a pattern map zone ( v2)
Definition: ClarisWksStyleManager.cxx:1758
bool readGraphStyles(int N, int fSz)
read a GraphicStyle sequence
Definition: ClarisWksStyleManager.cxx:2638
the structure to store the style in a ClarisWksStyleManager
Definition: ClarisWksStyleManager.hxx:207
bool readFontAndPos(int id, int &posC, MWAWFont &font)
try to read a font
Definition: ClarisWksStyleManager.cxx:2381
bool readStyleNames(int N, int fSz)
read a STYL Name sequence
Definition: ClarisWksStyleManager.cxx:2513
int m_nameId
the style name id
Definition: ClarisWksStyleManager.hxx:234
the CELL structure a structure related to number/date format
Definition: ClarisWksStyleManager.hxx:151
int version() const
return the file version
Definition: ClarisWksStyleManager.cxx:1604
Internal: the structures of a ClarisWksStyleManagerInternal.
Definition: ClarisWksStyleManager.cxx:52
int m_lines
an int used to add some oblique line ( or cross )
Definition: ClarisWksStyleManager.hxx:201
Defines MWAWCell (cell content and format)
bool readCellStyles(int N, int fSz)
Definition: ClarisWksStyleManager.cxx:2559
int m_valign
the vertical alignment
Definition: ClarisWksStyleManager.hxx:195
std::shared_ptr< ClarisWksStyleManagerInternal::State > m_state
the state
Definition: ClarisWksStyleManager.hxx:143
bool readKSEN(int N, int fSz)
read a KSEN sequence
Definition: ClarisWksStyleManager.cxx:2731
ClarisWksStyleManager & operator=(ClarisWksStyleManager const &orig)=delete
int m_cellFormatId
the formatId
Definition: ClarisWksStyleManager.hxx:228
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
bool readLookUp(int N, int fSz)
try to read the lookup zone
Definition: ClarisWksStyleManager.cxx:2134
std::string m_extra
extra data
Definition: ClarisWksStyleManager.hxx:203
bool updateGradient(int grad, MWAWGraphicStyle &style) const
update a style using a gradiant id
Definition: ClarisWksStyleManager.cxx:1715
KSEN()
constructor
Definition: ClarisWksStyleManager.hxx:184
bool readFontNames()
read the font name style zone (method to store font names in v2/v3 files)
Definition: ClarisWksStyleManager.cxx:2175
int getFontId(int localId) const
return a mac font id corresponding to a local id
Definition: ClarisWksStyleManager.cxx:1663
Style()
constructor
Definition: ClarisWksStyleManager.hxx:209
a basic pattern used in a MWAWGraphicStyle:
Definition: MWAWGraphicStyle.hxx:351
MWAWCell::HorizontalAlignment m_hAlign
the cell alignment : by default nothing
Definition: ClarisWksStyleManager.hxx:170
~CellFormat() final
destructor
Definition: ClarisWksStyleManager.cxx:2801

Generated for libmwaw by doxygen 1.8.14