autodoc/inc/ary/idl/i_constgroup.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_constgroup.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_CONSTGROUP_HXX
  32 #define ARY_IDL_I_CONSTGROUP_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_constgroup
  45 {
  46     struct attr;
  47 }
  48
  49
  50 /** Represents an IDL constants group.
  51 */
  52 class ConstantsGroup : public CodeEntity
  53 {
  54   public:
  55     enum E_ClassId { class_id = 2011 };
  56
  57     // LIFECYCLE
  58                         ConstantsGroup(
  59                             const String &      i_sName,
  60                             Ce_id               i_nModule );
  61                         ~ConstantsGroup();
  62     // ACCESS
  63     void                Add_Constant(
  64                             Ce_id               i_nConstant );
  65   private:
  66     // Interface csv::ConstProcessorClient:
  67     virtual void        do_Accept(
  68                             csv::ProcessorIfc & io_processor ) const;
  69     // Interface ary::Object
  70     virtual ClassId     get_AryClass() const;
  71
  72     // Interface CodeEntity
  73     virtual const String &  inq_LocalName() const;
  74     virtual Ce_id           inq_NameRoom() const;
  75     virtual Ce_id           inq_Owner() const;
  76     virtual E_SightLevel    inq_SightLevel() const;
  77
  78     // Locals
  79     typedef std::vector<Ce_id>    ConstantList;
  80     friend struct ifc_constgroup::attr;
  81
  82     // DATA
  83     String              sName;
  84     Ce_id               nModule;
  85
  86     ConstantList        aConstants;
  87 };
  88
  89
  90
  91
  92 // IMPLEMENTATION
  93 inline void
  94 ConstantsGroup::Add_Constant( Ce_id i_nConstant )
  95 {
  96     aConstants.push_back(i_nConstant);
  97 }
  98
  99
 100
 101
 102 }   // namespace idl
 103 }   // namespace ary
 104 #endif