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