xref: /trunk/main/autodoc/inc/ary/idl/i_enum.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_ENUM_HXX
29 #define ARY_IDL_I_ENUM_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_enum
42 {
43     struct attr;
44 }
45 
46 
47 /** Represents an IDL enum.
48 */
49 class Enum : public CodeEntity
50 {
51   public:
52     enum E_ClassId { class_id = 2005 };
53     // LIFECYCLE
54                         Enum(
55                             const String &      i_sName,
56                             Ce_id               i_nOwner );
57                         ~Enum();
58     // ACCESS
59     void                Add_Value(
60                             Ce_id               i_nValue );
61   private:
62     // Interface csv::ConstProcessorClient:
63     virtual void        do_Accept(
64                             csv::ProcessorIfc & io_processor ) const;
65     // Interface ary::Object
66     virtual ClassId     get_AryClass() const;
67 
68     // Interface CodeEntity
69     virtual const String &  inq_LocalName() const;
70     virtual Ce_id           inq_NameRoom() const;
71     virtual Ce_id           inq_Owner() const;
72     virtual E_SightLevel    inq_SightLevel() const;
73 
74     // Locals
75     typedef std::vector<Ce_id>   ValueList;
76     friend struct ifc_enum::attr;
77 
78     // DATA
79     String              sName;
80     Ce_id               nOwner;
81 
82     ValueList           aValues;
83 };
84 
85 
86 
87 
88 // IMPLEMENTATION
89 inline void
90 Enum::Add_Value( Ce_id i_nValue )
91 {
92     aValues.push_back(i_nValue);
93 }
94 
95 
96 
97 
98 }   // namespace idl
99 }   // namespace ary
100 #endif
101