aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThanasis Antoniou2019-07-31 16:48:44 +0300
committerEugene Sandulenko2019-08-02 00:08:38 +0200
commit4630895ccc36a86ff3d3908e7127a063f98e6c6f (patch)
tree846717f978311c216b712efbb07c3af2999067e8
parent1bca3de594d5403ce0a71ffe2c3b5e1107bc816e (diff)
downloadscummvm-rg350-4630895ccc36a86ff3d3908e7127a063f98e6c6f.tar.gz
scummvm-rg350-4630895ccc36a86ff3d3908e7127a063f98e6c6f.tar.bz2
scummvm-rg350-4630895ccc36a86ff3d3908e7127a063f98e6c6f.zip
COMMON: Explain new params for wordWrapText()
-rw-r--r--graphics/font.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/graphics/font.h b/graphics/font.h
index 2fd5103a99..d9f81cca8c 100644
--- a/graphics/font.h
+++ b/graphics/font.h
@@ -173,6 +173,8 @@ public:
* @param maxWidth the maximum width a line may have
* @param lines the string list to which the text lines from str are appended
* @param initWidth the starting width of the first line, for partially filled lines (optional)
+ * @param evenWidthLinesModeEnabled if enabled, the resulting line segments will be close to the same width (optional)
+ * @param wrapOnExplicitNewLines if enabled, forces wrapping on new line characters, otherwise treats them as single white space (optional)
* @return the maximal width of any of the lines added to lines
*/
int wordWrapText(const Common::String &str, int maxWidth, Common::Array<Common::String> &lines, int initWidth = 0, bool evenWidthLinesModeEnabled = false, bool wrapOnExplicitNewLines = true) const;