autodoc/inc/ary/cpp/c_enuval.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: c_enuval.hxx,v $
  10  * $Revision: 1.4 $
  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_CPP_C_ENUVAL_HXX
  32 #define ARY_CPP_C_ENUVAL_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37 #include <ary/cpp/c_ce.hxx>
  38     // OTHER
  39 #include <ary/cessentl.hxx>
  40 #include <ary/cpp/c_types4cpp.hxx>
  41
  42
  43
  44 namespace ary
  45 {
  46 namespace cpp
  47 {
  48
  49
  50
  51 /** A C++ enum value declaration and definition.
  52 */
  53 class EnumValue : public CodeEntity
  54 {
  55   public:
  56     enum E_ClassId { class_id = 1006 };
  57
  58     // LIFECYCLE
  59                         EnumValue(
  60                             const String  &     i_sLocalName,
  61                             Ce_id               i_nOwner,
  62                             String              i_sInitialisation );
  63                         ~EnumValue();
  64     // INQUIRY
  65     const String  &     Initialisation() const;
  66
  67   private:
  68     // Interface csv::ConstProcessorClient
  69     virtual void        do_Accept(
  70                             csv::ProcessorIfc & io_processor ) const;
  71
  72     // Interface ary::cpp::CodeEntity
  73     virtual const String  &
  74                         inq_LocalName() const;
  75     virtual Cid         inq_Owner() const;
  76     virtual Lid                 inq_Location() const;
  77
  78     // Interface ary::cpp::CppEntity
  79     virtual ClassId     get_AryClass() const;
  80
  81     // DATA
  82     CeEssentials                aEssentials;
  83     String              sInitialisation;
  84 };
  85
  86
  87
  88
  89 // IMPLEMENTATION
  90 inline const String  &
  91 EnumValue::Initialisation() const
  92     { return sInitialisation; }
  93
  94
  95
  96
  97 }   // namespace cpp
  98 }   // namespace ary
  99 #endif