Plasma5Support

version.h
Go to the documentation of this file.
1/*
2 SPDX-FileCopyrightText: 2008 Aaron Seigo <aseigo@kde.org>
3
4 SPDX-License-Identifier: LGPL-2.0-or-later
5*/
6
7#ifndef PLASMA5SUPPORTVERSION_H
8#define PLASMA5SUPPORTVERSION_H
9
10/** @file plasma5support/version.h <Plasma5Support/Version> */
11
12#include <plasma5support/plasma5support_export.h>
13#include <plasma5support_version.h>
14
15#define PLASMA5SUPPORT_MAKE_VERSION(a, b, c) (((a) << 16) | ((b) << 8) | (c))
16
17/**
18 * Compile-time macro for checking the plasma version. Not useful for
19 * detecting the version of libplasma at runtime.
20 */
21#define PLASMA5SUPPORT_IS_VERSION(a, b, c) (PLASMA5SUPPORT_VERSION >= PLASMA5SUPPORT_MAKE_VERSION(a, b, c))
22
23/**
24 * Namespace for everything in libplasma
25 */
26namespace Plasma5Support
27{
28/**
29 * The runtime version of libplasma
30 */
31PLASMA5SUPPORT_EXPORT unsigned int version();
32
33/**
34 * The runtime major version of libplasma
35 */
36PLASMA5SUPPORT_EXPORT unsigned int versionMajor();
37
38/**
39 * The runtime major version of libplasma
40 */
41PLASMA5SUPPORT_EXPORT unsigned int versionMinor();
42
43/**
44 * The runtime major version of libplasma
45 */
46PLASMA5SUPPORT_EXPORT unsigned int versionRelease();
47
48/**
49 * The runtime version string of libplasma
50 */
51PLASMA5SUPPORT_EXPORT const char *versionString();
52
53/**
54 * Verifies that a plugin is compatible with plasma
55 */
56PLASMA5SUPPORT_EXPORT bool isPluginVersionCompatible(unsigned int version);
57
58} // Plasma5Support namespace
59
60#endif // multiple inclusion guard
Namespace for everything in libplasma.
Definition datamodel.cpp:15
unsigned int version()
The runtime version of libplasma.
Definition version.cpp:13
unsigned int versionMinor()
The runtime major version of libplasma.
Definition version.cpp:23
const char * versionString()
The runtime version string of libplasma.
Definition version.cpp:33
bool isPluginVersionCompatible(unsigned int version)
Verifies that a plugin is compatible with plasma.
Definition version.cpp:38
unsigned int versionRelease()
The runtime major version of libplasma.
Definition version.cpp:28
unsigned int versionMajor()
The runtime major version of libplasma.
Definition version.cpp:18
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 16:59:38 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.