autodoc/inc/ary/idl/i_ce.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_ce.hxx,v $
  10  * $Revision: 1.4 $
  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_CE_HXX
  32 #define ARY_IDL_I_CE_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/entity.hxx>
  36 // USED SERVICES
  37 #include <ary/doc/d_docu.hxx>
  38 #include <ary/idl/i_ce2s.hxx>
  39 #include <ary/idl/i_types4idl.hxx>
  40
  41
  42
  43
  44
  45
  46 namespace ary
  47 {
  48 namespace idl
  49 {
  50
  51
  52 /** @resp Base class for all IDL code entities.
  53
  54     A @->CodeEntity is a namespace, type, data or function, which occures in
  55     the parsed UNO IDL code and is described and/or commented within the
  56     Autodoc repository.
  57
  58     This is a storage base class, where more special classes are
  59     derived from.
  60 */
  61 class CodeEntity : public ary::Entity
  62 {
  63   public:
  64     // LIFECYCLE
  65     virtual             ~CodeEntity();
  66
  67     // OPERATION
  68
  69     // INQUIRY
  70     Ce_id               CeId() const            { return Ce_id(Id()); }
  71     const String &      LocalName() const;
  72     Ce_id               NameRoom() const;
  73     Ce_id               Owner() const;
  74     E_SightLevel        SightLevel() const;
  75
  76     const ary::doc::Documentation &
  77                         Docu() const;
  78     const Ce_2s &       Secondaries() const;
  79
  80     static const CodeEntity &
  81                         Null_();
  82     // ACCESS
  83     void                Set_Docu(
  84                             DYN ary::doc::Node &
  85                                                 pass_data );
  86     Ce_2s &             Secondaries();
  87
  88   protected:
  89                         CodeEntity();
  90   private:
  91     // Locals
  92     virtual const String &  inq_LocalName() const = 0;
  93     virtual Ce_id           inq_NameRoom() const = 0;
  94     virtual Ce_id           inq_Owner() const = 0;
  95     virtual E_SightLevel    inq_SightLevel() const = 0;
  96
  97     // DATA
  98     ary::doc::Documentation
  99                         aDocu;
 100     Dyn<Ce_2s>          p2s;
 101 };
 102
 103
 104
 105
 106 // IMPLEMENTATION
 107 inline const String &
 108 CodeEntity::LocalName() const
 109     { return inq_LocalName(); }
 110
 111 inline Ce_id
 112 CodeEntity::NameRoom() const
 113     { return inq_NameRoom(); }
 114
 115 inline Ce_id
 116 CodeEntity::Owner() const
 117     { return inq_Owner(); }
 118
 119 inline E_SightLevel
 120 CodeEntity::SightLevel() const
 121     { return inq_SightLevel(); }
 122
 123 inline const ary::doc::Documentation &
 124 CodeEntity::Docu() const
 125     { return aDocu; }
 126
 127 inline void
 128 CodeEntity::Set_Docu(DYN ary::doc::Node & pass_data)
 129 {
 130     aDocu.Set_Data(pass_data);
 131 }
 132
 133
 134
 135
 136 }   // namespace idl
 137 }   // namespace ary
 138 #endif