Add a load of explicit keywords.
[dcpomatic.git] / src / lib / subtitle_content.h
index 7278b540892681fecff8a9d038c04970b3a79700..b64e4787b536b1d7fec96519027155ab9312e736 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -40,8 +40,7 @@ public:
        static int const LANGUAGE;
        static int const FONTS;
        static int const COLOUR;
-       static int const OUTLINE;
-       static int const SHADOW;
+       static int const EFFECT;
        static int const EFFECT_COLOUR;
        static int const LINE_SPACING;
        static int const FADE_IN;
@@ -58,12 +57,12 @@ public:
 class SubtitleContent : public ContentPart
 {
 public:
-       SubtitleContent (Content* parent);
+       explicit SubtitleContent (Content* parent);
        SubtitleContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
 
        void as_xml (xmlpp::Node *) const;
        std::string identifier () const;
-       void use_template (boost::shared_ptr<const SubtitleContent> c);
+       void take_settings_from (boost::shared_ptr<const SubtitleContent> c);
 
        void add_font (boost::shared_ptr<Font> font);
 
@@ -75,13 +74,17 @@ public:
        void set_y_scale (double);
        void set_language (std::string language);
        void set_colour (dcp::Colour);
-       void set_outline (bool);
-       void set_shadow (bool);
+       void unset_colour ();
+       void set_effect (dcp::Effect);
+       void unset_effect ();
        void set_effect_colour (dcp::Colour);
+       void unset_effect_colour ();
        void set_line_spacing (double s);
        void set_fade_in (ContentTime);
+       void unset_fade_in ();
        void set_fade_out (ContentTime);
        void set_outline_width (int);
+       void unset_fade_out ();
 
        bool use () const {
                boost::mutex::scoped_lock lm (_mutex);
@@ -123,22 +126,17 @@ public:
                return _language;
        }
 
-       dcp::Colour colour () const {
+       boost::optional<dcp::Colour> colour () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _colour;
        }
 
-       bool outline () const {
+       boost::optional<dcp::Effect> effect () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _outline;
+               return _effect;
        }
 
-       bool shadow () const {
-               boost::mutex::scoped_lock lm (_mutex);
-               return _shadow;
-       }
-
-       dcp::Colour effect_colour () const {
+       boost::optional<dcp::Colour> effect_colour () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _effect_colour;
        }
@@ -148,12 +146,12 @@ public:
                return _line_spacing;
        }
 
-       ContentTime fade_in () const {
+       boost::optional<ContentTime> fade_in () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _fade_in;
        }
 
-       ContentTime fade_out () const {
+       boost::optional<ContentTime> fade_out () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _fade_out;
        }
@@ -193,14 +191,13 @@ private:
        /** y scale factor to apply to subtitles */
        double _y_scale;
        std::list<boost::shared_ptr<Font> > _fonts;
-       dcp::Colour _colour;
-       bool _outline;
-       bool _shadow;
-       dcp::Colour _effect_colour;
+       boost::optional<dcp::Colour> _colour;
+       boost::optional<dcp::Effect> _effect;
+       boost::optional<dcp::Colour> _effect_colour;
        /** scaling factor for line spacing; 1 is "standard", < 1 is closer together, > 1 is further apart */
        double _line_spacing;
-       ContentTime _fade_in;
-       ContentTime _fade_out;
+       boost::optional<ContentTime> _fade_in;
+       boost::optional<ContentTime> _fade_out;
        int _outline_width;
 };