WPSCell.h Source File documentation

WPSCell.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2 /* libwps
3 * Version: MPL 2.0 / LGPLv2.1+
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * Major Contributor(s):
10 * Copyright (C) 2009, 2011 Alonso Laurent (alonso@loria.fr)
11 * Copyright (C) 2006, 2007 Andrew Ziem
12 * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
13 * Copyright (C) 2004 Marc Maurer (uwog@uwog.net)
14 * Copyright (C) 2003-2005 William Lachance (william.lachance@sympatico.ca)
15 *
16 * For minor contributions see the git repository.
17 *
18 * Alternatively, the contents of this file may be used under the terms
19 * of the GNU Lesser General Public License Version 2.1 or later
20 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
21 * applicable instead of those above.
22 *
23 * For further information visit http://libwps.sourceforge.net
24 */
25
26 /* Define some classes used to store a Cell
27 */
28
29 #ifndef WPS_CELL_H
30 # define WPS_CELL_H
31
32 #include <iostream>
33 #include <vector>
34
35 #include "libwps_internal.h"
36
37 #include "WPSFont.h"
38
40 class WPSCellFormat
41 {
42 public:
46 enum HorizontalAlignment { HALIGN_LEFT, HALIGN_RIGHT, HALIGN_CENTER,
47 HALIGN_FULL, HALIGN_DEFAULT
48 };
50 enum VerticalAlignment { VALIGN_TOP, VALIGN_CENTER, VALIGN_BOTTOM, VALIGN_DEFAULT };
51
53 enum FormatType { F_TEXT, F_BOOLEAN, F_NUMBER, F_DATE, F_TIME, F_UNKNOWN };
54
55 /* subformat:
56 NUMBER DATE TIME TEXT
57 0 : default default[3/2/2000] default[10:03:00] default
58 1 : decimal
59 2 : exponential
60 3 : percent
61 4 : money
62 5 : thousand
63 6 : fixed
64 7 : fraction
65 */
66
68 WPSCellFormat() :
69 m_font(), m_hAlign(HALIGN_DEFAULT), m_vAlign(VALIGN_DEFAULT), m_rotation(0), m_bordersList(), m_format(F_UNKNOWN), m_subFormat(0), m_DTFormat(""), m_digits(-1000), m_protected(false), m_backgroundColor(WPSColor::white()) { }
71 virtual ~WPSCellFormat() {}
73 bool hasBasicFormat() const
74 {
75 return m_format==F_TEXT || m_format==F_UNKNOWN;
76 }
78 std::string getValueType() const;
80 void addTo(librevenge::RVNGPropertyList &propList) const;
82 bool getNumberingProperties(librevenge::RVNGPropertyList &propList) const;
83
85 WPSFont const &getFont() const
86 {
87 return m_font;
88 }
90 void setFont(WPSFont const &font)
91 {
92 m_font=font;
93 }
95 HorizontalAlignment hAlignement() const
96 {
97 return m_hAlign;
98 }
100 void setHAlignement(HorizontalAlignment align)
101 {
102 m_hAlign = align;
103 }
104
106 VerticalAlignment vAlignement() const
107 {
108 return m_vAlign;
109 }
111 void setVAlignement(VerticalAlignment align)
112 {
113 m_vAlign = align;
114 }
115
117 int getTextRotation() const
118 {
119 return m_rotation;
120 }
122 void setTextRotation(int rotation)
123 {
124 m_rotation = rotation;
125 }
126
128 FormatType getFormat() const
129 {
130 return m_format;
131 }
133 int getSubFormat() const
134 {
135 return m_subFormat;
136 }
138 std::string getDTFormat() const
139 {
140 return m_DTFormat;
141 }
143 void setFormat(FormatType form, int subForm=0)
144 {
145 m_format = form;
146 m_subFormat = subForm;
147 }
149 void setDTFormat(FormatType form, std::string const &dtFormat="")
150 {
151 m_format = form;
152 m_subFormat = 0;
153 m_DTFormat = dtFormat;
154 }
155
157 int digits() const
158 {
159 return m_digits;
160 }
162 void setDigits(int newDigit)
163 {
164 m_digits = newDigit;
165 }
166
168 bool isProtected() const
169 {
170 return m_protected;
171 }
172
174 void setProtected(bool fl)
175 {
176 m_protected = fl;
177 }
178
180 bool hasBorders() const
181 {
182 return m_bordersList.size() != 0;
183 }
184
186 std::vector<WPSBorder> const &borders() const
187 {
188 return m_bordersList;
189 }
190
192 void resetBorders()
193 {
194 m_bordersList.resize(0);
195 }
196
198 void setBorders(int wh, WPSBorder const &border);
200 void setBorders(std::vector<WPSBorder> const &newBorders)
201 {
202 m_bordersList=newBorders;
203 }
204
206 WPSColor backgroundColor() const
207 {
208 return m_backgroundColor;
209 }
211 void setBackgroundColor(WPSColor const &color)
212 {
213 m_backgroundColor = color;
214 }
215
217 int compare(WPSCellFormat const &cell, bool onlyNumbering=false) const;
218
220 friend std::ostream &operator<<(std::ostream &o, WPSCellFormat const &cell);
221
223 struct CompareFormat
224 {
226 CompareFormat() {}
228 bool operator()(WPSCellFormat const &c1, WPSCellFormat const &c2) const
229 {
230 return c1.compare(c2, true) < 0;
231 }
232 };
233
234 protected:
236 static bool convertDTFormat(std::string const &dtFormat, librevenge::RVNGPropertyListVector &propListVector);
238 WPSFont m_font;
240 HorizontalAlignment m_hAlign;
242 VerticalAlignment m_vAlign;
244 int m_rotation;
246 std::vector<WPSBorder> m_bordersList;
248 FormatType m_format;
250 int m_subFormat;
252 std::string m_DTFormat;
254 int m_digits;
256 bool m_protected;
258 WPSColor m_backgroundColor;
259 };
260
261 class WPSTable;
262
264 class WPSCell : public WPSCellFormat
265 {
266 friend class WPSTable;
267 public:
269 WPSCell() : WPSCellFormat(), m_box(), m_verticalSet(true), m_position(0,0), m_numberCellSpanned(1,1) {}
271 virtual ~WPSCell() {}
272
274 void addTo(librevenge::RVNGPropertyList &propList) const;
275
277 void setBox(WPSBox2f const &b)
278 {
279 m_box = b;
280 }
282 WPSBox2f const &box() const
283 {
284 return m_box;
285 }
287 bool isVerticalSet() const
288 {
289 return m_verticalSet;
290 }
292 void setVerticalSet(bool verticalSet)
293 {
294 m_verticalSet = verticalSet;
295 }
297 Vec2i &position()
298 {
299 return m_position;
300 }
302 Vec2i const &position() const
303 {
304 return m_position;
305 }
307 void setPosition(Vec2i posi)
308 {
309 m_position = posi;
310 }
311
313 Vec2i const &numSpannedCells() const
314 {
315 return m_numberCellSpanned;
316 }
318 void setNumSpannedCells(Vec2i numSpanned)
319 {
320 m_numberCellSpanned=numSpanned;
321 }
322
324 virtual bool send(WPSListenerPtr &listener) = 0;
325
327 virtual bool sendContent(WPSListenerPtr &listener) = 0;
328
330 friend std::ostream &operator<<(std::ostream &o, WPSCell const &cell);
331
332 protected:
334 struct Compare
335 {
336 explicit Compare(int dim) : m_coord(dim) {}
338 struct Point
339 {
340 Point(int wh, WPSCell const *cell) : m_which(wh), m_cell(cell) {}
341 float getPos(int coord) const
342 {
343 if (m_which)
344 return m_cell->box().max()[coord];
345 return m_cell->box().min()[coord];
346 }
347 float getSize(int coord) const
348 {
349 return m_cell->box().size()[coord];
350 }
351 int m_which;
352 WPSCell const *m_cell;
353 };
354
356 bool operator()(Point const &c1, Point const &c2) const
357 {
358 float diffF = c1.getPos(m_coord)-c2.getPos(m_coord);
359 if (diffF < 0) return true;
360 if (diffF > 0) return false;
361 int diff = c2.m_which - c1.m_which;
362 if (diff) return (diff < 0);
363 diffF = c1.m_cell->box().size()[m_coord]
364 - c2.m_cell->box().size()[m_coord];
365 if (diffF < 0) return true;
366 if (diffF > 0) return false;
367 if (c1.m_cell->m_verticalSet != c2.m_cell->m_verticalSet) return c1.m_cell->m_verticalSet;
368 #ifdef _WIN64
369 return ((__int64)c1.m_cell < (__int64)c2.m_cell);
370 #else
371 return long(c1.m_cell) < long(c2.m_cell);
372 #endif
373 }
374
376 int m_coord;
377 };
378
380 WPSBox2f m_box;
382 bool m_verticalSet;
384 Vec2i m_position;
386 Vec2i m_numberCellSpanned;
387 };
388
389 #endif
390 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
WPSCellFormat::F_TIME
Definition: WPSCell.h:53
WPSCellFormat::hasBorders
bool hasBorders() const
return true if the cell has some border
Definition: WPSCell.h:180
WPSCellFormat::m_digits
int m_digits
the number of digits
Definition: WPSCell.h:254
WPSCellFormat::operator<<
friend std::ostream & operator<<(std::ostream &o, WPSCellFormat const &cell)
operator<<
Definition: WPSCell.cpp:375
WPSCellFormat::addTo
void addTo(librevenge::RVNGPropertyList &propList) const
add to the propList
Definition: WPSCell.cpp:156
WPSBorder
a border list
Definition: libwps_internal.h:374
WPSCell::Compare
a comparaison structure used retrieve the rows and the columns
Definition: WPSCell.h:334
WPSCellFormat::backgroundColor
WPSColor backgroundColor() const
returns the background color
Definition: WPSCell.h:206
WPSCellFormat::hAlignement
HorizontalAlignment hAlignement() const
returns the horizontal alignement
Definition: WPSCell.h:95
WPSBox2::size
Vec2< T > size() const
the box size
Definition: libwps_internal.h:766
WPSCell::Compare::operator()
bool operator()(Point const &c1, Point const &c2) const
comparaison function
Definition: WPSCell.h:356
WPSCell::Compare::Point::Point
Point(int wh, WPSCell const *cell)
Definition: WPSCell.h:340
WPSCell::m_numberCellSpanned
Vec2i m_numberCellSpanned
the cell spanned : by default (1,1)
Definition: WPSCell.h:386
WPSCellFormat::setDigits
void setDigits(int newDigit)
set the number of digits ( for a number)
Definition: WPSCell.h:162
WPSCell::box
WPSBox2f const & box() const
return the bounding box
Definition: WPSCell.h:282
WPSCell::~WPSCell
virtual ~WPSCell()
destructor
Definition: WPSCell.h:271
WPSCellFormat::m_vAlign
VerticalAlignment m_vAlign
the cell vertical alignement : by default nothing
Definition: WPSCell.h:242
WPSCellFormat::VALIGN_BOTTOM
Definition: WPSCell.h:50
WPSCellFormat::setFormat
void setFormat(FormatType form, int subForm=0)
sets the format type
Definition: WPSCell.h:143
WPSCellFormat::F_DATE
Definition: WPSCell.h:53
WPSFont
define the font properties
Definition: WPSFont.h:36
WPSCellFormat::VALIGN_DEFAULT
Definition: WPSCell.h:50
WPSCellFormat::m_format
FormatType m_format
the cell format : by default unknown
Definition: WPSCell.h:248
WPSCell::setBox
void setBox(WPSBox2f const &b)
set the bounding box (units in point)
Definition: WPSCell.h:277
WPSCellFormat::setBorders
void setBorders(int wh, WPSBorder const &border)
sets the cell border: wh=WPSBorder::LeftBit|...
Definition: WPSCell.cpp:136
WPSCellFormat::m_rotation
int m_rotation
the text rotation
Definition: WPSCell.h:244
WPSCell::WPSCell
WPSCell()
constructor
Definition: WPSCell.h:269
WPSCell::setVerticalSet
void setVerticalSet(bool verticalSet)
fixes or not the vertical size
Definition: WPSCell.h:292
WPSCellFormat::VALIGN_CENTER
Definition: WPSCell.h:50
WPSCellFormat::m_hAlign
HorizontalAlignment m_hAlign
the cell alignement : by default nothing
Definition: WPSCell.h:240
WPSCellFormat::m_DTFormat
std::string m_DTFormat
a date/time format ( using a subset of strftime format )
Definition: WPSCell.h:252
WPSCellFormat::HALIGN_LEFT
Definition: WPSCell.h:46
WPSCellFormat::F_TEXT
Definition: WPSCell.h:53
WPSCellFormat
a structure used to defined the cell format
Definition: WPSCell.h:40
WPSCellFormat::setDTFormat
void setDTFormat(FormatType form, std::string const &dtFormat="")
sets the format type
Definition: WPSCell.h:149
WPSCellFormat::setVAlignement
void setVAlignement(VerticalAlignment align)
sets the vertical alignement
Definition: WPSCell.h:111
WPSCellFormat::setFont
void setFont(WPSFont const &font)
sets the font
Definition: WPSCell.h:90
WPSCellFormat::borders
std::vector< WPSBorder > const & borders() const
return the cell border: libwps::LeftBit | ...
Definition: WPSCell.h:186
WPSCellFormat::F_NUMBER
Definition: WPSCell.h:53
WPSCell
a structure used to defined the cell position, and a format
Definition: WPSCell.h:264
WPSCell::setNumSpannedCells
void setNumSpannedCells(Vec2i numSpanned)
sets the number of spanned cells : Vec2i(1,1) means 1 cellule
Definition: WPSCell.h:318
WPSCellFormat::FormatType
FormatType
the different types of cell&#39;s field
Definition: WPSCell.h:53
WPSCellFormat::CompareFormat
a comparaison structure used to store data
Definition: WPSCell.h:223
WPSCellFormat::setProtected
void setProtected(bool fl)
returns true if the cell is protected
Definition: WPSCell.h:174
WPSCellFormat::getDTFormat
std::string getDTFormat() const
returns the date/time format ( if set)
Definition: WPSCell.h:138
WPSCellFormat::m_bordersList
std::vector< WPSBorder > m_bordersList
the cell border WPSBorder::Pos
Definition: WPSCell.h:246
WPSListenerPtr
shared_ptr< WPSListener > WPSListenerPtr
shared pointer to WPSListener
Definition: libwps_internal.h:106
WPSCellFormat::setBackgroundColor
void setBackgroundColor(WPSColor const &color)
set the background color
Definition: WPSCell.h:211
WPSCellFormat::VALIGN_TOP
Definition: WPSCell.h:50
libwps_internal.h
WPSCellFormat::F_BOOLEAN
Definition: WPSCell.h:53
WPSCellFormat::F_UNKNOWN
Definition: WPSCell.h:53
WPSCell::isVerticalSet
bool isVerticalSet() const
returns true if the vertical is fixed
Definition: WPSCell.h:287
WPSCell::Compare::m_coord
int m_coord
the coord to compare
Definition: WPSCell.h:376
WPSCellFormat::vAlignement
VerticalAlignment vAlignement() const
returns the vertical alignement
Definition: WPSCell.h:106
WPSCellFormat::m_subFormat
int m_subFormat
the sub format
Definition: WPSCell.h:250
WPSBox2< float >
WPSCell::Compare::Compare
Compare(int dim)
Definition: WPSCell.h:336
WPSCell::Compare::Point::getPos
float getPos(int coord) const
Definition: WPSCell.h:341
WPSCell::Compare::Point::getSize
float getSize(int coord) const
Definition: WPSCell.h:347
WPSCell::Compare::Point
small structure to define a cell point
Definition: WPSCell.h:338
WPSCellFormat::getTextRotation
int getTextRotation() const
returns the text rotation angle
Definition: WPSCell.h:117
WPSCellFormat::convertDTFormat
static bool convertDTFormat(std::string const &dtFormat, librevenge::RVNGPropertyListVector &propListVector)
convert a DTFormat in a propertyList
Definition: WPSCell.cpp:35
WPSCellFormat::resetBorders
void resetBorders()
reset the border
Definition: WPSCell.h:192
WPSCellFormat::HALIGN_DEFAULT
Definition: WPSCell.h:47
WPSCell::setPosition
void setPosition(Vec2i posi)
set the cell positions : 0,0 -> A1, 0,1 -> A2
Definition: WPSCell.h:307
WPSCellFormat::hasBasicFormat
bool hasBasicFormat() const
returns true if this is a basic format style
Definition: WPSCell.h:73
WPSColor
the class to store a color
Definition: libwps_internal.h:268
WPSCellFormat::isProtected
bool isProtected() const
returns true if the cell is protected
Definition: WPSCell.h:168
WPSCellFormat::CompareFormat::operator()
bool operator()(WPSCellFormat const &c1, WPSCellFormat const &c2) const
comparaison function
Definition: WPSCell.h:228
WPSCell::m_position
Vec2i m_position
the cell row and column : 0,0 -> A1, 0,1 -> A2
Definition: WPSCell.h:384
WPSCell::Compare::Point::m_cell
WPSCell const * m_cell
Definition: WPSCell.h:352
WPSCellFormat::m_protected
bool m_protected
cell protected
Definition: WPSCell.h:256
WPSCellFormat::getFormat
FormatType getFormat() const
returns the format type
Definition: WPSCell.h:128
WPSCellFormat::digits
int digits() const
returns the number of digits ( for a number)
Definition: WPSCell.h:157
WPSCellFormat::setHAlignement
void setHAlignement(HorizontalAlignment align)
sets the horizontal alignement
Definition: WPSCell.h:100
WPSCellFormat::getValueType
std::string getValueType() const
returns a value type
Definition: WPSCell.cpp:225
WPSCellFormat::HALIGN_CENTER
Definition: WPSCell.h:46
WPSCellFormat::HALIGN_FULL
Definition: WPSCell.h:47
WPSCell::Compare::Point::m_which
int m_which
Definition: WPSCell.h:351
WPSCellFormat::m_font
WPSFont m_font
the cell font ( used in spreadsheet code )
Definition: WPSCell.h:238
WPSCell::position
Vec2i const & position() const
position accessor
Definition: WPSCell.h:302
WPSFont.h
WPSCellFormat::m_backgroundColor
WPSColor m_backgroundColor
the backgroung color
Definition: WPSCell.h:258
WPSCellFormat::getNumberingProperties
bool getNumberingProperties(librevenge::RVNGPropertyList &propList) const
get the number style
Definition: WPSCell.cpp:260
WPSCellFormat::~WPSCellFormat
virtual ~WPSCellFormat()
destructor
Definition: WPSCell.h:71
WPSTable
Definition: WPSTable.h:39
WPSCell::numSpannedCells
Vec2i const & numSpannedCells() const
returns the number of spanned cells
Definition: WPSCell.h:313
Vec2< int >
WPSCell::m_verticalSet
bool m_verticalSet
true if y size is fixed
Definition: WPSCell.h:382
WPSCell::m_box
WPSBox2f m_box
the cell bounding box (unit in point)
Definition: WPSCell.h:380
WPSCellFormat::setTextRotation
void setTextRotation(int rotation)
sets the text rotation angle
Definition: WPSCell.h:122
WPSCellFormat::HALIGN_RIGHT
Definition: WPSCell.h:46
WPSCellFormat::HorizontalAlignment
HorizontalAlignment
the default horizontal alignement.
Definition: WPSCell.h:46
WPSCellFormat::compare
int compare(WPSCellFormat const &cell, bool onlyNumbering=false) const
a comparison function
Definition: WPSCell.cpp:345
WPSCellFormat::setBorders
void setBorders(std::vector< WPSBorder > const &newBorders)
sets the cell borders
Definition: WPSCell.h:200
WPSCellFormat::VerticalAlignment
VerticalAlignment
the default vertical alignement.
Definition: WPSCell.h:50
WPSCellFormat::getFont
WPSFont const & getFont() const
returns the font
Definition: WPSCell.h:85
WPSCellFormat::CompareFormat::CompareFormat
CompareFormat()
constructor
Definition: WPSCell.h:226
WPSCell::position
Vec2i & position()
position accessor
Definition: WPSCell.h:297
WPSCellFormat::WPSCellFormat
WPSCellFormat()
constructor
Definition: WPSCell.h:68
WPSCellFormat::getSubFormat
int getSubFormat() const
returns the subformat type
Definition: WPSCell.h:133