Bump libdcp.

[libsub.git] / src / vertical_position.h

diff --git a/src/vertical_position.h b/src/vertical_position.h
index 6885f0e748e1612710967e3d55f976f98030cd67..7bc057ee132f7d0b76404b488f185a746684865c 100644 (file)
--- a/src/vertical_position.h
+++ b/src/vertical_position.h
@@ -25,21 +25,27 @@
 
 namespace sub {
 
-/** Vertical position of the baseline of some text */
+/** @class VerticalPosition
+ *  @brief Vertical position of the baseline of some text, expressed in one of a number of ways.
+ */
 class VerticalPosition
 {
 public:
        /** as a proportion of screen height offset from some reference point */
        boost::optional<float> proportional;
-       /** reference position for proportional */
-       boost::optional<VerticalReference> reference;
-       /** line number from the top of the screen */
+       /** line number offset from some reference point */
        boost::optional<int> line;
-       
+       /** number of lines on the whole screen (i.e. height of the screen in lines) */
+       boost::optional<int> lines;
+       /** reference point */
+       boost::optional<VerticalReference> reference;
+
        bool operator== (VerticalPosition const & other) const;
-       
+       bool operator< (VerticalPosition const & other) const;
+
+       float fraction_from_screen_top () const;
 };
-       
+
 }
 
 #endif