okular/generators/comicbook/qnatsort.h
2021-06-10 08:11:56 +00:00

42 lines
1.1 KiB
C

/*
Natural order sorting of strings which contains numbers.
SPDX-FileCopyrightText: 2007 Tobias Koenig <tokoe@kde.org>
SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
based on the natural order code by Martin Pool <mbp sourcefrog net>
*/
#ifndef QNATSORT_H
#define QNATSORT_H
#include <QString>
/**
* The two methods can be used in qSort to sort strings which contain
* numbers in natural order.
*
* Normally strings are ordered like this: fam10g fam1g fam2g fam3g
* natural ordered it would look like this: fam1g fam2g fam3g fam10g
*
* Code:
*
* QStringList list;
* list << "fam10g" << "fam1g" << "fam2g" << "fam5g";
*
* qSort( list.begin(), list.end(), caseSensitiveNaturalOderLessThen );
*/
/**
* Returns whether the @p left string is lesser than the @p right string
* in natural order.
*/
bool caseSensitiveNaturalOrderLessThen(const QString &left, const QString &right);
/**
* Returns whether the @p left string is lesser than the @p right string
* in natural order and case insensitive.
*/
bool caseInsensitiveNaturalOrderLessThen(const QString &left, const QString &right);
#endif