autodoc/inc/ary/idl/i_ce2s.hxx

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