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