MWAWCell.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 
38 #ifndef MWAW_CELL_H
39 # define MWAW_CELL_H
40 
41 #include <string>
42 #include <vector>
43 
44 #include "libmwaw_internal.hxx"
45 
46 #include "MWAWEntry.hxx"
47 #include "MWAWFont.hxx"
48 
49 class MWAWTable;
50 
52 class MWAWCell
53 {
54 public:
60  struct Format {
62  Format() : m_format(F_UNKNOWN), m_numberFormat(F_NUMBER_UNKNOWN), m_digits(-1), m_integerDigits(-1), m_numeratorDigits(-1), m_denominatorDigits(-1),
64  {
65  }
67  virtual ~Format();
69  bool hasBasicFormat() const
70  {
71  return m_format==F_TEXT || m_format==F_UNKNOWN;
72  }
74  std::string getValueType() const;
76  bool getNumberingProperties(librevenge::RVNGPropertyList &propList) const;
78  friend std::ostream &operator<<(std::ostream &o, Format const &format);
80  int compare(Format const &format) const;
81 
87  int m_digits;
99  std::string m_currencySymbol;
101  std::string m_DTFormat;
102  };
104  struct CompareFormat {
108  bool operator()(Format const &c1, Format const &c2) const
109  {
110  return c1.compare(c2) < 0;
111  }
112  };
118  };
119 
123 
126 
129  m_format(), m_font(3,12), m_fontSet(false), m_hAlign(HALIGN_DEFAULT), m_vAlign(VALIGN_DEFAULT),
130  m_backgroundColor(MWAWColor::white()), m_protected(false),
132 
134  virtual ~MWAWCell() {}
135 
137  void addTo(librevenge::RVNGPropertyList &propList, shared_ptr<MWAWFontConverter> fontConverter) const;
138 
140  friend std::ostream &operator<<(std::ostream &o, MWAWCell const &cell);
141 
142  // interface with MWAWTable:
143 
148  virtual bool send(MWAWListenerPtr listener, MWAWTable &table);
153  virtual bool sendContent(MWAWListenerPtr listener, MWAWTable &table);
154 
155  // position
156 
158  MWAWVec2i const &position() const
159  {
160  return m_position;
161  }
164  {
165  m_position = posi;
166  }
167 
169  MWAWVec2i const &numSpannedCells() const
170  {
171  return m_numberCellSpanned;
172  }
174  void setNumSpannedCells(MWAWVec2i numSpanned)
175  {
176  m_numberCellSpanned=numSpanned;
177  }
178 
180  MWAWBox2f const &bdBox() const
181  {
182  return m_bdBox;
183  }
185  void setBdBox(MWAWBox2f box)
186  {
187  m_bdBox = box;
188  }
189 
191  MWAWVec2f const &bdSize() const
192  {
193  return m_bdSize;
194  }
197  {
198  m_bdSize = sz;
199  }
201  static std::string getBasicCellName(MWAWVec2i const &pos);
203  static std::string getCellName(MWAWVec2i const &pos, MWAWVec2b const &absolute);
204 
206  static std::string getColumnName(int col);
207 
208  // format
209 
211  Format const &getFormat() const
212  {
213  return m_format;
214  }
216  void setFormat(Format const &format)
217  {
218  m_format=format;
219  }
220 
222  bool isFontSet() const
223  {
224  return m_fontSet;
225  }
228  {
229  return m_font;
230  }
232  void setFont(MWAWFont const &font, bool isDefault=false)
233  {
234  m_font=font;
235  m_fontSet=!isDefault;
236  }
237 
239  bool isProtected() const
240  {
241  return m_protected;
242  }
244  void setProtected(bool fl)
245  {
246  m_protected = fl;
247  }
248 
251  {
252  return m_hAlign;
253  }
256  {
257  m_hAlign = align;
258  }
259 
262  {
263  return m_vAlign;
264  }
267  {
268  m_vAlign = align;
269  }
270 
272  bool hasBorders() const
273  {
274  return m_bordersList.size() != 0;
275  }
277  std::vector<MWAWBorder> const &borders() const
278  {
279  return m_bordersList;
280  }
281 
284  {
285  m_bordersList.resize(0);
286  }
288  void setBorders(int wh, MWAWBorder const &border);
289 
292  {
293  return m_backgroundColor;
294  }
297  {
298  m_backgroundColor = color;
299  }
301  bool hasExtraLine() const
302  {
304  }
307  {
308  return m_extraLine;
309  }
311  MWAWBorder const &extraLineType() const
312  {
313  return m_extraLineType;
314  }
316  void setExtraLine(ExtraLine extrLine, MWAWBorder const &type=MWAWBorder())
317  {
318  m_extraLine = extrLine;
319  m_extraLineType=type;
320  }
321 protected:
330 
336  bool m_fontSet;
345 
347  std::vector<MWAWBorder> m_bordersList;
352 };
353 
356 {
357 public:
360  enum Type { F_Operator, F_Function, F_Cell, F_CellList, F_Long, F_Double, F_Text };
362  FormulaInstruction() : m_type(F_Text), m_content(""), m_longValue(0), m_doubleValue(0), m_sheet("")
363  {
364  for (int i=0; i<2; ++i) {
365  m_position[i]=MWAWVec2i(0,0);
366  m_positionRelative[i]=MWAWVec2b(false,false);
367  }
368  }
370  librevenge::RVNGPropertyList getPropertyList(MWAWFontConverter &fontConverter, int fontId) const;
372  friend std::ostream &operator<<(std::ostream &o, FormulaInstruction const &inst);
376  std::string m_content;
378  double m_longValue;
384  MWAWVec2b m_positionRelative[2];
386  std::string m_sheet;
387  };
388 
390  enum Type { C_NONE, C_TEXT, C_NUMBER, C_FORMULA, C_UNKNOWN };
392  MWAWCellContent() : m_contentType(C_UNKNOWN), m_value(0.0), m_valueSet(false), m_textEntry(), m_formula() { }
396  friend std::ostream &operator<<(std::ostream &o, MWAWCellContent const &cell);
397 
399  bool empty() const
400  {
401  if (m_contentType == C_NUMBER) return false;
402  if (m_contentType == C_TEXT && m_textEntry.valid()) return false;
403  if (m_contentType == C_FORMULA && (m_formula.size() || isValueSet())) return false;
404  return true;
405  }
407  void setValue(double value)
408  {
409  m_value = value;
410  m_valueSet = true;
411  }
413  bool isValueSet() const
414  {
415  return m_valueSet;
416  }
418  bool hasText() const
419  {
420  return m_textEntry.valid();
421  }
424  static bool double2Date(double val, int &Y, int &M, int &D);
426  static bool double2Time(double val, int &H, int &M, int &S);
428  static bool double2String(double val, MWAWCell::Format const &format, std::string &str);
430  static bool date2Double(int Y, int M, int D, double &val);
434  double m_value;
440  std::vector<FormulaInstruction> m_formula;
441 };
442 
443 #endif
444 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:505
small class use to define a formula instruction
Definition: MWAWCell.hxx:359
static std::string getBasicCellName(MWAWVec2i const &pos)
return the name of a cell (given row and column) : 0,0 -> A1, 0,1 -> A2...
Definition: MWAWCell.cxx:342
double m_doubleValue
value ( if type==F_Double )
Definition: MWAWCell.hxx:380
Type
the different types of cell&#39;s field
Definition: MWAWCell.hxx:390
MWAWVec2i m_position
the cell row and column : 0,0 -> A1, 0,1 -> A2
Definition: MWAWCell.hxx:323
MWAWFont m_font
the cell font
Definition: MWAWCell.hxx:334
MWAWBorder m_extraLineType
extra line type
Definition: MWAWCell.hxx:351
MWAWBorder const & extraLineType() const
returns the extra line border
Definition: MWAWCell.hxx:311
void setFormat(Format const &format)
set the cell format
Definition: MWAWCell.hxx:216
Format()
constructor
Definition: MWAWCell.hxx:62
HorizontalAlignment hAlignment() const
returns the horizontal alignment
Definition: MWAWCell.hxx:250
void setFont(MWAWFont const &font, bool isDefault=false)
sets the fonts
Definition: MWAWCell.hxx:232
virtual bool sendContent(MWAWListenerPtr listener, MWAWTable &table)
function called when the content of a cell must be send to the listener, ie.
Definition: MWAWCell.cxx:496
Format const & getFormat() const
returns the cell format
Definition: MWAWCell.hxx:211
void setBackgroundColor(MWAWColor color)
sets the background color
Definition: MWAWCell.hxx:296
Definition: MWAWCell.hxx:56
bool empty() const
returns true if the cell has no content
Definition: MWAWCell.hxx:399
MWAWCell()
constructor
Definition: MWAWCell.hxx:128
a comparaison structure used to store data
Definition: MWAWCell.hxx:104
bool isEmpty() const
returns true if the border is empty
Definition: libmwaw_internal.hxx:327
Definition: MWAWCell.hxx:58
Definition: MWAWCell.hxx:56
MWAWCellContent()
constructor
Definition: MWAWCell.hxx:392
a structure uses to define the format of a cell content
Definition: MWAWCell.hxx:60
Definition: MWAWCell.hxx:58
virtual ~Format()
destructor
Definition: MWAWCell.cxx:54
Definition: MWAWCell.hxx:56
Definition: MWAWCell.hxx:58
void setProtected(bool fl)
sets the cell&#39;s protected flag
Definition: MWAWCell.hxx:244
bool hasBorders() const
return true if the cell has some border
Definition: MWAWCell.hxx:272
Definition: MWAWCell.hxx:122
std::vector< MWAWBorder > m_bordersList
the cell border MWAWBorder::Pos
Definition: MWAWCell.hxx:347
virtual bool send(MWAWListenerPtr listener, MWAWTable &table)
function called when a cell is send by MWAWTable to send a cell to a listener.
Definition: MWAWCell.cxx:487
VerticalAlignment m_vAlign
the vertical cell alignment : by default nothing
Definition: MWAWCell.hxx:340
MWAWEntry m_textEntry
the cell string
Definition: MWAWCell.hxx:438
std::string m_currencySymbol
the currency symbol ( default &#39;$&#39;)
Definition: MWAWCell.hxx:99
Type m_type
the type
Definition: MWAWCell.hxx:374
void setValue(double value)
sets the double value
Definition: MWAWCell.hxx:407
std::string m_sheet
the sheet name (if not empty)
Definition: MWAWCell.hxx:386
Definition: MWAWCell.hxx:58
a class used to recreate the table structure using cell informations, ....
Definition: MWAWTable.hxx:51
MWAWVec2< int > MWAWVec2i
MWAWVec2 of int.
Definition: libmwaw_internal.hxx:781
VerticalAlignment vAlignment() const
returns the vertical alignment
Definition: MWAWCell.hxx:261
bool m_protected
cell protected
Definition: MWAWCell.hxx:344
bool m_thousandHasSeparator
true if we must separate the thousand
Definition: MWAWCell.hxx:95
void setHAlignment(HorizontalAlignment align)
sets the horizontal alignment
Definition: MWAWCell.hxx:255
static std::string getColumnName(int col)
return the column name
Definition: MWAWCell.cxx:332
Definition: MWAWCell.hxx:58
bool isProtected() const
returns true if the cell is protected
Definition: MWAWCell.hxx:239
HorizontalAlignment
the default horizontal alignment.
Definition: MWAWCell.hxx:116
bool m_parenthesesForNegative
true if we use parenthese to print negative number
Definition: MWAWCell.hxx:97
a structure used to define a cell and its format
Definition: MWAWCell.hxx:52
the class to store a color
Definition: libmwaw_internal.hxx:182
MWAWVec2i const & position() const
position accessor
Definition: MWAWCell.hxx:158
MWAWVec2f const & bdSize() const
bdbox size accessor
Definition: MWAWCell.hxx:191
Format m_format
the cell format
Definition: MWAWCell.hxx:332
MWAWBox2f const & bdBox() const
bdbox accessor
Definition: MWAWCell.hxx:180
double m_value
the cell value
Definition: MWAWCell.hxx:434
Definition: MWAWCell.hxx:125
std::vector< FormulaInstruction > m_formula
the formula list of instruction
Definition: MWAWCell.hxx:440
small class use to define a sheet cell content
Definition: MWAWCell.hxx:355
FormatType
the different format of a cell&#39;s content
Definition: MWAWCell.hxx:56
MWAWVec2f m_bdSize
the cell bounding size : unit point
Definition: MWAWCell.hxx:329
MWAWBox2f m_bdBox
the cell bounding box (unit in point)
Definition: MWAWCell.hxx:327
virtual ~MWAWCell()
destructor
Definition: MWAWCell.hxx:134
Class to store font.
Definition: MWAWFont.hxx:43
a border
Definition: libmwaw_internal.hxx:314
int compare(Format const &format) const
a comparison function
Definition: MWAWCell.cxx:230
~MWAWCellContent()
destructor
Definition: MWAWCell.hxx:394
Definition: MWAWCell.hxx:58
bool hasText() const
returns true if the text is set
Definition: MWAWCell.hxx:418
void setBdSize(MWAWVec2f sz)
set the bdbox size(unit point)
Definition: MWAWCell.hxx:196
void setVAlignment(VerticalAlignment align)
sets the vertical alignment
Definition: MWAWCell.hxx:266
HorizontalAlignment m_hAlign
the cell alignment : by default nothing
Definition: MWAWCell.hxx:338
ExtraLine
an enum to defined potential internal line: E_Line1=TL to RB, E_Line2=BL to RT
Definition: MWAWCell.hxx:125
friend std::ostream & operator<<(std::ostream &o, Format const &format)
operator<<
Definition: MWAWCell.cxx:167
std::string getValueType() const
returns a value type
Definition: MWAWCell.cxx:58
Definition: MWAWCell.hxx:122
MWAWVec2< bool > MWAWVec2b
MWAWVec2 of bool.
Definition: libmwaw_internal.hxx:779
bool isValueSet() const
returns true if the value has been setted
Definition: MWAWCell.hxx:413
Definition: MWAWCell.hxx:117
Definition: MWAWCell.hxx:56
MWAWVec2i m_numberCellSpanned
the cell spanned : by default (1,1)
Definition: MWAWCell.hxx:325
FormatType m_format
the cell format : by default unknown
Definition: MWAWCell.hxx:83
bool hasExtraLine() const
returns true if we have some extra lines
Definition: MWAWCell.hxx:301
void setExtraLine(ExtraLine extrLine, MWAWBorder const &type=MWAWBorder())
sets the extraline
Definition: MWAWCell.hxx:316
ExtraLine m_extraLine
extra line
Definition: MWAWCell.hxx:349
void resetBorders()
reset the border
Definition: MWAWCell.hxx:283
Type
Definition: MWAWCell.hxx:360
Definition: MWAWCell.hxx:125
MWAWColor backgroundColor() const
returns the background color
Definition: MWAWCell.hxx:291
ExtraLine extraLine() const
returns the extra lines
Definition: MWAWCell.hxx:306
void setPosition(MWAWVec2i posi)
set the cell positions : 0,0 -> A1, 0,1 -> A2
Definition: MWAWCell.hxx:163
int m_numeratorDigits
the number of numerator digits
Definition: MWAWCell.hxx:91
a namespace used to convert Mac font characters in unicode
Definition: MWAWFontConverter.hxx:62
std::vector< MWAWBorder > const & borders() const
return the cell border: libmwaw::Left | ...
Definition: MWAWCell.hxx:277
Type m_contentType
the content type ( by default unknown )
Definition: MWAWCell.hxx:432
Definition: MWAWCell.hxx:56
Definition: MWAWCell.hxx:122
void setNumSpannedCells(MWAWVec2i numSpanned)
sets the number of spanned cells : MWAWVec2i(1,1) means 1 cellule
Definition: MWAWCell.hxx:174
bool getNumberingProperties(librevenge::RVNGPropertyList &propList) const
get the numbering style
Definition: MWAWCell.cxx:82
Definition: MWAWCell.hxx:117
int m_digits
the number of digits
Definition: MWAWCell.hxx:87
Definition: MWAWCell.hxx:58
MWAWColor m_backgroundColor
the backgroung color
Definition: MWAWCell.hxx:342
NumberType m_numberFormat
the numeric format
Definition: MWAWCell.hxx:85
bool m_fontSet
a flag to know if the font has been set
Definition: MWAWCell.hxx:336
static std::string getCellName(MWAWVec2i const &pos, MWAWVec2b const &absolute)
return the name of a cell (given row and column) : 0,0 -> [.A1], 0,1 -> [.A2]
Definition: MWAWCell.cxx:359
double m_longValue
value ( if type==F_Long )
Definition: MWAWCell.hxx:378
Definition: MWAWCell.hxx:125
CompareFormat()
constructor
Definition: MWAWCell.hxx:106
MWAWFont getFont() const
returns the font
Definition: MWAWCell.hxx:227
MWAWVec2i const & numSpannedCells() const
returns the number of spanned cells
Definition: MWAWCell.hxx:169
bool operator()(Format const &c1, Format const &c2) const
comparaison function
Definition: MWAWCell.hxx:108
void addTo(librevenge::RVNGPropertyList &propList, shared_ptr< MWAWFontConverter > fontConverter) const
adds to the propList
Definition: MWAWCell.cxx:255
bool m_valueSet
true if the value has been set
Definition: MWAWCell.hxx:436
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
VerticalAlignment
the default vertical alignment.
Definition: MWAWCell.hxx:122
FormulaInstruction()
constructor
Definition: MWAWCell.hxx:362
NumberType
the different number format of a cell&#39;s content
Definition: MWAWCell.hxx:58
Definition: MWAWCell.hxx:116
std::string m_content
the content ( if type == F_Operator or type = F_Function or type==F_Text)
Definition: MWAWCell.hxx:376
int m_denominatorDigits
the number of denominator digits
Definition: MWAWCell.hxx:93
Definition: MWAWCell.hxx:122
std::string m_DTFormat
a date/time format ( using a subset of strftime format )
Definition: MWAWCell.hxx:101
void setBdBox(MWAWBox2f box)
set the bdbox (unit point)
Definition: MWAWCell.hxx:185
Definition: MWAWCell.hxx:125
Definition: MWAWCell.hxx:116
int m_integerDigits
the number of main digits
Definition: MWAWCell.hxx:89
Definition: MWAWCell.hxx:116
bool hasBasicFormat() const
returns true if this is a basic format style
Definition: MWAWCell.hxx:69
Definition: MWAWCell.hxx:56
bool isFontSet() const
returns true if the font has been set
Definition: MWAWCell.hxx:222
void setBorders(int wh, MWAWBorder const &border)
sets the cell border: wh=libmwaw::LeftBit|...
Definition: MWAWCell.cxx:379

Generated on Sun Apr 9 2017 17:57:45 for libmwaw by doxygen 1.8.13