folks/types.vala

   1 /*
   2  * Copyright (C) 2010 Collabora Ltd.
   3  *
   4  * This library is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation, either version 2.1 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  * Authors:
  18  *       Travis Reitter <travis.reitter@collabora.co.uk>
  19  */
  20
  21 using GLib;
  22
  23 /**
  24  * New general types required by Folks.
  25  *
  26  * @since 0.3.1
  27  */
  28 namespace Folks
  29 {
  30   /**
  31    * A 'boolean' type that has a distinct 'unset' state.
  32    *
  33    * @since 0.3.1
  34    */
  35   public enum MaybeBool
  36     {
  37       /**
  38        * This value is explicitly unset.
  39        */
  40       UNSET = 0,
  41       /**
  42        * False (this value was set from its default of UNSET).
  43        */
  44       FALSE = 1,
  45       /**
  46        * True (this value was set from its default of UNSET).
  47        */
  48       TRUE = 2,
  49     }
  50 }