autodoc/source/display/idl/hfi_navibar.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: hfi_navibar.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ADC_DISPLAY_HFI_NAVIBAR_HXX
  32 #define ADC_DISPLAY_HFI_NAVIBAR_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37     // COMPONENTS
  38 #include "hi_factory.hxx"
  39     // PARAMETERS
  40
  41 namespace ary
  42 {
  43 namespace idl
  44 {
  45 class CodeEntity;
  46 }
  47 }
  48
  49
  50 class HF_NaviSubRow;
  51
  52 /** @resp
  53     Creates a navigation bar for an IDL HTML documentation page.
  54 */
  55 class HF_IdlNavigationBar : public HtmlFactory_Idl
  56 {
  57   public:
  58                         HF_IdlNavigationBar(
  59                             HtmlEnvironment_Idl &
  60                                                 io_rEnv,
  61                             Xml::Element &      o_rOut );
  62     virtual             ~HF_IdlNavigationBar();
  63
  64     void                Produce_CeMainRow(
  65                             const client &      i_ce,
  66                             bool                i_bNoUsePage = false );
  67     void                Produce_CeXrefsMainRow(
  68                             const client &      i_ce );
  69     void                Produce_ModuleMainRow(
  70                             const client &      i_ce );
  71     void                Produce_IndexMainRow();
  72
  73     /** Adds the subrow to the o_rOut argument of the constructor.
  74     */
  75     DYN HF_NaviSubRow & Add_SubRow();
  76
  77   private:
  78     const ary::idl::CodeEntity *
  79                         pCe;
  80 };
  81
  82 extern const String
  83     C_sLocalManualLinks;
  84
  85 #endif