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