| 1 | /* |
|---|
| 2 | This file is part of the KDE Libraries |
|---|
| 3 | |
|---|
| 4 | SPDX-FileCopyrightText: 2016 David Edmundson <davidedmundson@kde.org> |
|---|
| 5 | |
|---|
| 6 | SPDX-License-Identifier: LGPL-2.0-or-later |
|---|
| 7 | */ |
|---|
| 8 | |
|---|
| 9 | #ifndef KCOREADDONS_H |
|---|
| 10 | #define KCOREADDONS_H |
|---|
| 11 | |
|---|
| 12 | #include <QString> |
|---|
| 13 | #include <kcoreaddons_export.h> |
|---|
| 14 | |
|---|
| 15 | /*! |
|---|
| 16 | * \namespace KCoreAddons |
|---|
| 17 | * \inmodule KCoreAddons |
|---|
| 18 | * |
|---|
| 19 | * \brief Provides utility functions for metadata about the KCoreAddons library. |
|---|
| 20 | */ |
|---|
| 21 | namespace KCoreAddons |
|---|
| 22 | { |
|---|
| 23 | /*! |
|---|
| 24 | * Returns the version number of KCoreAddons at run-time as a string (for example, "5.19.0"). |
|---|
| 25 | * |
|---|
| 26 | * This may be a different version than the version the application was compiled against. |
|---|
| 27 | * \since 5.20 |
|---|
| 28 | */ |
|---|
| 29 | KCOREADDONS_EXPORT QString versionString(); |
|---|
| 30 | |
|---|
| 31 | /*! |
|---|
| 32 | * Returns a numerical version number of KCoreAddons at run-time in the form 0xMMNNPP |
|---|
| 33 | * (MM = major, NN = minor, PP = patch) |
|---|
| 34 | * This can be compared using the macro QT_VERSION_CHECK. |
|---|
| 35 | * |
|---|
| 36 | * For example: |
|---|
| 37 | * \code |
|---|
| 38 | * if (KCoreAddons::version() < QT_VERSION_CHECK(5,19,0)) |
|---|
| 39 | * \endcode |
|---|
| 40 | * |
|---|
| 41 | * This may be a different version than the version the application was compiled against. |
|---|
| 42 | * \since 5.20 |
|---|
| 43 | */ |
|---|
| 44 | KCOREADDONS_EXPORT unsigned int version(); |
|---|
| 45 | } |
|---|
| 46 | |
|---|
| 47 | #endif |
|---|
| 48 | |
|---|
