WKSChart.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) 2006, 2007 Andrew Ziem
11  * Copyright (C) 2004 Marc Maurer (uwog@uwog.net)
12  * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
13  *
14  * For minor contributions see the git repository.
15  *
16  * Alternatively, the contents of this file may be used under the terms
17  * of the GNU Lesser General Public License Version 2.1 or later
18  * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
19  * applicable instead of those above.
20  */
21 
22 /*
23  * Structure to store and construct a chart
24  *
25  */
26 
27 #ifndef WKS_CHART
28 # define WKS_CHART
29 
30 #include <iostream>
31 #include <vector>
32 #include <map>
33 
34 #include "libwps_internal.h"
35 
36 #include "WPSEntry.h"
37 #include "WPSFont.h"
38 #include "WPSGraphicStyle.h"
39 
40 namespace WKSChartInternal
41 {
42 class SubDocument;
43 }
45 class WKSChart
46 {
48 public:
50  struct Position
51  {
53  explicit Position(Vec2i pos=Vec2i(-1,-1), librevenge::RVNGString const &sheetName="")
54  : m_pos(pos)
55  , m_sheetName(sheetName)
56  {
57  }
59  bool valid() const
60  {
61  return m_pos[0]>=0 && m_pos[1]>=0 && !m_sheetName.empty();
62  }
64  bool valid(Position const &maxPos) const
65  {
66  return valid() && maxPos.valid() && maxPos.m_pos[0]>=m_pos[0] && maxPos.m_pos[1]>=m_pos[1];
67  }
69  librevenge::RVNGString getCellName() const;
71  friend std::ostream &operator<<(std::ostream &o, Position const &pos);
73  bool operator==(Position const &pos) const
74  {
75  return m_pos==pos.m_pos && m_sheetName==pos.m_sheetName;
76  }
78  bool operator!=(Position const &pos) const
79  {
80  return !(operator==(pos));
81  }
85  librevenge::RVNGString m_sheetName;
86  };
88  struct Axis
89  {
91  enum Type { A_None, A_Numeric, A_Logarithmic, A_Sequence, A_Sequence_Skip_Empty };
93  Axis();
95  ~Axis();
97  void addContentTo(int coord, librevenge::RVNGPropertyList &propList) const;
99  void addStyleTo(librevenge::RVNGPropertyList &propList) const;
101  friend std::ostream &operator<<(std::ostream &o, Axis const &axis);
113  Position m_labelRanges[2];
114 
120  librevenge::RVNGString m_title;
122  librevenge::RVNGString m_subTitle;
125  };
127  struct Legend
128  {
131  : m_show(false)
132  , m_autoPosition(true)
133  , m_relativePosition(WPSBorder::RightBit)
134  , m_position(0,0)
135  , m_font()
136  , m_style()
137  {
138  }
140  void addContentTo(librevenge::RVNGPropertyList &propList) const;
142  void addStyleTo(librevenge::RVNGPropertyList &propList) const;
144  friend std::ostream &operator<<(std::ostream &o, Legend const &legend);
146  bool m_show;
157  };
159  struct Serie
160  {
162  enum Type { S_Area, S_Bar, S_Bubble, S_Circle, S_Column, S_Gantt, S_Line, S_Radar, S_Ring, S_Scatter, S_Stock, S_Surface };
165  {
166  P_None=0, P_Automatic, P_Square, P_Diamond, P_Arrow_Down,
167  P_Arrow_Up, P_Arrow_Right, P_Arrow_Left, P_Bow_Tie, P_Hourglass,
168  P_Circle, P_Star, P_X, P_Plus, P_Asterisk,
169  P_Horizontal_Bar, P_Vertical_Bar
170  };
172  Serie();
173  Serie(Serie const &)=default;
174  Serie(Serie &&)=default;
175  Serie &operator=(Serie const &)=default;
176  Serie &operator=(Serie &&)=default;
178  virtual ~Serie();
180  bool is1DStyle() const
181  {
182  return m_type==S_Line || m_type==S_Radar || (m_type==S_Scatter && m_pointType==P_None);
183  }
185  void setPrimaryColor(WPSColor const &color, float opacity = 1, bool force1D=false)
186  {
187  if (force1D || is1DStyle())
188  m_style.m_lineColor=color;
189  else
190  m_style.setSurfaceColor(color, opacity);
191  }
193  void setPrimaryPattern(WPSGraphicStyle::Pattern const &pattern, bool force1D=false);
195  void setSecondaryColor(WPSColor const &color)
196  {
197  if (!is1DStyle())
198  m_style.m_lineColor=color;
199  }
201  bool valid() const
202  {
203  return m_ranges[0].valid(m_ranges[0]);
204  }
206  void addContentTo(librevenge::RVNGPropertyList &propList) const;
208  void addStyleTo(librevenge::RVNGPropertyList &propList) const;
210  static std::string getSerieTypeName(Type type);
212  friend std::ostream &operator<<(std::ostream &o, Serie const &series);
216  Position m_ranges[2];
222  Position m_labelRanges[2];
226  librevenge::RVNGString m_legendText;
231  };
233  struct TextZone
234  {
236  enum Type { T_Title, T_SubTitle, T_Footer };
238  enum ContentType { C_Cell, C_Text };
239 
241  explicit TextZone(Type type);
242  TextZone(TextZone const &)=default;
244  ~TextZone();
246  bool valid() const
247  {
248  if (!m_show) return false;
249  if (m_contentType==C_Cell)
250  return m_cell.valid();
251  if (m_contentType!=C_Text)
252  return false;
253  for (auto &e : m_textEntryList)
254  {
255  if (e.valid()) return true;
256  }
257  return false;
258  }
260  void addContentTo(librevenge::RVNGPropertyList &propList) const;
262  void addStyleTo(librevenge::RVNGPropertyList &propList) const;
264  friend std::ostream &operator<<(std::ostream &o, TextZone const &zone);
270  bool m_show;
276  std::vector<WPSEntry> m_textEntryList;
281  };
282 
284  explicit WKSChart(Vec2f const &dim=Vec2f());
286  virtual ~WKSChart();
288  void sendChart(WKSContentListenerPtr &listener, librevenge::RVNGSpreadsheetInterface *interface) const;
290  virtual void sendContent(TextZone const &zone, WPSListenerPtr &listener) const=0;
291 
293  void setGridColor(WPSColor const &color)
294  {
295  m_gridColor=color;
296  }
298  Axis &getAxis(int coord);
300  Axis const &getAxis(int coord) const;
301 
303  Legend const &getLegend() const
304  {
305  return m_legend;
306  }
309  {
310  return m_legend;
311  }
312 
314  Serie *getSerie(int id, bool create);
316  std::map<int, Serie> const &getIdSerieMap() const
317  {
318  return m_serieMap;
319  }
321  TextZone *getTextZone(TextZone::Type type, bool create=false);
322 
323 protected:
325  void sendTextZoneContent(TextZone::Type type, WPSListenerPtr listener) const;
326 
327 public:
339  bool m_is3D;
342 
343  // main
344 
348  librevenge::RVNGString m_name;
349 
350  // plot area
351 
356 
357  // legend
358 
361 
366 
367 protected:
371  Axis m_axis[5];
375  std::map<int, Serie> m_serieMap;
377  std::map<TextZone::Type, TextZone> m_textZoneMap;
378 private:
379  explicit WKSChart(WKSChart const &orig) = delete;
380  WKSChart &operator=(WKSChart const &orig) = delete;
381 };
382 
383 #endif
384 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
std::string getCellName(Vec2i const &cellPos, Vec2b const &relative)
returns the cell name corresponding to a cell&#39;s position
Definition: libwps_internal.cpp:953
a cell position
Definition: WKSChart.h:50
std::shared_ptr< WPSListener > WPSListenerPtr
shared pointer to WPSListener
Definition: libwps_internal.h:105
Internal: the subdocument of a WKSChart.
Definition: WKSChart.cpp:48
Vec2< float > Vec2f
Vec2 of float.
Definition: libwps_internal.h:704
a border list
Definition: libwps_internal.h:394
a class used to store a chart associated to a spreadsheet ....
Definition: WKSChart.h:45
std::map< int, Serie > m_serieMap
the list of series
Definition: WKSChart.h:375
WPSGraphicStyle m_style
the graphic style
Definition: WKSChart.h:280
Type
the text type
Definition: WKSChart.h:236
librevenge::RVNGString m_sheetName
the cell sheet name
Definition: WKSChart.h:85
Type m_type
the zone type
Definition: WKSChart.h:266
WPSGraphicStyle m_floorStyle
floor
Definition: WKSChart.h:363
bool m_showTitle
show or not the title/subtitle
Definition: WKSChart.h:116
define the font properties
Definition: WPSFont.h:36
librevenge::RVNGString m_name
the chart name
Definition: WKSChart.h:348
bool operator==(Position const &pos) const
operator==
Definition: WKSChart.h:73
Position(Vec2i pos=Vec2i(-1,-1), librevenge::RVNGString const &sheetName="")
constructor
Definition: WKSChart.h:53
Position m_titleRange
the title cell range
Definition: WKSChart.h:118
Legend m_legend
the legend
Definition: WKSChart.h:373
Position m_legendRange
the legend range if defined
Definition: WKSChart.h:224
bool valid(Position const &maxPos) const
return true if the position is valid
Definition: WKSChart.h:64
WPSGraphicStyle m_style
the graphic style
Definition: WKSChart.h:156
librevenge::RVNGString m_legendText
the legend name if defined
Definition: WKSChart.h:226
Vec2f m_scaling
the minimum, maximum scaling(if manual)
Definition: WKSChart.h:107
bool m_dataStacked
a flag to know if the data are stacked or not
Definition: WKSChart.h:333
WPSGraphicStyle m_wallStyle
wall
Definition: WKSChart.h:365
Definition: WKSChart.h:168
Internal: the structures of a WKSChart.
Definition: WKSChart.cpp:44
Legend & getLegend()
returns the legend
Definition: WKSChart.h:308
bool m_showGrid
show or not the grid
Definition: WKSChart.h:109
WPSGraphicStyle m_plotAreaStyle
the ploat area style
Definition: WKSChart.h:355
Definition: WKSChart.h:166
WPSGraphicStyle m_style
the graphic style
Definition: WKSChart.h:124
std::vector< WPSEntry > m_textEntryList
the text entry (or the list of text entry)
Definition: WKSChart.h:276
Position m_cell
the cell position ( or title and subtitle)
Definition: WKSChart.h:274
a axis in a chart
Definition: WKSChart.h:88
a structure used to define a picture style
Definition: WPSGraphicStyle.h:37
Legend()
constructor
Definition: WKSChart.h:130
Vec2i m_pos
the cell column and row
Definition: WKSChart.h:83
WPSGraphicStyle m_style
the chart style
Definition: WKSChart.h:346
bool valid() const
return true if the serie is valid
Definition: WKSChart.h:201
Vec2f m_dimension
the chart dimension in point
Definition: WKSChart.h:329
PointType
the point type
Definition: WKSChart.h:164
WPSFont m_font
the zone format
Definition: WKSChart.h:278
WPSFont m_font
the font
Definition: WKSChart.h:154
std::map< int, Serie > const & getIdSerieMap() const
returns the list of defined series
Definition: WKSChart.h:316
bool operator!=(Position const &pos) const
operator!=
Definition: WKSChart.h:78
WPSFont m_font
the label font
Definition: WKSChart.h:220
Type m_type
the sequence type
Definition: WKSChart.h:103
bool m_show
true if the zone is visible
Definition: WKSChart.h:270
bool m_autoPosition
automatic position
Definition: WKSChart.h:148
librevenge::RVNGString m_subTitle
the subtitle label
Definition: WKSChart.h:122
bool m_is3D
a flag to know if the graphic is 3D
Definition: WKSChart.h:339
librevenge::RVNGString m_title
the title label
Definition: WKSChart.h:120
int m_relativePosition
the automatic position libwps::LeftBit|...
Definition: WKSChart.h:150
bool valid() const
returns true if the textbox is valid
Definition: WKSChart.h:246
bool is1DStyle() const
return true if the serie style is 1D
Definition: WKSChart.h:180
void setGridColor(WPSColor const &color)
set the grid color
Definition: WKSChart.h:293
ContentType
the text content type
Definition: WKSChart.h:238
Vec2< int > Vec2i
Vec2 of int.
Definition: libwps_internal.h:702
the class to store a color
Definition: libwps_internal.h:280
bool m_useSecondaryY
use or not the secondary y axis
Definition: WKSChart.h:218
Serie::Type m_type
the chart type (if no series)
Definition: WKSChart.h:331
Vec2f m_position
the position in points
Definition: WKSChart.h:152
Definition: WKSChart.h:167
WPSBox2f m_legendPosition
the legend dimension in percent
Definition: WKSChart.h:360
void setSecondaryColor(WPSColor const &color)
set the secondary color
Definition: WKSChart.h:195
bool m_automaticScaling
automatic scaling (or manual)
Definition: WKSChart.h:105
void setPrimaryColor(WPSColor const &color, float opacity=1, bool force1D=false)
set the primary color
Definition: WKSChart.h:185
WPSBox2f m_plotAreaPosition
the plot area dimension in percent
Definition: WKSChart.h:353
WPSColor m_gridColor
the grid color
Definition: WKSChart.h:369
bool m_show
show or not the legend
Definition: WKSChart.h:146
Legend const & getLegend() const
returns the legend
Definition: WKSChart.h:303
Vec2f m_position
the position in the zone
Definition: WKSChart.h:272
std::shared_ptr< WKSContentListener > WKSContentListenerPtr
shared pointer to WKSContentListener
Definition: libwps_internal.h:114
ContentType m_contentType
the content type
Definition: WKSChart.h:268
a legend in a chart
Definition: WKSChart.h:127
std::map< TextZone::Type, TextZone > m_textZoneMap
a map text zone type to text zone
Definition: WKSChart.h:377
bool m_dataVertical
a flag to know if the data are vertical (for bar)
Definition: WKSChart.h:337
WPSGraphicStyle m_style
the graphic style
Definition: WKSChart.h:228
std::ostream & operator<<(std::ostream &o, WPSColor const &c)
Definition: libwps_internal.cpp:401
a serie in a chart
Definition: WKSChart.h:159
a text zone a chart
Definition: WKSChart.h:233
bool m_is3DDeep
a flag to know if real 3D or 2D-extended
Definition: WKSChart.h:341
bool m_showLabel
show or not the label
Definition: WKSChart.h:111
Type
the series type
Definition: WKSChart.h:162
Type
the axis content
Definition: WKSChart.h:91
Type m_type
the type
Definition: WKSChart.h:214
PointType m_pointType
the point type
Definition: WKSChart.h:230
bool m_dataPercentStacked
a flag to know if the data are percent stacked or not
Definition: WKSChart.h:335
a basic pattern used in a WPSGraphicStyle:
Definition: WPSGraphicStyle.h:88
bool valid() const
return true if the position is valid
Definition: WKSChart.h:59

Generated on Sat Sep 24 2022 13:47:03 for libwps by doxygen 1.8.13