autodoc/inc/ary/idl/i_attribute.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ARY_IDL_I_ATTRIBUTE_HXX
  30 #define ARY_IDL_I_ATTRIBUTE_HXX
  31
  32 // BASE CLASSES
  33 #include <ary/idl/i_ce.hxx>
  34
  35
  36
  37
  38 namespace ary
  39 {
  40 namespace idl
  41 {
  42 namespace ifc_attribute
  43 {
  44     struct attr;
  45 }
  46
  47
  48
  49
  50 /** @resp
  51     Represents an IDL property.
  52 */
  53 class Attribute : public CodeEntity
  54 {
  55   public:
  56     enum E_ClassId { class_id = 2014 };
  57
  58     // LIFECYCLE
  59                         Attribute(
  60                             const String &      i_sName,
  61                             Ce_id               i_nInterface,
  62                             Ce_id               i_nModule,
  63                             Type_id             i_nType,
  64                             bool                i_bReadonly,
  65                             bool                i_bBound );
  66                         ~Attribute();
  67     // OPERATIONS
  68     void                Add_GetException(
  69                             Type_id             i_nException );
  70     void                Add_SetException(
  71                             Type_id             i_nException );
  72
  73     // INQUIRY
  74     Type_id             Type() const;
  75     bool                IsReadonly() const;
  76     bool                IsBound() const;
  77
  78   private:
  79     // Interface csv::ConstProcessorClient:
  80     virtual void        do_Accept(
  81                             csv::ProcessorIfc & io_processor ) const;
  82     // Interface ary::Object
  83     virtual ClassId     get_AryClass() const;
  84
  85     // Interface CodeEntity
  86     virtual const String &  inq_LocalName() const;
  87     virtual Ce_id           inq_NameRoom() const;
  88     virtual Ce_id           inq_Owner() const;
  89     virtual E_SightLevel    inq_SightLevel() const;
  90
  91     // Local
  92     typedef std::vector< Type_id >      ExceptionList;
  93     friend struct ifc_attribute::attr;
  94
  95     // DATA
  96     String              sName;
  97     Ce_id               nOwner;
  98     Ce_id               nNameRoom;
  99
 100     Type_id             nType;
 101     ExceptionList       aGetExceptions;
 102     ExceptionList       aSetExceptions;
 103     bool                bReadonly;
 104     bool                bBound;
 105 };
 106
 107
 108
 109
 110 // IMPLEMENTATION
 111 inline void
 112 Attribute::Add_GetException( Type_id i_nException )
 113     { aGetExceptions.push_back(i_nException); }
 114
 115 inline void
 116 Attribute::Add_SetException( Type_id i_nException )
 117     { aSetExceptions.push_back(i_nException); }
 118
 119 inline Type_id
 120 Attribute::Type() const
 121     { return nType; }
 122
 123 inline bool
 124 Attribute::IsReadonly() const
 125     { return bReadonly; }
 126
 127 inline bool
 128 Attribute::IsBound() const
 129     { return bBound; }
 130
 131
 132
 133
 134 }   // namespace idl
 135 }   // namespace ary
 136 #endif
 137
 138 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */