autodoc/source/display/idl/hfi_navibar.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ADC_DISPLAY_HFI_NAVIBAR_HXX
  21 #define ADC_DISPLAY_HFI_NAVIBAR_HXX
  22
  23
  24 // USED SERVICES
  25     // BASE CLASSES
  26     // COMPONENTS
  27 #include "hi_factory.hxx"
  28     // PARAMETERS
  29
  30 class HF_NaviSubRow;
  31
  32 /** @resp
  33     Creates a navigation bar for an IDL HTML documentation page.
  34 */
  35 class HF_IdlNavigationBar : public HtmlFactory_Idl
  36 {
  37   public:
  38                         HF_IdlNavigationBar(
  39                             HtmlEnvironment_Idl &
  40                                                 io_rEnv,
  41                             Xml::Element &      o_rOut );
  42     virtual             ~HF_IdlNavigationBar();
  43
  44     void                Produce_CeMainRow(
  45                             const client &      i_ce,
  46                             bool                i_bNoUsePage = false );
  47     void                Produce_CeXrefsMainRow(
  48                             const client &      i_ce );
  49     void                Produce_ModuleMainRow(
  50                             const client &      i_ce );
  51     void                Produce_IndexMainRow();
  52
  53     /** Adds the subrow to the o_rOut argument of the constructor.
  54     */
  55     DYN HF_NaviSubRow & Add_SubRow();
  56 };
  57
  58 extern const String
  59     C_sLocalManualLinks;
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */