src/vertical_reference.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_REFERENCE_H
  21 #define LIBSUB_VERTICAL_REFERENCE_H
  22
  23 #include <string>
  24
  25 namespace sub {
  26
  27 enum VerticalReference
  28 {
  29         /** distance is from the top of the screen to the top of the subtitle, positive moves down */
  30         TOP_OF_SCREEN,
  31         /** distance is from the centre of the screen to the centre of the subtitle, positive moves down */
  32         VERTICAL_CENTRE_OF_SCREEN,
  33         /** distance is from the bottom of the screen to the bottom of the subtitle, positive moves up */
  34         BOTTOM_OF_SCREEN,
  35         /** position on screen is not known, so we are referring
  36          *  to the top of the subtitle; positive distances move down from there
  37          */
  38         TOP_OF_SUBTITLE
  39 };
  40
  41 VerticalReference string_to_vertical_reference (std::string s);
  42
  43 }
  44
  45 #endif