autodoc/inc/ary/idl/i_attribute.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ARY_IDL_I_ATTRIBUTE_HXX
  21 #define ARY_IDL_I_ATTRIBUTE_HXX
  22
  23 // BASE CLASSES
  24 #include <ary/idl/i_ce.hxx>
  25
  26
  27
  28
  29 namespace ary
  30 {
  31 namespace idl
  32 {
  33 namespace ifc_attribute
  34 {
  35     struct attr;
  36 }
  37
  38
  39
  40
  41 /** @resp
  42     Represents an IDL property.
  43 */
  44 class Attribute : public CodeEntity
  45 {
  46   public:
  47     enum E_ClassId { class_id = 2014 };
  48
  49     // LIFECYCLE
  50                         Attribute(
  51                             const String &      i_sName,
  52                             Ce_id               i_nInterface,
  53                             Ce_id               i_nModule,
  54                             Type_id             i_nType,
  55                             bool                i_bReadonly,
  56                             bool                i_bBound );
  57                         ~Attribute();
  58     // OPERATIONS
  59     void                Add_GetException(
  60                             Type_id             i_nException );
  61     void                Add_SetException(
  62                             Type_id             i_nException );
  63
  64     // INQUIRY
  65     Type_id             Type() const;
  66     bool                IsReadonly() const;
  67     bool                IsBound() const;
  68
  69   private:
  70     // Interface csv::ConstProcessorClient:
  71     virtual void        do_Accept(
  72                             csv::ProcessorIfc & io_processor ) const;
  73     // Interface ary::Object
  74     virtual ClassId     get_AryClass() const;
  75
  76     // Interface CodeEntity
  77     virtual const String &  inq_LocalName() const;
  78     virtual Ce_id           inq_NameRoom() const;
  79     virtual Ce_id           inq_Owner() const;
  80     virtual E_SightLevel    inq_SightLevel() const;
  81
  82     // Local
  83     typedef std::vector< Type_id >      ExceptionList;
  84     friend struct ifc_attribute::attr;
  85
  86     // DATA
  87     String              sName;
  88     Ce_id               nOwner;
  89     Ce_id               nNameRoom;
  90
  91     Type_id             nType;
  92     ExceptionList       aGetExceptions;
  93     ExceptionList       aSetExceptions;
  94     bool                bReadonly;
  95     bool                bBound;
  96 };
  97
  98
  99
 100
 101 // IMPLEMENTATION
 102 inline void
 103 Attribute::Add_GetException( Type_id i_nException )
 104     { aGetExceptions.push_back(i_nException); }
 105
 106 inline void
 107 Attribute::Add_SetException( Type_id i_nException )
 108     { aSetExceptions.push_back(i_nException); }
 109
 110 inline Type_id
 111 Attribute::Type() const
 112     { return nType; }
 113
 114 inline bool
 115 Attribute::IsReadonly() const
 116     { return bReadonly; }
 117
 118 inline bool
 119 Attribute::IsBound() const
 120     { return bBound; }
 121
 122
 123
 124
 125 }   // namespace idl
 126 }   // namespace ary
 127 #endif
 128
 129 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */