autodoc/inc/ary/idl/i_ce2s.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ARY_IDL_I_CE2S_HXX
  21 #define ARY_IDL_I_CE2S_HXX
  22
  23 #include <ary/idl/i_types4idl.hxx>
  24
  25 namespace ary
  26 {
  27
  28 namespace idl
  29 {
  30
  31 /** Abstract base for all secondary productions of code entities
  32 */
  33 class Ce_2s
  34 {
  35   public:
  36     // LIFECYCLE
  37     explicit            Ce_2s() {}
  38     virtual             ~Ce_2s();
  39
  40     static DYN Ce_2s *  Create_();
  41     // OPERATIONS
  42     void                Add_Link2DescriptionInManual(
  43                             const String &      i_link,
  44                             const String &      i_linkUI )
  45                                                 { aDescriptionsInManual.push_back(i_link); aDescriptionsInManual.push_back(i_linkUI); }
  46     void                Add_Link2RefInManual(
  47                             const String &      i_link,
  48                             const String &      i_linkUI )
  49                                                 { aRefsInManual.push_back(i_link); aRefsInManual.push_back(i_linkUI); }
  50     std::vector<Ce_id> &
  51                         Access_List(
  52                             int                 i_indexOfList );
  53     // INQUIRY
  54     const StringVector &
  55                         Links2DescriptionInManual() const
  56                                                 { return aDescriptionsInManual; }
  57     const StringVector &
  58                         Links2RefsInManual() const
  59                                                 { return aRefsInManual; }
  60     int                 CountXrefLists() const  { return aXrefLists.size(); }
  61     const std::vector<Ce_id> &
  62                         List(
  63                             int                 i_indexOfList ) const;
  64   private:
  65     typedef DYN std::vector<Ce_id> * ListPtr;
  66
  67     // DATA
  68     StringVector        aDescriptionsInManual;
  69     StringVector        aRefsInManual;
  70     std::vector<ListPtr>
  71                         aXrefLists;
  72 };
  73
  74 }   // namespace idl
  75 }   // namespace ary
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */