STOFFChart.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 /* libstaroffice
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  * Structure to store and construct a chart
36  *
37  */
38 
39 #ifndef STOFF_CHART
40 # define STOFF_CHART
41 
42 #include <iostream>
43 #include <vector>
44 #include <map>
45 
47 
48 #include "STOFFEntry.hxx"
49 #include "STOFFFont.hxx"
50 #include "STOFFGraphicStyle.hxx"
51 
52 namespace STOFFChartInternal
53 {
54 class SubDocument;
55 }
58 {
60 public:
62  struct Position {
64  explicit Position(STOFFVec2i pos=STOFFVec2i(-1,-1), librevenge::RVNGString const &sheetName="")
65  : m_pos(pos)
66  , m_sheetName(sheetName)
67  {
68  }
70  bool valid() const
71  {
72  return m_pos[0]>=0 && m_pos[1]>=0 && !m_sheetName.empty();
73  }
75  bool valid(Position const &maxPos) const
76  {
77  return valid() && maxPos.valid() && maxPos.m_pos[0]>=m_pos[0] && maxPos.m_pos[1]>=m_pos[1];
78  }
80  librevenge::RVNGString getCellName() const;
82  friend std::ostream &operator<<(std::ostream &o, Position const &pos);
84  bool operator==(Position &pos) const
85  {
86  return m_pos==pos.m_pos && m_sheetName==pos.m_sheetName;
87  }
89  bool operator!=(Position &pos) const
90  {
91  return !(operator==(pos));
92  }
96  librevenge::RVNGString m_sheetName;
97  };
98  struct Axis {
100  enum Type { A_None, A_Numeric, A_Logarithmic, A_Sequence, A_Sequence_Skip_Empty };
102  Axis();
104  ~Axis();
106  void addContentTo(int coord, librevenge::RVNGPropertyList &propList) const;
108  void addStyleTo(librevenge::RVNGPropertyList &propList) const;
110  friend std::ostream &operator<<(std::ostream &o, Axis const &axis);
122  Position m_labelRanges[2];
123 
129  librevenge::RVNGString m_title;
131  librevenge::RVNGString m_subTitle;
134  };
136  struct Legend {
139  : m_show(false)
140  , m_autoPosition(true)
141  , m_relativePosition(libstoff::RightBit)
142  , m_position(0,0)
143  , m_font()
144  , m_style()
145  {
146  }
148  void addContentTo(librevenge::RVNGPropertyList &propList) const;
150  void addStyleTo(librevenge::RVNGPropertyList &propList) const;
152  friend std::ostream &operator<<(std::ostream &o, Legend const &legend);
154  bool m_show;
165  };
167  struct Serie {
169  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 };
171  enum PointType {
172  P_None=0, P_Automatic, P_Square, P_Diamond, P_Arrow_Down,
173  P_Arrow_Up, P_Arrow_Right, P_Arrow_Left, P_Bow_Tie, P_Hourglass,
174  P_Circle, P_Star, P_X, P_Plus, P_Asterisk,
175  P_Horizontal_Bar, P_Vertical_Bar
176  };
178  Serie();
179  Serie(Serie const &)=default;
180  Serie(Serie &&)=default;
181  Serie &operator=(Serie const &)=default;
182  Serie &operator=(Serie &&)=default;
184  virtual ~Serie();
186  bool is1DStyle() const
187  {
188  return m_type==S_Line || m_type==S_Radar || (m_type==S_Scatter && m_pointType==P_None);
189  }
191  bool valid() const
192  {
193  return m_ranges[0].valid(m_ranges[0]);
194  }
196  void addContentTo(librevenge::RVNGPropertyList &propList) const;
198  void addStyleTo(librevenge::RVNGPropertyList &propList) const;
200  static std::string getSerieTypeName(Type type);
202  friend std::ostream &operator<<(std::ostream &o, Serie const &series);
206  Position m_ranges[2];
212  Position m_labelRanges[2];
216  librevenge::RVNGString m_legendText;
221  };
223  struct TextZone {
225  enum Type { T_Title, T_SubTitle, T_Footer };
227  enum ContentType { C_Cell, C_Text };
228 
230  explicit TextZone(Type type);
232  ~TextZone();
234  bool valid() const
235  {
236  if (!m_show) return false;
237  if (m_contentType==C_Cell)
238  return m_cell.valid();
239  if (m_contentType!=C_Text)
240  return false;
241  for (auto &e : m_textEntryList) {
242  if (e.valid()) return true;
243  }
244  return false;
245  }
247  void addContentTo(librevenge::RVNGPropertyList &propList) const;
249  void addStyleTo(librevenge::RVNGPropertyList &propList) const;
251  friend std::ostream &operator<<(std::ostream &o, TextZone const &zone);
257  bool m_show;
263  std::vector<STOFFEntry> m_textEntryList;
268  };
269 
271  STOFFChart(STOFFVec2f const &dim=STOFFVec2f());
273  virtual ~STOFFChart();
275  void sendChart(STOFFSpreadsheetListenerPtr &listener, librevenge::RVNGSpreadsheetInterface *interface);
277  virtual void sendContent(TextZone const &zone, STOFFListenerPtr &listener) const =0;
278 
280  void setGridColor(STOFFColor const &color)
281  {
282  m_gridColor=color;
283  }
285  Axis &getAxis(int coord);
287  Axis const &getAxis(int coord) const;
288 
290  Legend const &getLegend() const
291  {
292  return m_legend;
293  }
296  {
297  return m_legend;
298  }
299 
301  Serie *getSerie(int id, bool create);
303  std::map<int, Serie> const &getIdSerieMap() const
304  {
305  return m_serieMap;
306  }
308  TextZone *getTextZone(TextZone::Type type, bool create=false);
309 
310 protected:
312  void sendTextZoneContent(TextZone::Type type, STOFFListenerPtr &listener) const;
313 
314 public:
326  bool m_is3D;
329 
330  // main
331 
335  librevenge::RVNGString m_name;
336 
337  // plot area
338 
343 
344  // legend
345 
348 
353 
354 protected:
358  Axis m_axis[5];
362  std::map<int, Serie> m_serieMap;
364  std::map<TextZone::Type, TextZone> m_textZoneMap;
365 private:
366  explicit STOFFChart(STOFFChart const &orig) = delete;
367  STOFFChart &operator=(STOFFChart const &orig) = delete;
368 };
369 
370 #endif
371 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
bool valid() const
returns true if the textbox is valid
Definition: STOFFChart.hxx:234
Legend const & getLegend() const
returns the legend
Definition: STOFFChart.hxx:290
STOFFVec2f m_position
the position in points
Definition: STOFFChart.hxx:160
STOFFGraphicStyle m_style
the graphic style
Definition: STOFFChart.hxx:164
a cell position
Definition: STOFFChart.hxx:62
ContentType m_contentType
the content type
Definition: STOFFChart.hxx:255
void setGridColor(STOFFColor const &color)
set the grid color
Definition: STOFFChart.hxx:280
std::string getCellName(STOFFVec2i const &cellPos, STOFFVec2b const &relative)
returns the cell name corresponding to a cell&#39;s position
Definition: libstaroffice_internal.cxx:455
Type m_type
the sequence type
Definition: STOFFChart.hxx:112
STOFFGraphicStyle m_floorStyle
floor
Definition: STOFFChart.hxx:350
PointType m_pointType
the point type
Definition: STOFFChart.hxx:220
Position m_titleRange
the title cell range
Definition: STOFFChart.hxx:127
std::map< int, Serie > const & getIdSerieMap() const
returns the list of defined series
Definition: STOFFChart.hxx:303
librevenge::RVNGString m_legendText
the legend name if defined
Definition: STOFFChart.hxx:216
Legend m_legend
the legend
Definition: STOFFChart.hxx:360
Definition: libstaroffice_internal.hxx:180
Type
the series type
Definition: STOFFChart.hxx:169
Serie::Type m_type
the chart type (if no series)
Definition: STOFFChart.hxx:318
STOFFVec2f m_scaling
the minimum, maximum scaling(if manual)
Definition: STOFFChart.hxx:116
a text zone a chart
Definition: STOFFChart.hxx:223
STOFFFont m_font
the font
Definition: STOFFChart.hxx:162
bool m_dataVertical
a flag to know if the data are vertical (for bar)
Definition: STOFFChart.hxx:324
bool m_useSecondaryY
use or not the secondary y axis
Definition: STOFFChart.hxx:208
bool m_automaticScaling
automatic scaling (or manual)
Definition: STOFFChart.hxx:114
bool m_showTitle
show or not the title/subtitle
Definition: STOFFChart.hxx:125
STOFFGraphicStyle m_plotAreaStyle
the ploat area style
Definition: STOFFChart.hxx:342
STOFFVec2i m_pos
the cell column and row
Definition: STOFFChart.hxx:94
ContentType
the text content type
Definition: STOFFChart.hxx:227
Definition: STOFFChart.hxx:98
a legend in a chart
Definition: STOFFChart.hxx:136
std::ostream & operator<<(std::ostream &o, STOFFColor const &c)
Definition: libstaroffice_internal.cxx:214
librevenge::RVNGString m_sheetName
the cell sheet name
Definition: STOFFChart.hxx:96
PointType
the point type
Definition: STOFFChart.hxx:171
librevenge::RVNGString m_name
the chart name
Definition: STOFFChart.hxx:335
std::vector< STOFFEntry > m_textEntryList
the text entry (or the list of text entry)
Definition: STOFFChart.hxx:263
librevenge::RVNGString m_title
the title label
Definition: STOFFChart.hxx:129
STOFFVec2f m_dimension
the chart dimension in point
Definition: STOFFChart.hxx:316
STOFFFont m_font
the label font
Definition: STOFFChart.hxx:210
bool is1DStyle() const
return true if the serie style is 1D
Definition: STOFFChart.hxx:186
Definition: STOFFChart.hxx:173
STOFFGraphicStyle m_style
the graphic style
Definition: STOFFChart.hxx:218
Legend()
constructor
Definition: STOFFChart.hxx:138
Legend & getLegend()
returns the legend
Definition: STOFFChart.hxx:295
Type
the axis content
Definition: STOFFChart.hxx:100
STOFFGraphicStyle m_style
the graphic style
Definition: STOFFChart.hxx:267
bool valid(Position const &maxPos) const
return true if the position is valid
Definition: STOFFChart.hxx:75
Definition: STOFFChart.hxx:174
std::shared_ptr< STOFFSpreadsheetListener > STOFFSpreadsheetListenerPtr
a smart pointer of STOFFSpreadsheetListener
Definition: libstaroffice_internal.hxx:497
bool operator!=(Position &pos) const
operator!=
Definition: STOFFChart.hxx:89
Position m_cell
the cell position ( or title and subtitle)
Definition: STOFFChart.hxx:261
bool m_dataStacked
a flag to know if the data are stacked or not
Definition: STOFFChart.hxx:320
a class used to store a chart associated to a spreadsheet ....
Definition: STOFFChart.hxx:57
bool m_is3D
a flag to know if the graphic is 3D
Definition: STOFFChart.hxx:326
STOFFGraphicStyle m_style
the chart style
Definition: STOFFChart.hxx:333
bool valid() const
return true if the serie is valid
Definition: STOFFChart.hxx:191
Type m_type
the zone type
Definition: STOFFChart.hxx:253
Internal: the subdocument of a STOFFChart.
Definition: STOFFChart.cxx:61
bool m_dataPercentStacked
a flag to know if the data are percent stacked or not
Definition: STOFFChart.hxx:322
std::map< int, Serie > m_serieMap
the list of series
Definition: STOFFChart.hxx:362
Type m_type
the type
Definition: STOFFChart.hxx:204
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libstaroffice_internal.cxx:50
STOFFGraphicStyle m_wallStyle
wall
Definition: STOFFChart.hxx:352
STOFFBox2f m_legendPosition
the legend dimension in percent
Definition: STOFFChart.hxx:347
bool m_is3DDeep
a flag to know if real 3D or 2D-extended
Definition: STOFFChart.hxx:328
STOFFFont m_font
the zone format
Definition: STOFFChart.hxx:265
STOFFVec2< int > STOFFVec2i
STOFFVec2 of int.
Definition: libstaroffice_internal.hxx:767
bool m_showGrid
show or not the grid
Definition: STOFFChart.hxx:118
std::map< TextZone::Type, TextZone > m_textZoneMap
a map text zone type to text zone
Definition: STOFFChart.hxx:364
bool m_show
true if the zone is visible
Definition: STOFFChart.hxx:257
a serie in a chart
Definition: STOFFChart.hxx:167
the class to store a color
Definition: libstaroffice_internal.hxx:189
Class to store font.
Definition: STOFFFont.hxx:43
Position m_legendRange
the legend range if defined
Definition: STOFFChart.hxx:214
bool m_show
show or not the legend
Definition: STOFFChart.hxx:154
librevenge::RVNGString m_subTitle
the subtitle label
Definition: STOFFChart.hxx:131
Definition: STOFFChart.hxx:172
STOFFColor m_gridColor
the grid color
Definition: STOFFChart.hxx:356
bool m_autoPosition
automatic position
Definition: STOFFChart.hxx:156
STOFFVec2f m_position
the position in the zone
Definition: STOFFChart.hxx:259
std::shared_ptr< STOFFListener > STOFFListenerPtr
a smart pointer of STOFFListener
Definition: libstaroffice_internal.hxx:491
bool valid() const
return true if the position is valid
Definition: STOFFChart.hxx:70
STOFFBox2f m_plotAreaPosition
the plot area dimension in percent
Definition: STOFFChart.hxx:340
STOFFVec2< float > STOFFVec2f
STOFFVec2 of float.
Definition: libstaroffice_internal.hxx:771
Position(STOFFVec2i pos=STOFFVec2i(-1,-1), librevenge::RVNGString const &sheetName="")
constructor
Definition: STOFFChart.hxx:64
STOFFGraphicStyle m_style
the graphic style
Definition: STOFFChart.hxx:133
bool operator==(Position &pos) const
operator==
Definition: STOFFChart.hxx:84
int m_relativePosition
the automatic position libstoff::LeftBit|...
Definition: STOFFChart.hxx:158
Type
the text type
Definition: STOFFChart.hxx:225
Class to store a graphic style.
Definition: STOFFGraphicStyle.hxx:44
Internal: the structures of a STOFFChart.
Definition: STOFFChart.cxx:57
bool m_showLabel
show or not the label
Definition: STOFFChart.hxx:120

Generated on Sat Sep 24 2022 13:45:43 for libstaroffice by doxygen 1.8.13