autodoc/source/display/idl/hfi_navibar.hxx

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