From 3b4580ab7c413a04f9ca53614dbd670e14ff5bd8 Mon Sep 17 00:00:00 2001 From: Jeff Shillitto Date: Wed, 14 Aug 2019 22:15:05 +1000 Subject: [PATCH] Update documentation with css parameter and valid color values --- include/QtHtmlReader.h | 5 +++-- include/QtTextReader.h | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/include/QtHtmlReader.h b/include/QtHtmlReader.h index 01defa8c..ca5f45c4 100644 --- a/include/QtHtmlReader.h +++ b/include/QtHtmlReader.h @@ -106,8 +106,9 @@ namespace openshot /// @param x_offset The number of pixels to offset the text on the X axis (horizontal) /// @param y_offset The number of pixels to offset the text on the Y axis (vertical) /// @param gravity The alignment / gravity of the text - /// @param html The html you want to render / display - /// @param background_color The background color of the text (also supports Transparent) + /// @param html The HTML you want to render / display + /// @param css The CSS you want to apply to style the HTML + /// @param background_color The background color of the frame image (valid values are a color string in #RRGGBB or #AARRGGBB notation, a CSS color name, or 'transparent') QtHtmlReader(int width, int height, int x_offset, int y_offset, GravityType gravity, std::string html, std::string css, std::string background_color); /// Close Reader diff --git a/include/QtTextReader.h b/include/QtTextReader.h index 85187afe..a3fa014c 100644 --- a/include/QtTextReader.h +++ b/include/QtTextReader.h @@ -115,8 +115,8 @@ namespace openshot /// @param text The text you want to generate / display /// @param font The font of the text /// @param font_size The size of the text - /// @param text_color The color of the text - /// @param background_color The background color of the text (also supports Transparent) + /// @param text_color The color of the text (valid values are a color string in #RRGGBB or #AARRGGBB notation or a CSS color name) + /// @param background_color The background color of the frame image (valid values are a color string in #RRGGBB or #AARRGGBB notation, a CSS color name, or 'transparent') QtTextReader(int width, int height, int x_offset, int y_offset, GravityType gravity, std::string text, std::string font, double font_size, std::string text_color, std::string background_color); /// Close Reader