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_NAVIBAR_HXX
25 #define ADC_DISPLAY_HFI_NAVIBAR_HXX
26 
27 
28 // USED SERVICES
29     // BASE CLASSES
30     // COMPONENTS
31 #include "hi_factory.hxx"
32     // PARAMETERS
33 
34 namespace ary
35 {
36 namespace idl
37 {
38 class CodeEntity;
39 }
40 }
41 
42 
43 class HF_NaviSubRow;
44 
45 /** @resp
46     Creates a navigation bar for an IDL HTML documentation page.
47 */
48 class HF_IdlNavigationBar : public HtmlFactory_Idl
49 {
50   public:
51                         HF_IdlNavigationBar(
52                             HtmlEnvironment_Idl &
53                                                 io_rEnv,
54                             Xml::Element &      o_rOut );
55     virtual             ~HF_IdlNavigationBar();
56 
57     void                Produce_CeMainRow(
58                             const client &      i_ce,
59                             bool                i_bNoUsePage = false );
60     void                Produce_CeXrefsMainRow(
61                             const client &      i_ce );
62     void                Produce_ModuleMainRow(
63                             const client &      i_ce );
64     void                Produce_IndexMainRow();
65 
66     /** Adds the subrow to the o_rOut argument of the constructor.
67     */
68     DYN HF_NaviSubRow & Add_SubRow();
69 
70   private:
71     const ary::idl::CodeEntity *
72                         pCe;
73 };
74 
75 extern const String
76     C_sLocalManualLinks;
77 
78 #endif
79