Doc: clarify case sensitivity in QCompleter

This was confusing for me, being unfamiliar with the API.

Pick-to: 6.2 5.15
Change-Id: I831c6d0aa30847e069a7c21c279f147a1b24e486
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
bb10
Mitch Curtis 2021-09-20 16:50:49 +02:00
parent 1bac82fa99
commit 3fbf1f13ae
1 changed files with 9 additions and 6 deletions

View File

@ -1179,7 +1179,7 @@ QCompleter::CompletionMode QCompleter::completionMode() const
/*!
\property QCompleter::filterMode
\brief how the filtering is performed
\brief This property controls how filtering is performed.
\since 5.2
If filterMode is set to Qt::MatchStartsWith, only those entries that start
@ -1187,11 +1187,14 @@ QCompleter::CompletionMode QCompleter::completionMode() const
the entries that contain the typed characters, and Qt::MatchEndsWith the
ones that end with the typed characters.
Currently, only these three modes are implemented. Setting filterMode to
any other Qt::MatchFlag will issue a warning, and no action will be
performed.
Setting filterMode to any other Qt::MatchFlag will issue a warning, and no
action will be performed. Because of this, the \c Qt::MatchCaseSensitive
flag has no effect. Use the \l caseSensitivity property to control case
sensitivity.
The default mode is Qt::MatchStartsWith.
\sa caseSensitivity
*/
void QCompleter::setFilterMode(Qt::MatchFlags filterMode)
@ -1719,9 +1722,9 @@ void QCompleter::setMaxVisibleItems(int maxItems)
\property QCompleter::caseSensitivity
\brief the case sensitivity of the matching
The default is Qt::CaseSensitive.
The default value is \c Qt::CaseSensitive.
\sa completionColumn, completionRole, modelSorting
\sa completionColumn, completionRole, modelSorting, filterMode
*/
void QCompleter::setCaseSensitivity(Qt::CaseSensitivity cs)
{