xref: /AOO41X/main/autodoc/source/ary/idl/it_tplparam.hxx (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef ARY_IDL_IT_TPLPARAM_HXX
29 #define ARY_IDL_IT_TPLPARAM_HXX
30 
31 // BASE CLASSES
32 #include "it_named.hxx"
33 
34 
35 
36 
37 namespace ary
38 {
39 namespace idl
40 {
41 
42 
43 /** @resp Represents a template type when it is used within the
44     declaring struct.
45 */
46 class TemplateParamType : public Named_Type
47 {
48   public:
49     enum E_ClassId { class_id = 2205 };
50 
51     // LIFECYCLE
52                         TemplateParamType(
53                             const char *        i_sName );
54     virtual             ~TemplateParamType();
55 
56     Ce_id               StructId() const;       /// The struct which declares this type.
57     void                Set_StructId(
58                             Ce_id               i_nStruct );
59   private:
60     // Interface csv::ConstProcessorClient:
61     virtual void        do_Accept(
62                             csv::ProcessorIfc & io_processor ) const;
63     // Interface Object:
64     virtual ClassId     get_AryClass() const;
65 
66     // Interface Type:
67     virtual void        inq_Get_Text(
68                             StringVector &      o_module,
69                             String &            o_name,
70                             Ce_id &             o_nRelatedCe,
71                             int &               o_nSequenceCount,
72                             const Gate &        i_rGate ) const;
73     // DATA
74     Ce_id               nStruct;                /// The struct which declares this type.
75 };
76 
77 
78 
79 
80 // IMPLEMENTATION
81 inline Ce_id
82 TemplateParamType::StructId() const
83 {
84     return nStruct;
85 }
86 
87 inline void
88 TemplateParamType::Set_StructId( Ce_id i_nStruct )
89 {
90     nStruct = i_nStruct;
91 }
92 
93 
94 
95 
96 }   // namespace idl
97 }   // namespace ary
98 #endif
99