autodoc/source/ary/idl/it_tplparam.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_tplparam.hxx,v $
  10  * $Revision: 1.6 $
  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_TPLPARAM_HXX
  32 #define ARY_IDL_IT_TPLPARAM_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 /** @resp Represents a template type when it is used within the
  47     declaring struct.
  48 */
  49 class TemplateParamType : public Named_Type
  50 {
  51   public:
  52     enum E_ClassId { class_id = 2205 };
  53
  54     // LIFECYCLE
  55                         TemplateParamType(
  56                             const char *        i_sName );
  57     virtual             ~TemplateParamType();
  58
  59     Ce_id               StructId() const;       /// The struct which declares this type.
  60     void                Set_StructId(
  61                             Ce_id               i_nStruct );
  62   private:
  63     // Interface csv::ConstProcessorClient:
  64     virtual void        do_Accept(
  65                             csv::ProcessorIfc & io_processor ) const;
  66     // Interface Object:
  67     virtual ClassId     get_AryClass() const;
  68
  69     // Interface Type:
  70     virtual void        inq_Get_Text(
  71                             StringVector &      o_module,
  72                             String &            o_name,
  73                             Ce_id &             o_nRelatedCe,
  74                             int &               o_nSequenceCount,
  75                             const Gate &        i_rGate ) const;
  76     // DATA
  77     Ce_id               nStruct;                /// The struct which declares this type.
  78 };
  79
  80
  81
  82
  83 // IMPLEMENTATION
  84 inline Ce_id
  85 TemplateParamType::StructId() const
  86 {
  87     return nStruct;
  88 }
  89
  90 inline void
  91 TemplateParamType::Set_StructId( Ce_id i_nStruct )
  92 {
  93     nStruct = i_nStruct;
  94 }
  95
  96
  97
  98
  99 }   // namespace idl
 100 }   // namespace ary
 101 #endif