autodoc/inc/ary/idl/i_constant.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_CONSTANT_HXX
  30 #define ARY_IDL_I_CONSTANT_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_constant
  43 {
  44     struct attr;
  45 }
  46
  47
  48 /** Represents an IDL constant.
  49 */
  50 class Constant : public CodeEntity
  51 {
  52   public:
  53     enum E_ClassId { class_id = 2012 };
  54
  55     // LIFECYCLE
  56                         Constant(
  57                             const String &      i_sName,
  58                             Ce_id               i_nOwner,
  59                             Ce_id               i_nNameRoom,
  60                             Type_id             i_nType,
  61                             const String &      i_sInitValue );
  62                         ~Constant();
  63     // INQUIRY
  64     Type_id             Type() const;
  65     const String &      Value() const;
  66
  67
  68   private:
  69     // Interface csv::ConstProcessorClient:
  70     virtual void        do_Accept(
  71                             csv::ProcessorIfc & io_processor ) const;
  72     // Interface ary::Object
  73     virtual ClassId     get_AryClass() const;
  74
  75     // Interface CodeEntity
  76     virtual const String &  inq_LocalName() const;
  77     virtual Ce_id           inq_NameRoom() const;
  78     virtual Ce_id           inq_Owner() const;
  79     virtual E_SightLevel    inq_SightLevel() const;
  80
  81     friend struct ifc_constant::attr;
  82
  83     // DATA
  84     String              sName;
  85     Ce_id               nNameRoom;
  86     Ce_id               nOwner;
  87
  88     Type_id             nType;
  89     String              sInitValue;
  90 };
  91
  92
  93
  94
  95 // IMPLEMENTATION
  96 inline Type_id
  97 Constant::Type() const
  98 {
  99     return nType;
 100 }
 101
 102 inline const String &
 103 Constant::Value() const
 104 {
 105     return sInitValue;
 106 }
 107
 108
 109
 110
 111 }   // namespace idl
 112 }   // namespace ary
 113 #endif
 114
 115 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */