xref: /trunk/main/autodoc/inc/ary/idl/i_enumvalue.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_ENUMVALUE_HXX
29 #define ARY_IDL_I_ENUMVALUE_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_enumvalue
42 {
43     struct attr;
44 }
45 
46 
47 /** @resp
48     Represents an IDL enum value.
49 */
50 class EnumValue : public CodeEntity
51 {
52   public:
53     enum E_ClassId { class_id = 2006 };
54 
55     // LIFECYCLE
56                         EnumValue(
57                             const String &      i_sName,
58                             Ce_id               i_nOwner,
59                             Ce_id               i_nNameRoom,
60                             const String &      i_sInitValue );
61                         ~EnumValue();
62     // INQUIRY
63     const String &      Value() const;
64 
65   private:
66     // Interface csv::ConstProcessorClient:
67     virtual void        do_Accept(
68                             csv::ProcessorIfc & io_processor ) const;
69     // Interface ary::Object
70     virtual ClassId     get_AryClass() const;
71 
72     // Interface CodeEntity
73     virtual const String &  inq_LocalName() const;
74     virtual Ce_id           inq_NameRoom() const;
75     virtual Ce_id           inq_Owner() const;
76     virtual E_SightLevel    inq_SightLevel() const;
77 
78     friend struct ifc_enumvalue::attr;
79 
80     // DATA
81     String              sName;
82     Ce_id               nOwner;
83     Ce_id               nNameRoom;
84 
85     String              sValue;
86 };
87 
88 
89 
90 
91 // IMPLEMENTATION
92 inline const String &
93 EnumValue::Value() const
94 {
95     return sValue;
96 }
97 
98 
99 
100 
101 }   // namespace idl
102 }   // namespace ary
103 #endif
104