xref: /aoo41x/main/autodoc/inc/ary/idl/i_ce2s.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef ARY_IDL_I_CE2S_HXX
29*cdf0e10cSrcweir #define ARY_IDL_I_CE2S_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir // USED SERVICES
33*cdf0e10cSrcweir     // BASE CLASSES
34*cdf0e10cSrcweir     // COMPONENTS
35*cdf0e10cSrcweir     // PARAMETERS
36*cdf0e10cSrcweir #include <ary/idl/i_types4idl.hxx>
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir namespace ary
40*cdf0e10cSrcweir {
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir namespace idl
43*cdf0e10cSrcweir {
44*cdf0e10cSrcweir 
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir 
47*cdf0e10cSrcweir /** Abstract base for all secondary productions of code entities
48*cdf0e10cSrcweir */
49*cdf0e10cSrcweir class Ce_2s
50*cdf0e10cSrcweir {
51*cdf0e10cSrcweir   public:
52*cdf0e10cSrcweir     // LIFECYCLE
53*cdf0e10cSrcweir     virtual             ~Ce_2s();
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir     static DYN Ce_2s *  Create_(
56*cdf0e10cSrcweir                             ClassId             i_nCeClass );
57*cdf0e10cSrcweir     // OPERATIONS
58*cdf0e10cSrcweir     void                Add_Link2DescriptionInManual(
59*cdf0e10cSrcweir                             const String &      i_link,
60*cdf0e10cSrcweir                             const String &      i_linkUI )
61*cdf0e10cSrcweir                                                 { aDescriptionsInManual.push_back(i_link); aDescriptionsInManual.push_back(i_linkUI); }
62*cdf0e10cSrcweir     void                Add_Link2RefInManual(
63*cdf0e10cSrcweir                             const String &      i_link,
64*cdf0e10cSrcweir                             const String &      i_linkUI )
65*cdf0e10cSrcweir                                                 { aRefsInManual.push_back(i_link); aRefsInManual.push_back(i_linkUI); }
66*cdf0e10cSrcweir     std::vector<Ce_id> &
67*cdf0e10cSrcweir                         Access_List(
68*cdf0e10cSrcweir                             int                 i_indexOfList );
69*cdf0e10cSrcweir     // INQUIRY
70*cdf0e10cSrcweir     const StringVector &
71*cdf0e10cSrcweir                         Links2DescriptionInManual() const
72*cdf0e10cSrcweir                                                 { return aDescriptionsInManual; }
73*cdf0e10cSrcweir     const StringVector &
74*cdf0e10cSrcweir                         Links2RefsInManual() const
75*cdf0e10cSrcweir                                                 { return aRefsInManual; }
76*cdf0e10cSrcweir     int                 CountXrefLists() const  { return aXrefLists.size(); }
77*cdf0e10cSrcweir     const std::vector<Ce_id> &
78*cdf0e10cSrcweir                         List(
79*cdf0e10cSrcweir                             int                 i_indexOfList ) const;
80*cdf0e10cSrcweir   private:
81*cdf0e10cSrcweir     typedef DYN std::vector<Ce_id> * ListPtr;
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir     // DATA
84*cdf0e10cSrcweir     StringVector        aDescriptionsInManual;
85*cdf0e10cSrcweir     StringVector        aRefsInManual;
86*cdf0e10cSrcweir     std::vector<ListPtr>
87*cdf0e10cSrcweir                         aXrefLists;
88*cdf0e10cSrcweir };
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir }   // namespace idl
94*cdf0e10cSrcweir }   // namespace ary
95*cdf0e10cSrcweir #endif
96