src/vertical_position.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_VERTICAL_POSITION_H
  21 #define LIBSUB_VERTICAL_POSITION_H
  22
  23 #include "vertical_reference.h"
  24 #include <boost/optional.hpp>
  25
  26 namespace sub {
  27
  28 /** @class VerticalPosition
  29  *  @brief Vertical position of the baseline of some text, expressed in one of a number of ways.
  30  */
  31 class VerticalPosition
  32 {
  33 public:
  34         /** as a proportion of screen height offset from some reference point */
  35         boost::optional<float> proportional;
  36         /** line number offset from some reference point */
  37         boost::optional<int> line;
  38         /** number of lines on the whole screen (i.e. height of the screen in lines) */
  39         boost::optional<int> lines;
  40         /** reference point */
  41         boost::optional<VerticalReference> reference;
  42
  43         bool operator== (VerticalPosition const & other) const;
  44         bool operator< (VerticalPosition const & other) const;
  45
  46         float fraction_from_screen_top () const;
  47 };
  48
  49 }
  50
  51 #endif