xref: /aoo42x/main/autodoc/inc/ary/idl/i_property.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef ARY_IDL_I_PROPERTY_HXX
29*cdf0e10cSrcweir #define ARY_IDL_I_PROPERTY_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir // BASE CLASSES
32*cdf0e10cSrcweir #include <ary/idl/i_ce.hxx>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir namespace ary
38*cdf0e10cSrcweir {
39*cdf0e10cSrcweir namespace idl
40*cdf0e10cSrcweir {
41*cdf0e10cSrcweir namespace ifc_property
42*cdf0e10cSrcweir {
43*cdf0e10cSrcweir     struct attr;
44*cdf0e10cSrcweir }
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir 
47*cdf0e10cSrcweir /** Represents an IDL property.
48*cdf0e10cSrcweir */
49*cdf0e10cSrcweir class Property : public CodeEntity
50*cdf0e10cSrcweir {
51*cdf0e10cSrcweir   public:
52*cdf0e10cSrcweir     enum E_ClassId { class_id = 2004 };
53*cdf0e10cSrcweir 
54*cdf0e10cSrcweir     class Stereotypes
55*cdf0e10cSrcweir     {
56*cdf0e10cSrcweir       public:
57*cdf0e10cSrcweir         enum E_Flags
58*cdf0e10cSrcweir         {
59*cdf0e10cSrcweir             readonly = 1,
60*cdf0e10cSrcweir             bound = 2,
61*cdf0e10cSrcweir             constrained = 4,
62*cdf0e10cSrcweir             maybeambiguous = 8,
63*cdf0e10cSrcweir             maybedefault = 16,
64*cdf0e10cSrcweir             maybevoid = 32,
65*cdf0e10cSrcweir             removable = 64,
66*cdf0e10cSrcweir             transient = 128,
67*cdf0e10cSrcweir             s_MAX
68*cdf0e10cSrcweir         };
69*cdf0e10cSrcweir                             Stereotypes()       : nFlags(0) {}
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir         bool                HasAny() const      { return nFlags != 0; }
72*cdf0e10cSrcweir         bool                IsReadOnly() const  { return (nFlags & UINT32(readonly)) != 0; }
73*cdf0e10cSrcweir         bool                IsBound() const     { return (nFlags & UINT32(bound)) != 0; }
74*cdf0e10cSrcweir         bool                IsConstrained() const
75*cdf0e10cSrcweir                                                 { return (nFlags & UINT32(constrained)) != 0; }
76*cdf0e10cSrcweir         bool                IsMayBeAmbiguous() const
77*cdf0e10cSrcweir                                                 { return (nFlags & UINT32(maybeambiguous)) != 0; }
78*cdf0e10cSrcweir         bool                IsMayBeDefault() const
79*cdf0e10cSrcweir                                                 { return (nFlags & UINT32(maybedefault)) != 0; }
80*cdf0e10cSrcweir         bool                IsMayBeVoid() const { return (nFlags & UINT32(maybevoid)) != 0; }
81*cdf0e10cSrcweir         bool                IsRemovable() const { return (nFlags & UINT32(removable)) != 0; }
82*cdf0e10cSrcweir         bool                IsTransient() const { return (nFlags & UINT32(transient)) != 0; }
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir         void                Set_Flag(
85*cdf0e10cSrcweir                                 E_Flags         i_flag )
86*cdf0e10cSrcweir                                                 { nFlags |= UINT32(i_flag); }
87*cdf0e10cSrcweir       private:
88*cdf0e10cSrcweir         // DATA
89*cdf0e10cSrcweir         UINT32              nFlags;
90*cdf0e10cSrcweir     };
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir     // LIFECYCLE
94*cdf0e10cSrcweir                         Property(
95*cdf0e10cSrcweir                             const String &      i_sName,
96*cdf0e10cSrcweir                             Ce_id               i_nService,
97*cdf0e10cSrcweir                             Ce_id               i_nModule,
98*cdf0e10cSrcweir                             Type_id             i_nType,
99*cdf0e10cSrcweir                             Stereotypes         i_stereotypes );
100*cdf0e10cSrcweir                         ~Property();
101*cdf0e10cSrcweir     // INQUIRY
102*cdf0e10cSrcweir     Type_id             Type() const;
103*cdf0e10cSrcweir 
104*cdf0e10cSrcweir   private:
105*cdf0e10cSrcweir     // Interface csv::ConstProcessorClient:
106*cdf0e10cSrcweir     virtual void        do_Accept(
107*cdf0e10cSrcweir                             csv::ProcessorIfc & io_processor ) const;
108*cdf0e10cSrcweir     // Interface ary::Object:
109*cdf0e10cSrcweir     virtual ClassId     get_AryClass() const;
110*cdf0e10cSrcweir 
111*cdf0e10cSrcweir     // Interface CodeEntity
112*cdf0e10cSrcweir     virtual const String &  inq_LocalName() const;
113*cdf0e10cSrcweir     virtual Ce_id           inq_NameRoom() const;
114*cdf0e10cSrcweir     virtual Ce_id           inq_Owner() const;
115*cdf0e10cSrcweir     virtual E_SightLevel    inq_SightLevel() const;
116*cdf0e10cSrcweir 
117*cdf0e10cSrcweir     friend struct ifc_property::attr;
118*cdf0e10cSrcweir 
119*cdf0e10cSrcweir     // DATA
120*cdf0e10cSrcweir     String              sName;
121*cdf0e10cSrcweir     Ce_id               nOwner;
122*cdf0e10cSrcweir     Ce_id               nNameRoom;
123*cdf0e10cSrcweir 
124*cdf0e10cSrcweir     Type_id             nType;
125*cdf0e10cSrcweir     Stereotypes         aStereotypes;
126*cdf0e10cSrcweir };
127*cdf0e10cSrcweir 
128*cdf0e10cSrcweir 
129*cdf0e10cSrcweir 
130*cdf0e10cSrcweir 
131*cdf0e10cSrcweir // IMPLEMENTATION
132*cdf0e10cSrcweir inline Type_id
133*cdf0e10cSrcweir Property::Type() const
134*cdf0e10cSrcweir {
135*cdf0e10cSrcweir     return nType;
136*cdf0e10cSrcweir }
137*cdf0e10cSrcweir 
138*cdf0e10cSrcweir 
139*cdf0e10cSrcweir 
140*cdf0e10cSrcweir 
141*cdf0e10cSrcweir }   // namespace idl
142*cdf0e10cSrcweir }   // namespace ary
143*cdf0e10cSrcweir #endif
144