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 #include <boost/optional.hpp>
  24
  25 namespace sub {
  26
  27 /** @class FontSize
  28  *  @brief A description of a font's size in one of a number of ways.
  29  *
  30  *  An object of this class holds a font's size in one way, and it can convert
  31  *  to another on supply of the required conversion parameters.
  32  */
  33 class FontSize
  34 {
  35 public:
  36         void set_proportional (float p) {
  37                 _proportional = p;
  38         }
  39
  40         void set_points (int p) {
  41                 _points = p;
  42         }
  43
  44         boost::optional<float> proportional () const {
  45                 return _proportional;
  46         }
  47
  48         boost::optional<int> points () const {
  49                 return _points;
  50         }
  51
  52         bool specified () const;
  53
  54         float proportional (int screen_height_in_points) const;
  55         int points (int screen_height_in_points) const;
  56
  57         static FontSize from_points (int p);
  58         static FontSize from_proportional (float p);
  59
  60 private:
  61         /** as a proportion of screen height */
  62         boost::optional<float> _proportional;
  63         /** in points */
  64         boost::optional<int> _points;
  65
  66 };
  67
  68 extern bool operator== (FontSize const & a, FontSize const & b);
  69
  70 }
  71
  72 #endif