xref: /aoo41x/main/autodoc/inc/ary/idl/i_ce2s.hxx (revision 1c78a5d6)
1*1c78a5d6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*1c78a5d6SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*1c78a5d6SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*1c78a5d6SAndrew Rist  * distributed with this work for additional information
6*1c78a5d6SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*1c78a5d6SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*1c78a5d6SAndrew Rist  * "License"); you may not use this file except in compliance
9*1c78a5d6SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*1c78a5d6SAndrew Rist  *
11*1c78a5d6SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*1c78a5d6SAndrew Rist  *
13*1c78a5d6SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*1c78a5d6SAndrew Rist  * software distributed under the License is distributed on an
15*1c78a5d6SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*1c78a5d6SAndrew Rist  * KIND, either express or implied.  See the License for the
17*1c78a5d6SAndrew Rist  * specific language governing permissions and limitations
18*1c78a5d6SAndrew Rist  * under the License.
19*1c78a5d6SAndrew Rist  *
20*1c78a5d6SAndrew Rist  *************************************************************/
21*1c78a5d6SAndrew Rist 
22*1c78a5d6SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef ARY_IDL_I_CE2S_HXX
25cdf0e10cSrcweir #define ARY_IDL_I_CE2S_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir 
28cdf0e10cSrcweir // USED SERVICES
29cdf0e10cSrcweir     // BASE CLASSES
30cdf0e10cSrcweir     // COMPONENTS
31cdf0e10cSrcweir     // PARAMETERS
32cdf0e10cSrcweir #include <ary/idl/i_types4idl.hxx>
33cdf0e10cSrcweir 
34cdf0e10cSrcweir 
35cdf0e10cSrcweir namespace ary
36cdf0e10cSrcweir {
37cdf0e10cSrcweir 
38cdf0e10cSrcweir namespace idl
39cdf0e10cSrcweir {
40cdf0e10cSrcweir 
41cdf0e10cSrcweir 
42cdf0e10cSrcweir 
43cdf0e10cSrcweir /** Abstract base for all secondary productions of code entities
44cdf0e10cSrcweir */
45cdf0e10cSrcweir class Ce_2s
46cdf0e10cSrcweir {
47cdf0e10cSrcweir   public:
48cdf0e10cSrcweir     // LIFECYCLE
Ce_2s()497925e912SMichael Stahl     explicit Ce_2s () { }
50cdf0e10cSrcweir     virtual             ~Ce_2s();
51cdf0e10cSrcweir 
52cdf0e10cSrcweir     static DYN Ce_2s *  Create_(
53cdf0e10cSrcweir                             ClassId             i_nCeClass );
54cdf0e10cSrcweir     // OPERATIONS
Add_Link2DescriptionInManual(const String & i_link,const String & i_linkUI)55cdf0e10cSrcweir     void                Add_Link2DescriptionInManual(
56cdf0e10cSrcweir                             const String &      i_link,
57cdf0e10cSrcweir                             const String &      i_linkUI )
58cdf0e10cSrcweir                                                 { aDescriptionsInManual.push_back(i_link); aDescriptionsInManual.push_back(i_linkUI); }
Add_Link2RefInManual(const String & i_link,const String & i_linkUI)59cdf0e10cSrcweir     void                Add_Link2RefInManual(
60cdf0e10cSrcweir                             const String &      i_link,
61cdf0e10cSrcweir                             const String &      i_linkUI )
62cdf0e10cSrcweir                                                 { aRefsInManual.push_back(i_link); aRefsInManual.push_back(i_linkUI); }
63cdf0e10cSrcweir     std::vector<Ce_id> &
64cdf0e10cSrcweir                         Access_List(
65cdf0e10cSrcweir                             int                 i_indexOfList );
66cdf0e10cSrcweir     // INQUIRY
67cdf0e10cSrcweir     const StringVector &
Links2DescriptionInManual() const68cdf0e10cSrcweir                         Links2DescriptionInManual() const
69cdf0e10cSrcweir                                                 { return aDescriptionsInManual; }
70cdf0e10cSrcweir     const StringVector &
Links2RefsInManual() const71cdf0e10cSrcweir                         Links2RefsInManual() const
72cdf0e10cSrcweir                                                 { return aRefsInManual; }
CountXrefLists() const73cdf0e10cSrcweir     int                 CountXrefLists() const  { return aXrefLists.size(); }
74cdf0e10cSrcweir     const std::vector<Ce_id> &
75cdf0e10cSrcweir                         List(
76cdf0e10cSrcweir                             int                 i_indexOfList ) const;
77cdf0e10cSrcweir   private:
78cdf0e10cSrcweir     typedef DYN std::vector<Ce_id> * ListPtr;
79cdf0e10cSrcweir 
80cdf0e10cSrcweir     // DATA
81cdf0e10cSrcweir     StringVector        aDescriptionsInManual;
82cdf0e10cSrcweir     StringVector        aRefsInManual;
83cdf0e10cSrcweir     std::vector<ListPtr>
84cdf0e10cSrcweir                         aXrefLists;
85cdf0e10cSrcweir };
86cdf0e10cSrcweir 
87cdf0e10cSrcweir 
88cdf0e10cSrcweir 
89cdf0e10cSrcweir 
90cdf0e10cSrcweir }   // namespace idl
91cdf0e10cSrcweir }   // namespace ary
92cdf0e10cSrcweir #endif
93