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