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