autodoc/source/display/idl/hfi_globalindex.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 ADC_DISPLAY_HFI_GLOBALINDEX_HXX
  21 #define ADC_DISPLAY_HFI_GLOBALINDEX_HXX
  22
  23
  24
  25 // USED SERVICES
  26     // BASE CLASSES
  27 #include "hi_factory.hxx"
  28     // COMPONENTS
  29     // PARAMETERS
  30 #include <ary/idl/i_gate.hxx>
  31
  32
  33 class HF_IdlTypeText;
  34
  35 class HF_IdlGlobalIndex : public HtmlFactory_Idl
  36 {
  37   public:
  38     typedef std::vector<ary::idl::Ce_id> PageData;
  39
  40                         HF_IdlGlobalIndex(
  41                             Environment &       io_rEnv,
  42                             Xml::Element &      o_rOut );
  43     virtual             ~HF_IdlGlobalIndex();
  44
  45     void                Produce_Page(
  46                             ary::idl::alphabetical_index::E_Letter
  47                                                 i_letter ) const;
  48   private:
  49     void                make_Navibar() const;   /// Called by @->Produce_Page()
  50     void                produce_Line(           /// Called by @->Produce_Page()
  51                             PageData::const_iterator
  52                                                 i_entry,
  53                             const HF_IdlTypeText &
  54                                                 i_typeLinkWriter ) const;
  55
  56     void                write_EntryItself(      /// Called by @->produceLine()
  57                             Xml::Element &      o_destination,
  58                             const ary::idl::CodeEntity &
  59                                                 i_entry,
  60                             const HF_IdlTypeText &
  61                                                 i_typeLinkWriter ) const;
  62
  63     void                write_OwnerOfEntry(     /// Called by @->produceLine()
  64                             Xml::Element &      o_destination,
  65                             const ary::idl::CodeEntity &
  66                                                 i_entry,
  67                             const HF_IdlTypeText &
  68                                                 i_typeLinkWriter ) const;
  69
  70     void                write_EntrySecondTime(  /// Called by @->produceLine()
  71                             Xml::Element &      o_destination,
  72                             const ary::idl::CodeEntity &
  73                                                 i_entry,
  74                             const HF_IdlTypeText &
  75                                                 i_typeLinkWriter ) const;
  76 };
  77
  78
  79
  80 #endif
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */