1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef ADC_DISPLAY_HTML_NAVIBAR_HXX 29*cdf0e10cSrcweir #define ADC_DISPLAY_HTML_NAVIBAR_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir // BASE CLASSES 32*cdf0e10cSrcweir #include "hdimpl.hxx" 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir namespace ary 35*cdf0e10cSrcweir { 36*cdf0e10cSrcweir namespace cpp 37*cdf0e10cSrcweir { 38*cdf0e10cSrcweir class CodeEntity; 39*cdf0e10cSrcweir } 40*cdf0e10cSrcweir namespace loc 41*cdf0e10cSrcweir { 42*cdf0e10cSrcweir class File; 43*cdf0e10cSrcweir } 44*cdf0e10cSrcweir } 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir 49*cdf0e10cSrcweir /** Creates a HTML navigation bar wth the following parts: 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir A main bar with fixed items. 52*cdf0e10cSrcweir Zero to several subbars with user defined items, depending of 53*cdf0e10cSrcweir the contents of the page. 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir The main bar contains those items: 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir Overview | Namespace | Class | Tree | Project | File | Index | Help 58*cdf0e10cSrcweir */ 59*cdf0e10cSrcweir class NavigationBar 60*cdf0e10cSrcweir { 61*cdf0e10cSrcweir public: 62*cdf0e10cSrcweir enum E_GlobalLocation 63*cdf0e10cSrcweir { 64*cdf0e10cSrcweir LOC_Overview, 65*cdf0e10cSrcweir LOC_AllDefs, 66*cdf0e10cSrcweir LOC_Index, 67*cdf0e10cSrcweir LOC_Help 68*cdf0e10cSrcweir }; 69*cdf0e10cSrcweir enum E_CeGatheringType 70*cdf0e10cSrcweir { 71*cdf0e10cSrcweir CEGT_operations, 72*cdf0e10cSrcweir CEGT_data 73*cdf0e10cSrcweir }; 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir /// Used for Overview, Index and Help. 76*cdf0e10cSrcweir NavigationBar( 77*cdf0e10cSrcweir const OuputPage_Environment & 78*cdf0e10cSrcweir i_rEnv, 79*cdf0e10cSrcweir E_GlobalLocation i_eLocation ); 80*cdf0e10cSrcweir /// Used for all Ces except operations and data. 81*cdf0e10cSrcweir NavigationBar( 82*cdf0e10cSrcweir const OuputPage_Environment & 83*cdf0e10cSrcweir i_rEnv, 84*cdf0e10cSrcweir const ary::cpp::CodeEntity & 85*cdf0e10cSrcweir i_rCe ); 86*cdf0e10cSrcweir /** Used for operations and data. 87*cdf0e10cSrcweir */ 88*cdf0e10cSrcweir NavigationBar( 89*cdf0e10cSrcweir const OuputPage_Environment & 90*cdf0e10cSrcweir i_rEnv, 91*cdf0e10cSrcweir E_CeGatheringType i_eCeGatheringType ); 92*cdf0e10cSrcweir ~NavigationBar(); 93*cdf0e10cSrcweir 94*cdf0e10cSrcweir void MakeSubRow( 95*cdf0e10cSrcweir const char * i_sTitle ); 96*cdf0e10cSrcweir void AddItem( /// Items are added to last made sub-row. 97*cdf0e10cSrcweir const char * i_sName, 98*cdf0e10cSrcweir const char * i_sLink, 99*cdf0e10cSrcweir bool i_bValid ); 100*cdf0e10cSrcweir /** This writes the main bar and the pSubRowTable to o_rOut. 101*cdf0e10cSrcweir The pSubRowsTable stays in memory and can be filled later, 102*cdf0e10cSrcweir when all SubRow items are known. 103*cdf0e10cSrcweir */ 104*cdf0e10cSrcweir void Write( 105*cdf0e10cSrcweir csi::xml::Element & o_rOut, 106*cdf0e10cSrcweir bool i_bWithSubRows = false ) const; 107*cdf0e10cSrcweir void Write_SubRows() const; 108*cdf0e10cSrcweir 109*cdf0e10cSrcweir private: 110*cdf0e10cSrcweir struct CheshireCat; 111*cdf0e10cSrcweir Dyn<CheshireCat> pi; 112*cdf0e10cSrcweir csi::html::Table * pSubRowsTable; 113*cdf0e10cSrcweir }; 114*cdf0e10cSrcweir 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir #endif 119