Update ooo320-m1
[ooovba.git] / autodoc / inc / ary / idl / i_enum.hxx
blob67bba76be30821208b9755a5cc59c9a77f6c2767
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: i_enum.hxx,v $
10 * $Revision: 1.4 $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
31 #ifndef ARY_IDL_I_ENUM_HXX
32 #define ARY_IDL_I_ENUM_HXX
34 // BASE CLASSES
35 #include <ary/idl/i_ce.hxx>
40 namespace ary
42 namespace idl
44 namespace ifc_enum
46 struct attr;
50 /** Represents an IDL enum.
52 class Enum : public CodeEntity
54 public:
55 enum E_ClassId { class_id = 2005 };
56 // LIFECYCLE
57 Enum(
58 const String & i_sName,
59 Ce_id i_nOwner );
60 ~Enum();
61 // ACCESS
62 void Add_Value(
63 Ce_id i_nValue );
64 private:
65 // Interface csv::ConstProcessorClient:
66 virtual void do_Accept(
67 csv::ProcessorIfc & io_processor ) const;
68 // Interface ary::Object
69 virtual ClassId get_AryClass() const;
71 // Interface CodeEntity
72 virtual const String & inq_LocalName() const;
73 virtual Ce_id inq_NameRoom() const;
74 virtual Ce_id inq_Owner() const;
75 virtual E_SightLevel inq_SightLevel() const;
77 // Locals
78 typedef std::vector<Ce_id> ValueList;
79 friend struct ifc_enum::attr;
81 // DATA
82 String sName;
83 Ce_id nOwner;
85 ValueList aValues;
91 // IMPLEMENTATION
92 inline void
93 Enum::Add_Value( Ce_id i_nValue )
95 aValues.push_back(i_nValue);
101 } // namespace idl
102 } // namespace ary
103 #endif