autodoc/source/display/inc/toolkit/hf_navi_main.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_HF_NAVI_MAIN_HXX
  21 #define ADC_DISPLAY_HF_NAVI_MAIN_HXX
  22
  23
  24
  25 // USED SERVICES
  26     // BASE CLASSES
  27     // COMPONENTS
  28 #include "htmlfactory.hxx"
  29     // PARAMETERS
  30
  31
  32 class HF_MainItem;
  33
  34
  35 /** @task
  36     Create a HTML navigation bar with lightly coloured background.
  37
  38     @descr
  39     There are three kinds of items:
  40     Item with link:             Add_StdItem(),
  41     Item without link:          Add_NoneItem(),
  42     Item that is current page:  Add_SelfItem().
  43 */
  44 class HF_NaviMainRow : public HtmlMaker
  45 {
  46   public:
  47     enum E_Style
  48     {
  49         eStd,
  50         eSelf,
  51         eNo
  52     };
  53                         HF_NaviMainRow(
  54                             Xml::Element &      o_out );
  55                         ~HF_NaviMainRow();
  56
  57     void                Add_StdItem(
  58                             const char *        i_sText,
  59                             const char *        i_sLink );
  60     void                Add_SelfItem(
  61                             const char *        i_sText );
  62     void                Add_NoneItem(
  63                             const char *        i_sText );
  64
  65     void                Produce_Row();
  66
  67   private:
  68     // DATA
  69     typedef std::vector< DYN HF_MainItem* > ItemList;
  70
  71     ItemList            aItems;
  72     Xml::Element *      pRow;
  73 };
  74
  75
  76
  77 // IMPLEMENTATION
  78
  79
  80
  81
  82 #endif
  83
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */