Document that wxTE_READONLY can't be used with wxTextEntryDialog

This style doesn't make any sense here, but using it is confusing
because it has the same value as wxCANCEL and is interpreted as it,
rather than as expected by users.

We can't do much about this, but at least document that this flag
doesn't work to prevent people from wasting time trying to use it.
This commit is contained in:
Vadim Zeitlin 2020-12-27 18:32:10 +01:00
parent f6a9466856
commit 23c7805742

View File

@ -109,9 +109,10 @@ public:
The default value, which may be the empty string.
@param style
A dialog style, specifying the buttons (wxOK, wxCANCEL)
and an optional wxCENTRE style. Additionally, wxTextCtrl styles
(such as @c wxTE_PASSWORD or @c wxTE_MULTILINE) may be specified
here.
and an optional wxCENTRE style. Additionally, most wxTextCtrl
styles (such as @c wxTE_PASSWORD or @c wxTE_MULTILINE) may be
specified here, but @c wxTE_READONLY may not be used, as it doesn't
make sense for this dialog, used for text input.
@param pos
Dialog position.