From a5529fc16c4aae06e50834c103457d92cfde7529 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Thu, 1 Dec 2016 14:54:08 +0100 Subject: [PATCH] Improve documentation of CreateTextSizer() widthMax argument Also fix the version since which it is available. See 73f6f622f911c0fc06c371e21e097653f8c3aea2 --- interface/wx/dialog.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/interface/wx/dialog.h b/interface/wx/dialog.h index 432becf5ca..6dfe57cf7a 100644 --- a/interface/wx/dialog.h +++ b/interface/wx/dialog.h @@ -294,9 +294,14 @@ public: Splits text up at newlines and places the lines into wxStaticText objects with the specified maximum width in a vertical wxBoxSizer. - @a widthMax is available since 3.1.0 + If @a widthMax has its default value of -1, only explicit new line + characters in @a message are taken into account. Otherwise, lines are + broken either after a new line or wrapped, at word boundary, if their + width would become bigger than the specified maximal width. - @param widthMax Specifies the text's maximum width. + @param widthMax Specifies the text's maximum width (this argument is + available since version 3.1.1, previous versions always behaved as if + the maximal width of -1 was specified). @see wxStaticText::Wrap(int width) */