autodoc/inc/ary/idl/i_attribute.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: i_attribute.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ARY_IDL_I_ATTRIBUTE_HXX
  32 #define ARY_IDL_I_ATTRIBUTE_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/idl/i_ce.hxx>
  36
  37
  38
  39
  40 namespace ary
  41 {
  42 namespace idl
  43 {
  44 namespace ifc_attribute
  45 {
  46     struct attr;
  47 }
  48
  49
  50
  51
  52 /** @resp
  53     Represents an IDL property.
  54 */
  55 class Attribute : public CodeEntity
  56 {
  57   public:
  58     enum E_ClassId { class_id = 2014 };
  59
  60     // LIFECYCLE
  61                         Attribute(
  62                             const String &      i_sName,
  63                             Ce_id               i_nInterface,
  64                             Ce_id               i_nModule,
  65                             Type_id             i_nType,
  66                             bool                i_bReadonly,
  67                             bool                i_bBound );
  68                         ~Attribute();
  69     // OPERATIONS
  70     void                Add_GetException(
  71                             Type_id             i_nException );
  72     void                Add_SetException(
  73                             Type_id             i_nException );
  74
  75     // INQUIRY
  76     Type_id             Type() const;
  77     bool                IsReadonly() const;
  78     bool                IsBound() const;
  79
  80   private:
  81     // Interface csv::ConstProcessorClient:
  82     virtual void        do_Accept(
  83                             csv::ProcessorIfc & io_processor ) const;
  84     // Interface ary::Object
  85     virtual ClassId     get_AryClass() const;
  86
  87     // Interface CodeEntity
  88     virtual const String &  inq_LocalName() const;
  89     virtual Ce_id           inq_NameRoom() const;
  90     virtual Ce_id           inq_Owner() const;
  91     virtual E_SightLevel    inq_SightLevel() const;
  92
  93     // Local
  94     typedef std::vector< Type_id >      ExceptionList;
  95     friend struct ifc_attribute::attr;
  96
  97     // DATA
  98     String              sName;
  99     Ce_id               nOwner;
 100     Ce_id               nNameRoom;
 101
 102     Type_id             nType;
 103     ExceptionList       aGetExceptions;
 104     ExceptionList       aSetExceptions;
 105     bool                bReadonly;
 106     bool                bBound;
 107 };
 108
 109
 110
 111
 112 // IMPLEMENTATION
 113 inline void
 114 Attribute::Add_GetException( Type_id i_nException )
 115     { aGetExceptions.push_back(i_nException); }
 116
 117 inline void
 118 Attribute::Add_SetException( Type_id i_nException )
 119     { aSetExceptions.push_back(i_nException); }
 120
 121 inline Type_id
 122 Attribute::Type() const
 123     { return nType; }
 124
 125 inline bool
 126 Attribute::IsReadonly() const
 127     { return bReadonly; }
 128
 129 inline bool
 130 Attribute::IsBound() const
 131     { return bBound; }
 132
 133
 134
 135
 136 }   // namespace idl
 137 }   // namespace ary
 138 #endif