autodoc/source/display/inc/toolkit/hf_title.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_title.hxx,v $
  10  * $Revision: 1.5 $
  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_TITLE_HXX
  32 #define ADC_DISPLAY_HF_TITLE_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <toolkit/htmlfactory.hxx>
  39     // COMPONENTS
  40     // PARAMETERS
  41
  42
  43 class HF_TitleTable : public HtmlMaker
  44 {
  45   public:
  46                         HF_TitleTable(
  47                             Xml::Element &      o_rOut );
  48     virtual             ~HF_TitleTable();
  49
  50     void                Produce_Title(
  51                             const char *        i_title );
  52     void                Produce_Title(
  53                             const char *        i_annotations,
  54 //                            const char *        i_label,
  55                             const char *        i_title );
  56
  57     /// @return a Html::TableCell reference.
  58     Xml::Element &      Add_Row();
  59 };
  60
  61
  62 class HF_SubTitleTable : public HtmlMaker
  63 {
  64   public:
  65     enum E_SubLevel
  66     {
  67         sublevel_1,     /// Big title.
  68         sublevel_2,     /// Small title.
  69         sublevel_3      /// No title.
  70     };
  71
  72     /** @param i_nColumns [1 .. n]
  73         @param i_nSubTitleLevel [1 .. 2]
  74         1 is a bit bigger than 2.
  75     */
  76
  77                         HF_SubTitleTable(
  78                             Xml::Element &      o_rOut,
  79                             const String &      i_label,
  80                             const String &      i_title,
  81                             int                 i_nColumns,
  82                             E_SubLevel          i_eSubTitleLevel = sublevel_1 );
  83     virtual             ~HF_SubTitleTable();
  84
  85     /// @return an Html::TableRow reference.
  86     Xml::Element &      Add_Row();
  87 };
  88
  89
  90 // IMPLEMENTATION
  91
  92
  93
  94 #endif