summaryrefslogtreecommitdiff
path: root/src/subtitle_string.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2014-05-04 01:25:31 +0100
committerCarl Hetherington <cth@carlh.net>2014-05-04 01:25:31 +0100
commitad3f59faa168a529048e0f631c31dfd6fb3d01e3 (patch)
tree7fe1d85e6e9876361a5b001875610da66eae9f1e /src/subtitle_string.h
parent41c4d628f7ef3c9f9b434d34ff099f5fe4de1ae4 (diff)
Comments.
Diffstat (limited to 'src/subtitle_string.h')
-rw-r--r--src/subtitle_string.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/subtitle_string.h b/src/subtitle_string.h
index 076a6ec7..03d3d4f8 100644
--- a/src/subtitle_string.h
+++ b/src/subtitle_string.h
@@ -17,6 +17,10 @@
*/
+/** @file src/subtitle_string.h
+ * @brief SubtitleString class.
+ */
+
#ifndef LIBDCP_SUBTITLE_STRING_H
#define LIBDCP_SUBTITLE_STRING_H
@@ -26,6 +30,9 @@
namespace dcp {
+/** @class SubtitleString
+ * @brief A single line of subtitle text with all the associated attributes.
+ */
class SubtitleString
{
public:
@@ -100,8 +107,11 @@ public:
int size_in_pixels (int screen_height) const;
private:
+ /** font name */
std::string _font;
+ /** true if the text is italic */
bool _italic;
+ /** text colour */
Color _color;
/** Size in points as if the screen height is 11 inches, so a 72pt font
* would be 1/11th of the screen height.