bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override
{
    int score = 0;
    const auto idx = sourceModel()->index(sourceRow, 0, sourceParent);
    const auto actionName = idx.data().toString().splitRef(QLatin1Char(':')).at(1);
    const bool res = kfts::fuzzy_match_sequential(m_pattern, actionName, score);
    // store the score in the source model
    sourceModel()->setData(idx, score, ScoreRole);
    return res;
}

bool lessThan(const QModelIndex &sourceLeft, const QModelIndex &sourceRight) const override
{
    // use the score here to sort
    const int l = sourceLeft.data(ScoreRole).toInt();
    const int r = sourceRight.data(ScoreRole).toInt();
    return l < r;
}

Q_SLOT void setFilterString(const QString &string)
{
    beginResetModel();
    m_pattern = string;
    endResetModel();
}

Function Documentation

[since 5.79] KFuzzyMatcher::Result KFuzzyMatcher::match(QStringView pattern, QStringView str)

This is the main function which does scored fuzzy matching.

The return value of this function contains Result#score which should be used to sort the results. Without sorting of the results this function won't very effective.

If pattern is empty, the function will return true

pattern to search for. For e.g., text entered by a user to filter a list or model

str the current string from your list of strings

Returns A Result type with score of this match and whether the match was successful. If there is no match, score is zero. If the match is successful, score must be used to sort the results.

This function was introduced in 5.79.

[since 5.79] bool KFuzzyMatcher::matchSimple(QStringView pattern, QStringView str)

Simple fuzzy matching of chars in pattern with chars in str sequentially. If there is a match, it will return true and false otherwise. There is no scoring. You should use this if score is not important for you and only matching is important.

If pattern is empty, the function will return true

pattern to search for. For e.g., text entered by a user to filter a list

str the current string from your list of strings

Returns true on sucessful match

This function was introduced in 5.79.

[since 5.84] QList<KFuzzyMatcher::Range> KFuzzyMatcher::matchedRanges(QStringView pattern, QStringView str, KFuzzyMatcher::RangeType type = RangeType::FullyMatched)

A function which returns the positions + lengths where the pattern matched inside the str. The resulting ranges can then be utilized to show the user where the matches occurred. Example:

String: hello
Pattern: Hlo

Output: [Range{0, 1}, Range{3, 2}]

In the above example "Hlo" matched inside the string "hello" in two places i.e., position 0 and position 3. At position 0 it matched 'h', and at position 3 it matched 'lo'.

The ranges themeselves can't do much so you will have to make the result useful in your own way. Some possible uses can be: - Transform the result into a vector of QTextLayout::FormatRange and then paint them in the view - Use the result to transform the string into html, for example conver the string from above example to "<b>H</b>el<b>lo</b>, and then use QTextDocument to paint it into your view.

Example with the first method:

auto ranges = KFuzzyMatcher::matchedRanges(pattern, string);
QList<QTextLayout::FormatRange> out;
std::transform(ranges.begin(), ranges.end(), std::back_inserter(out), [](const KFuzzyMatcher::Range &fr){
   return QTextLayout::FormatRange{fr.start, fr.length, QTextCharFormat()};
});

QTextLayout layout(text, font);
layout.beginLayout();
QTextLine line = layout.createLine();
//...
layout.endLayout();

layout.setFormats(layout.formats() + out);
layout.draw(painter, position);

If pattern is empty, the function will return an empty vector

if type is RangeType::All, the function will try to get ranges even if the pattern didn't fully match. For example:

pattern: "git"
string: "gti"
RangeType: All

Output: [Range{0, 1}, Range{2, 1}]

pattern to search for. For e.g., text entered by a user to filter a list or model

str the current string from your list of strings

type whether to consider ranges from full matches only or all matches including partial matches

Returns A vector of ranges containing positions and lengths where the pattern matched. If there was no match, the vector will be empty

This function was introduced in 5.84.