xref: /aoo41x/main/autodoc/inc/ary/idl/i_ce2s.hxx (revision cdf0e10c)
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_I_CE2S_HXX
29 #define ARY_IDL_I_CE2S_HXX
30 
31 
32 // USED SERVICES
33     // BASE CLASSES
34     // COMPONENTS
35     // PARAMETERS
36 #include <ary/idl/i_types4idl.hxx>
37 
38 
39 namespace ary
40 {
41 
42 namespace idl
43 {
44 
45 
46 
47 /** Abstract base for all secondary productions of code entities
48 */
49 class Ce_2s
50 {
51   public:
52     // LIFECYCLE
53     virtual             ~Ce_2s();
54 
55     static DYN Ce_2s *  Create_(
56                             ClassId             i_nCeClass );
57     // OPERATIONS
58     void                Add_Link2DescriptionInManual(
59                             const String &      i_link,
60                             const String &      i_linkUI )
61                                                 { aDescriptionsInManual.push_back(i_link); aDescriptionsInManual.push_back(i_linkUI); }
62     void                Add_Link2RefInManual(
63                             const String &      i_link,
64                             const String &      i_linkUI )
65                                                 { aRefsInManual.push_back(i_link); aRefsInManual.push_back(i_linkUI); }
66     std::vector<Ce_id> &
67                         Access_List(
68                             int                 i_indexOfList );
69     // INQUIRY
70     const StringVector &
71                         Links2DescriptionInManual() const
72                                                 { return aDescriptionsInManual; }
73     const StringVector &
74                         Links2RefsInManual() const
75                                                 { return aRefsInManual; }
76     int                 CountXrefLists() const  { return aXrefLists.size(); }
77     const std::vector<Ce_id> &
78                         List(
79                             int                 i_indexOfList ) const;
80   private:
81     typedef DYN std::vector<Ce_id> * ListPtr;
82 
83     // DATA
84     StringVector        aDescriptionsInManual;
85     StringVector        aRefsInManual;
86     std::vector<ListPtr>
87                         aXrefLists;
88 };
89 
90 
91 
92 
93 }   // namespace idl
94 }   // namespace ary
95 #endif
96