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