Documentation update

This commit is contained in:
Leon Styhre 2023-08-10 19:32:40 +02:00
parent 5d0b4ddfc4
commit 6c03688f8e
2 changed files with 26 additions and 1 deletions

View file

@ -34,7 +34,7 @@
* Improved menu system font rendering on GPUs without proper texture filtering support
* Added a "stationary" property to all secondary elements to set them as stationary during slide transitions
* Added a "containerType" property to the text element to select between vertical and horizontal containers
* Added a number of carousel and textlist properties to control horizontally scrolling text
* Added a number of carousel, grid, textlist and text properties to control horizontally scrolling text
* Added a "textRelativeScale" property to the carousel to size text smaller than the overall item size
* Added theme support for the "manual" metadata type for the text element
* Changed the application updater to not use the scraper's transfer and connection timeout settings
@ -47,6 +47,8 @@
* Added a lot more debug log output to the scraper
* (Windows) Added a warning dialog on startup if an unsafe upgrade of the portable release has been made
* (Windows) Improved the README.txt file for the portable release
* (Windows) Defined UNICODE and _UNICODE in the CMake configuration to force Unicode support for the Win32 API
* (Windows) Added proper Unicode support to the Windows Registry find rules "winregistrypath" and "winregistryvalue"
* (macOS) Changed the minimum required OS version from 10.14 "Mojave" to 10.15 "Catalina"
* (macOS) Completely removed support for the legacy OS build
* Updated RapidJSON to commit a95e013b97ca6523f32da23f5095fcc9dd6067e5

View file

@ -1685,6 +1685,24 @@ Properties:
* `textSelectedBackgroundColor` - type: COLOR
- Sets the text background color for the currently selected item.
- Default is the same value as `textBackgroundColor`
* `textHorizontalScrolling` - type: BOOLEAN
- If this property is enabled then text that does not fit within the item width will scroll horizontally. If the property is disabled, the text will instead be truncated with an ellipsis (...). Using this property will automatically convert all line breaks to spaces so that a single line of text is always displayed.
- Default is `false`
* `textHorizontalScrollSpeed` - type: FLOAT
- A relative speed for how fast to scroll the text.
- Minimum value is `0.1` and maximum value is `10`
- Default is `1`
- This property can only be used when `textHorizontalScrolling` has been set to `true`
* `textHorizontalScrollDelay` - type: FLOAT
- Delay in seconds before scrolling starts.
- Minimum value is `0` and maximum value is `10`
- Default is `3`
- This property can only be used when `textHorizontalScrolling` has been set to `true`
* `textHorizontalScrollGap` - type: FLOAT
- As the scrolling text is looped, a second copy is rendered after the first one. This property defines a relative gap value to control the distance between these two text instances.
- Minimum value is `0.1` and maximum value is `5`
- Default is `1.5`
- This property can only be used when `textHorizontalScrolling` has been set to `true`
* `fontPath` - type: PATH
- Path to a TrueType font (.ttf) used as fallback if there is no `staticImage` / `imageType` image defined or found, and if `defaultImage` has not been defined.
* `fontSize` - type: FLOAT
@ -2483,6 +2501,11 @@ Properties:
- Minimum value is `0` and maximum value is `20`
- Default is `7`
- This property can only be used when `containerType` is `vertical`
* `containerScrollGap` - type: FLOAT
- As horizontally scrolling text is looped, a second copy is rendered after the first one. This property defines a relative gap value to control the distance between these two text instances.
- Minimum value is `0.1` and maximum value is `5`
- Default is `1.5`
- This property can only be used when `containerType` is `horizontal`
* `fontPath` - type: PATH
- Path to a TrueType font (.ttf).
* `fontSize` - type: FLOAT