xref: /AOO41X/main/autodoc/source/display/idl/hfi_globalindex.hxx (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef ADC_DISPLAY_HFI_GLOBALINDEX_HXX
29 #define ADC_DISPLAY_HFI_GLOBALINDEX_HXX
30 
31 
32 
33 // USED SERVICES
34     // BASE CLASSES
35 #include "hi_factory.hxx"
36     // COMPONENTS
37     // PARAMETERS
38 #include <ary/idl/i_gate.hxx>
39 
40 
41 class HF_IdlTypeText;
42 
43 class HF_IdlGlobalIndex : public HtmlFactory_Idl
44 {
45   public:
46     typedef std::vector<ary::idl::Ce_id> PageData;
47 
48                         HF_IdlGlobalIndex(
49                             Environment &       io_rEnv,
50                             Xml::Element &      o_rOut );
51     virtual             ~HF_IdlGlobalIndex();
52 
53     void                Produce_Page(
54                             ary::idl::alphabetical_index::E_Letter
55                                                 i_letter ) const;
56   private:
57     void                make_Navibar() const;   /// Called by @->Produce_Page()
58     void                produce_Line(           /// Called by @->Produce_Page()
59                             PageData::const_iterator
60                                                 i_entry,
61                             const HF_IdlTypeText &
62                                                 i_typeLinkWriter ) const;
63 
64     void                write_EntryItself(      /// Called by @->produceLine()
65                             Xml::Element &      o_destination,
66                             const ary::idl::CodeEntity &
67                                                 i_entry,
68                             const HF_IdlTypeText &
69                                                 i_typeLinkWriter ) const;
70 
71     void                write_OwnerOfEntry(     /// Called by @->produceLine()
72                             Xml::Element &      o_destination,
73                             const ary::idl::CodeEntity &
74                                                 i_entry,
75                             const HF_IdlTypeText &
76                                                 i_typeLinkWriter ) const;
77 
78     void                write_EntrySecondTime(  /// Called by @->produceLine()
79                             Xml::Element &      o_destination,
80                             const ary::idl::CodeEntity &
81                                                 i_entry,
82                             const HF_IdlTypeText &
83                                                 i_typeLinkWriter ) const;
84 };
85 
86 
87 
88 #endif
89 
90