Some Doxygen comments.
[libsub.git] / src / font_size.h
1 /*
2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #ifndef LIBSUB_FONT_SIZE_H
21 #define LIBSUB_FONT_SIZE_H
22
23 namespace sub {
24
25 /** @class FontSize
26  *  @brief A description of a font's size in one of a number of ways.
27  *
28  *  An object of this class holds a font's size in one way, and it can convert
29  *  to another on supply of the required conversion parameters.
30  */
31 class FontSize
32 {
33 public:
34         void set_proportional (float p) {
35                 _proportional = p;
36         }
37         
38         void set_points (int p) {
39                 _points = p;
40         }
41
42         boost::optional<float> proportional () const {
43                 return _proportional;
44         }
45         
46         boost::optional<int> points () const {
47                 return _points;
48         }
49         
50         float proportional (int screen_height_in_points) const;
51         int points (int screen_height_in_points) const;
52         
53 private:                
54         /** as a proportion of screen height */
55         boost::optional<float> _proportional;
56         /** in points */
57         boost::optional<int> _points;
58         
59 };
60
61 }
62
63 #endif