autodoc/source/ary/idl/it_explicit.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: it_explicit.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_IT_EXPLICIT_HXX
  32 #define ARY_IDL_IT_EXPLICIT_HXX
  33
  34 // BASE CLASSES
  35 #include "it_named.hxx"
  36
  37
  38
  39
  40 namespace ary
  41 {
  42 namespace idl
  43 {
  44
  45
  46 /** A named @->Type, not yet related to its corresponding
  47     @->CodeEntity.
  48 */
  49 class ExplicitType : public Named_Type
  50 {
  51   public:
  52     enum E_ClassId { class_id = 2203 };
  53
  54     // LIFECYCLE
  55                         ExplicitType(
  56                             const String &      i_sName,
  57                             Type_id             i_nXNameRoom,
  58                             Ce_id               i_nModuleOfOccurrence,
  59                             const std::vector<Type_id> *
  60                                                 i_templateParameters );
  61     virtual             ~ExplicitType();
  62
  63     // INQUIRY
  64     Ce_id               ModuleOfOccurrence() const
  65                                                 { return nModuleOfOccurrence; }
  66     Type_id             NameRoom() const        { return nXNameRoom; }
  67
  68   private:
  69     // Interface csv::ConstProcessorClient:
  70     virtual void        do_Accept(
  71                             csv::ProcessorIfc & io_processor ) const;
  72     // Interface CppEntity:
  73     virtual ClassId     get_AryClass() const;
  74
  75     // Interface Type:
  76     virtual void        inq_Get_Text(
  77                             StringVector &      o_module,
  78                             String &            o_name,
  79                             Ce_id &             o_nRelatedCe,
  80                             int &               o_nSequemceCount,
  81                             const Gate &        i_rGate ) const;
  82     virtual const std::vector<Type_id> *
  83                         inq_TemplateParameters() const;
  84     // DATA
  85     Type_id             nXNameRoom;             // As written in code.
  86     Ce_id               nModuleOfOccurrence;
  87     Dyn< const std::vector<Type_id> >
  88                         pTemplateParameters;
  89 };
  90
  91
  92
  93
  94 }   // namespace idl
  95 }   // namespace ary
  96 #endif