src/contrib/libqxt-2007-10-24/src/core/qxtnull.h

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