StarGraphicStruct.hxx Source File documentation

StarGraphicStruct.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#ifndef STAR_GRAPHIC_STRUCT
35# define STAR_GRAPHIC_STRUCT
36
37#include <ostream>
38#include <string>
39#include <vector>
40
41#include "libstaroffice_internal.hxx"
42
43class StarBitmap;
44class StarObject;
45class StarZone;
46
48namespace StarGraphicStruct
49{
51 class StarBrush
52{
53public:
55 StarBrush()
56 : m_transparency(0)
57 , m_color(STOFFColor::white())
58 , m_fillColor(STOFFColor::white())
59 , m_style(0)
60 , m_position(0)
61 , m_linkName("")
62 , m_filterName("")
63 , m_extra("")
64 {
65 }
67 bool isEmpty() const
68 {
69 return m_style<=0 || m_style>=11 || m_transparency>=255;
70 }
72 bool hasUniqueColor() const
73 {
74 return m_style==1;
75 }
77 bool getColor(STOFFColor &color) const;
79 bool getPattern(STOFFEmbeddedObject &object, STOFFVec2i &sz) const;
81 bool read(StarZone &zone, int nVers, long endPos, StarObject &document);
83 friend std::ostream &operator<<(std::ostream &o, StarBrush const &brush);
85 int m_transparency;
87 STOFFColor m_color;
89 STOFFColor m_fillColor;
92 int m_style;
94 int m_position;
96 librevenge::RVNGString m_linkName;
98 librevenge::RVNGString m_filterName;
100 std::string m_extra;
101};
102
104 class StarGraphic
105{
106public:
108 StarGraphic()
109 : m_object()
110 , m_bitmap()
111 {
112 }
114 bool read(StarZone &zone, long lastPos=-1);
116 STOFFEmbeddedObject m_object;
118 std::shared_ptr<StarBitmap> m_bitmap;
119};
120
122 class StarPolygon
123{
124public:
126 struct Point {
128 explicit Point(STOFFVec2i point=STOFFVec2i(), int flag=0)
129 : m_point(point)
130 , m_flags(flag)
131 {
132 }
134 friend std::ostream &operator<<(std::ostream &o, Point const &point)
135 {
136 o << point.m_point;
137 switch (point.m_flags) {
138 case 0:
139 break;
140 case 1: // smooth
141 o << ":s";
142 break;
143 case 2: // control
144 o << ":c";
145 break;
146 case 3: // symetric
147 o << ":S";
148 break;
149 default:
150 STOFF_DEBUG_MSG(("StarObjectSmallGraphicStruct::StarPolygon::Point::operator<< unexpected flag\n"));
151 o << ":[##" << point.m_flags << "]";
152 }
153 return o;
154 }
156 STOFFVec2i m_point;
158 int m_flags;
159 };
161 StarPolygon()
162 : m_points()
163 {
164 }
166 bool hasSpecialPoints() const
167 {
168 for (auto const &pt : m_points) {
169 if (pt.m_flags)
170 return true;
171 }
172 return false;
173 }
175 bool empty() const
176 {
177 return m_points.empty();
178 }
180 size_t size() const
181 {
182 return m_points.size();
183 }
185 void addToPath(librevenge::RVNGPropertyListVector &path, bool isClosed, double relUnit, STOFFVec2f const &decal) const;
187 bool convert(librevenge::RVNGString &path, librevenge::RVNGString &viewbox, double relUnit, STOFFVec2f const &decal) const;
189 friend std::ostream &operator<<(std::ostream &o, StarPolygon const &poly);
191 std::vector<Point> m_points;
192};
193
194}
195
196#endif
197// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFVec2< int >
StarBitmap
the main class to read/.
Definition: StarBitmap.hxx:63
StarGraphicStruct::StarBrush
Class to store a brush.
Definition: StarGraphicStruct.hxx:52
StarGraphicStruct::StarBrush::getPattern
bool getPattern(STOFFEmbeddedObject &object, STOFFVec2i &sz) const
try to return a pattern corresponding to the brush
Definition: StarGraphicStruct.cxx:434
StarGraphicStruct::StarBrush::hasUniqueColor
bool hasUniqueColor() const
returns true is the brush has unique color
Definition: StarGraphicStruct.hxx:72
StarGraphicStruct::StarBrush::getColor
bool getColor(STOFFColor &color) const
try to return a color corresponding to the brush
Definition: StarGraphicStruct.cxx:420
StarGraphicStruct::StarBrush::m_filterName
librevenge::RVNGString m_filterName
the filter name
Definition: StarGraphicStruct.hxx:98
StarGraphicStruct::StarBrush::m_position
int m_position
the position(none, lt, mt, rt, lm, mm, rm, lb, mb, rb, area, tiled)
Definition: StarGraphicStruct.hxx:94
StarGraphicStruct::StarBrush::StarBrush
StarBrush()
constructor
Definition: StarGraphicStruct.hxx:55
StarGraphicStruct::StarBrush::operator<<
friend std::ostream & operator<<(std::ostream &o, StarBrush const &brush)
operator<<
Definition: StarGraphicStruct.cxx:463
StarGraphicStruct::StarBrush::m_style
int m_style
the brush style(pattern): BRUSH_NULL, BRUSH_SOLID, BRUSH_HORZ, BRUSH_VERT, BRUSH_CROSS,...
Definition: StarGraphicStruct.hxx:92
StarGraphicStruct::StarBrush::m_extra
std::string m_extra
extra data
Definition: StarGraphicStruct.hxx:100
StarGraphicStruct::StarBrush::m_fillColor
STOFFColor m_fillColor
the fill color
Definition: StarGraphicStruct.hxx:89
StarGraphicStruct::StarBrush::read
bool read(StarZone &zone, int nVers, long endPos, StarObject &document)
try to read a brush
Definition: StarGraphicStruct.cxx:498
StarGraphicStruct::StarBrush::m_transparency
int m_transparency
the transparency
Definition: StarGraphicStruct.hxx:85
StarGraphicStruct::StarBrush::m_linkName
librevenge::RVNGString m_linkName
the link name
Definition: StarGraphicStruct.hxx:96
StarGraphicStruct::StarBrush::m_color
STOFFColor m_color
the color
Definition: StarGraphicStruct.hxx:87
StarGraphicStruct::StarBrush::isEmpty
bool isEmpty() const
returns true if the brush is empty
Definition: StarGraphicStruct.hxx:67
StarGraphicStruct::StarGraphic
Class to store a graphic.
Definition: StarGraphicStruct.hxx:105
StarGraphicStruct::StarGraphic::read
bool read(StarZone &zone, long lastPos=-1)
try to read a graphic, give lastPos if you are sure of the end graphic position
Definition: StarGraphicStruct.cxx:549
StarGraphicStruct::StarGraphic::m_object
STOFFEmbeddedObject m_object
the embedded object
Definition: StarGraphicStruct.hxx:116
StarGraphicStruct::StarGraphic::StarGraphic
StarGraphic()
constructor
Definition: StarGraphicStruct.hxx:108
StarGraphicStruct::StarGraphic::m_bitmap
std::shared_ptr< StarBitmap > m_bitmap
the bitmap
Definition: StarGraphicStruct.hxx:118
StarGraphicStruct::StarPolygon
Class to store a polygon.
Definition: StarGraphicStruct.hxx:123
StarGraphicStruct::StarPolygon::hasSpecialPoints
bool hasSpecialPoints() const
check if a polygon has special point
Definition: StarGraphicStruct.hxx:166
StarGraphicStruct::StarPolygon::size
size_t size() const
returns true if the polygon is empty
Definition: StarGraphicStruct.hxx:180
StarGraphicStruct::StarPolygon::operator<<
friend std::ostream & operator<<(std::ostream &o, StarPolygon const &poly)
operator<<
Definition: StarGraphicStruct.cxx:731
StarGraphicStruct::StarPolygon::m_points
std::vector< Point > m_points
the list of points
Definition: StarGraphicStruct.hxx:191
StarGraphicStruct::StarPolygon::convert
bool convert(librevenge::RVNGString &path, librevenge::RVNGString &viewbox, double relUnit, STOFFVec2f const &decal) const
convert a path in a string and update the bdbox
Definition: StarGraphicStruct.cxx:716
StarGraphicStruct::StarPolygon::StarPolygon
StarPolygon()
contructor
Definition: StarGraphicStruct.hxx:161
StarGraphicStruct::StarPolygon::addToPath
void addToPath(librevenge::RVNGPropertyListVector &path, bool isClosed, double relUnit, STOFFVec2f const &decal) const
add the polygon to a path
Definition: StarGraphicStruct.cxx:678
StarGraphicStruct::StarPolygon::empty
bool empty() const
returns true if the polygon is empty
Definition: StarGraphicStruct.hxx:175
StarObject
an object corresponding to an OLE directory
Definition: StarObject.hxx:65
StarZone
a zone in a StarOffice file
Definition: StarZone.hxx:57
libstaroffice_internal.hxx
STOFFVec2i
STOFFVec2< int > STOFFVec2i
STOFFVec2 of int.
Definition: libstaroffice_internal.hxx:767
STOFF_DEBUG_MSG
#define STOFF_DEBUG_MSG(M)
Definition: libstaroffice_internal.hxx:129
StarGraphicStruct
a name use to define basic StarOffice graphic structure
Definition: StarGraphicStruct.cxx:51
STOFFColor
the class to store a color
Definition: libstaroffice_internal.hxx:189
STOFFEmbeddedObject
small class use to define a embedded object
Definition: libstaroffice_internal.hxx:408
StarGraphicStruct::StarPolygon::Point
a structure to keep a point and a flag
Definition: StarGraphicStruct.hxx:126
StarGraphicStruct::StarPolygon::Point::operator<<
friend std::ostream & operator<<(std::ostream &o, Point const &point)
operator<<
Definition: StarGraphicStruct.hxx:134
StarGraphicStruct::StarPolygon::Point::Point
Point(STOFFVec2i point=STOFFVec2i(), int flag=0)
constructor
Definition: StarGraphicStruct.hxx:128
StarGraphicStruct::StarPolygon::Point::m_flags
int m_flags
the flags
Definition: StarGraphicStruct.hxx:158
StarGraphicStruct::StarPolygon::Point::m_point
STOFFVec2i m_point
the point
Definition: StarGraphicStruct.hxx:156