autodoc/inc/ary/doc/d_boolean.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: d_boolean.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ARY_DOC_D_BOOLEAN_HXX
  32 #define ARY_DOC_D_BOOLEAN_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/doc/d_node.hxx>
  36
  37 // USED SERVICES
  38
  39
  40
  41
  42 namespace ary
  43 {
  44 namespace doc
  45 {
  46
  47
  48 /** Repesents a boolean documentation item like "optional" or "not optional".
  49 */
  50 class Boolean : public Node
  51 {
  52   public:
  53     // LIFECYCLE
  54     explicit                    Boolean(
  55                             nodetype::id        i_type );
  56     virtual                             ~Boolean();
  57
  58     // OPERATIONS
  59     void                Set(
  60                             bool                i_b );
  61     // INQUIRY
  62     bool                IsTrue() const;
  63
  64   private:
  65     // Interface csv::ConstProcessorClient:
  66     virtual void        do_Accept(
  67                             csv::ProcessorIfc & io_processor ) const;
  68     // DATA
  69     bool                                b;
  70 };
  71
  72
  73
  74
  75 // IMPLEMENTATION
  76 inline
  77 Boolean::Boolean(nodetype::id i_type)
  78     :   Node(i_type),
  79         b(false)
  80 {
  81 }
  82
  83 inline bool
  84 Boolean::IsTrue() const
  85 {
  86     return b;
  87 }
  88
  89 inline void
  90 Boolean::Set( bool i_b )
  91 {
  92     b = i_b;
  93 }
  94
  95
  96
  97 }   // namespace doc
  98 }   // namespace ary
  99 #endif