1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef ADC_DISPLAY_HFI_GLOBALINDEX_HXX
25 #define ADC_DISPLAY_HFI_GLOBALINDEX_HXX
26 
27 
28 
29 // USED SERVICES
30     // BASE CLASSES
31 #include "hi_factory.hxx"
32     // COMPONENTS
33     // PARAMETERS
34 #include <ary/idl/i_gate.hxx>
35 
36 
37 class HF_IdlTypeText;
38 
39 class HF_IdlGlobalIndex : public HtmlFactory_Idl
40 {
41   public:
42     typedef std::vector<ary::idl::Ce_id> PageData;
43 
44                         HF_IdlGlobalIndex(
45                             Environment &       io_rEnv,
46                             Xml::Element &      o_rOut );
47     virtual             ~HF_IdlGlobalIndex();
48 
49     void                Produce_Page(
50                             ary::idl::alphabetical_index::E_Letter
51                                                 i_letter ) const;
52   private:
53     void                make_Navibar() const;   /// Called by @->Produce_Page()
54     void                produce_Line(           /// Called by @->Produce_Page()
55                             PageData::const_iterator
56                                                 i_entry,
57                             const HF_IdlTypeText &
58                                                 i_typeLinkWriter ) const;
59 
60     void                write_EntryItself(      /// Called by @->produceLine()
61                             Xml::Element &      o_destination,
62                             const ary::idl::CodeEntity &
63                                                 i_entry,
64                             const HF_IdlTypeText &
65                                                 i_typeLinkWriter ) const;
66 
67     void                write_OwnerOfEntry(     /// Called by @->produceLine()
68                             Xml::Element &      o_destination,
69                             const ary::idl::CodeEntity &
70                                                 i_entry,
71                             const HF_IdlTypeText &
72                                                 i_typeLinkWriter ) const;
73 
74     void                write_EntrySecondTime(  /// Called by @->produceLine()
75                             Xml::Element &      o_destination,
76                             const ary::idl::CodeEntity &
77                                                 i_entry,
78                             const HF_IdlTypeText &
79                                                 i_typeLinkWriter ) const;
80 };
81 
82 
83 
84 #endif
85 
86