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