/thirdparty/qxt/qxtweb-standalone/qxtweb/qxtnull.h

 1/****************************************************************************
 2 **
 3 ** Copyright (C) Qxt Foundation. Some rights reserved.
 4 **
 5 ** This file is part of the QxtCore module of the Qxt library.
 6 **
 7 ** This library is free software; you can redistribute it and/or modify it
 8 ** under the terms of the Common Public License, version 1.0, as published
 9 ** by IBM, and/or under the terms of the GNU Lesser General Public License,
10 ** version 2.1, as published by the Free Software Foundation.
11 **
12 ** This file is provided "AS IS", without WARRANTIES OR CONDITIONS OF ANY
13 ** KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY
14 ** WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR
15 ** FITNESS FOR A PARTICULAR PURPOSE.
16 **
17 ** You should have received a copy of the CPL and the LGPL along with this
18 ** file. See the LICENSE file and the cpl1.0.txt/lgpl-2.1.txt files
19 ** included with the source distribution for more information.
20 ** If you did not receive a copy of the licenses, contact the Qxt Foundation.
21 **
22 ** <http://libqxt.org>  <foundation@libqxt.org>
23 **
24 ****************************************************************************/
25
26#ifndef QXTNULL_H
27#define QXTNULL_H
28
29#include <qxtglobal.h>
30
31/*!
32\class QxtNull QxtNull
33
34\inmodule QxtCore
35
36\brief An object representing the "null" value for QxtNullable.
37
38\sa QxtNullable
39*/
40
41struct QXT_CORE_EXPORT QxtNull
42{
43    /*! integer cast operator
44     * In expressions, QxtNull behaves as an integer zero for compatibility with generic functions.
45     */
46    operator int() const
47    {
48        return 0;
49    }
50    enum { isNull = true };
51};
52
53#ifndef QXT_NO_MACROS
54
55/*! \relates QxtNull
56 * A convenience alias for QxtNull().
57 */
58#define QXT_NULL QxtNull()
59
60#endif // QXT_NO_MACROS
61
62#endif // QXTNULL_H