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