autodoc/inc/ary/idl/i_enumvalue.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ARY_IDL_I_ENUMVALUE_HXX
  30 #define ARY_IDL_I_ENUMVALUE_HXX
  31
  32 // BASE CLASSES
  33 #include <ary/idl/i_ce.hxx>
  34
  35
  36
  37
  38 namespace ary
  39 {
  40 namespace idl
  41 {
  42 namespace ifc_enumvalue
  43 {
  44     struct attr;
  45 }
  46
  47
  48 /** @resp
  49     Represents an IDL enum value.
  50 */
  51 class EnumValue : public CodeEntity
  52 {
  53   public:
  54     enum E_ClassId { class_id = 2006 };
  55
  56     // LIFECYCLE
  57                         EnumValue(
  58                             const String &      i_sName,
  59                             Ce_id               i_nOwner,
  60                             Ce_id               i_nNameRoom,
  61                             const String &      i_sInitValue );
  62                         ~EnumValue();
  63     // INQUIRY
  64     const String &      Value() const;
  65
  66   private:
  67     // Interface csv::ConstProcessorClient:
  68     virtual void        do_Accept(
  69                             csv::ProcessorIfc & io_processor ) const;
  70     // Interface ary::Object
  71     virtual ClassId     get_AryClass() const;
  72
  73     // Interface CodeEntity
  74     virtual const String &  inq_LocalName() const;
  75     virtual Ce_id           inq_NameRoom() const;
  76     virtual Ce_id           inq_Owner() const;
  77     virtual E_SightLevel    inq_SightLevel() const;
  78
  79     friend struct ifc_enumvalue::attr;
  80
  81     // DATA
  82     String              sName;
  83     Ce_id               nOwner;
  84     Ce_id               nNameRoom;
  85
  86     String              sValue;
  87 };
  88
  89
  90
  91
  92 // IMPLEMENTATION
  93 inline const String &
  94 EnumValue::Value() const
  95 {
  96     return sValue;
  97 }
  98
  99
 100
 101
 102 }   // namespace idl
 103 }   // namespace ary
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */