]> git.mxchange.org Git - simgear.git/blob - simgear/misc/CSSBorder.hxx
Update doxgen config and some comments.
[simgear.git] / simgear / misc / CSSBorder.hxx
1 // Parse and represent CSS border definitions (eg. margin, border-image-width)
2 //
3 // Copyright (C) 2013  Thomas Geymayer <tomgey@gmail.com>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Library General Public
7 // License as published by the Free Software Foundation; either
8 // version 2 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 // Library General Public License for more details.
14 //
15 // You should have received a copy of the GNU Library General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
18
19 #ifndef SG_CSSBORDER_HXX_
20 #define SG_CSSBORDER_HXX_
21
22 #include <simgear/math/SGMath.hxx>
23 #include <simgear/math/SGRect.hxx>
24 #include <string>
25
26 namespace simgear
27 {
28
29   class CSSBorder
30   {
31     public:
32       union Offsets
33       {
34         float          val[4];
35         struct { float t, r, b, l; };
36       };
37
38       union OffsetsTypes
39       {
40         bool          rel[4];
41         struct { bool t_rel, r_rel, b_rel, l_rel; };
42       };
43
44       CSSBorder():
45         valid(false)
46       {}
47
48       bool isValid() const;
49
50       /**
51        * Get whether a non-zero offset exists
52        */
53       bool isNone() const;
54
55       const std::string& getKeyword() const;
56
57       Offsets getRelOffsets(const SGRect<int>& dim) const;
58       Offsets getAbsOffsets(const SGRect<int>& dim) const;
59
60       static CSSBorder parse(const std::string& str);
61
62     private:
63       Offsets         offsets;
64       OffsetsTypes    types;
65       std::string     keyword;
66       bool            valid;
67   };
68
69 } // namespace simgear
70
71 #endif /* SG_CSSBORDER_HXX_ */