autodoc/source/display/inc/toolkit/htmlfactory.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: htmlfactory.hxx,v $
  10  * $Revision: 1.4 $
  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_HTMLFACTORY_HXX
  32 #define ADC_DISPLAY_HTMLFACTORY_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38     // COMPONENTS
  39 #include "outputstack.hxx"
  40     // PARAMETERS
  41 #include <udm/xml/xmlitem.hxx>
  42 #include <udm/html/htmlitem.hxx>
  43
  44 namespace Xml = ::csi::xml;
  45 namespace Html = ::csi::html;
  46
  47 /** @resp
  48     Base class for HTML page creators (factories) for code entites or
  49     similar items.
  50 */
  51 template <class ENV>
  52 class HtmlFactory
  53 {
  54   public:
  55     // INQUIRY
  56     ENV &               Env() const             { return *pEnv; }
  57     Xml::Element &      CurOut() const          { return aDestination.Out(); }
  58
  59     // ACCESS
  60     OutputStack &       Out() const             { return aDestination; }
  61
  62   protected:
  63                         HtmlFactory(
  64                             ENV &               io_rEnv,
  65                             Xml::Element *      o_pOut = 0 )
  66                             :   pEnv(&io_rEnv)  { if (o_pOut != 0) aDestination.Enter(*o_pOut); }
  67                         ~HtmlFactory() {}
  68   private:
  69     // DATA
  70     ENV *               pEnv;
  71     mutable OutputStack aDestination;
  72 };
  73
  74
  75 /** @resp
  76     Base class for HTML paragraph creators, which are to be put into
  77     a parent HTML element.
  78 */
  79 class HtmlMaker
  80 {
  81   public:
  82
  83     // INQUIRY
  84     Xml::Element &      CurOut() const          { return *pOut; }
  85
  86   protected:
  87                         HtmlMaker(
  88                             Xml::Element &      o_rOut )
  89                             :   pOut(&o_rOut)   {}
  90   private:
  91     // DATA
  92     Xml::Element *      pOut;
  93 };
  94
  95
  96
  97
  98 // IMPLEMENTATION
  99
 100
 101
 102
 103 #endif
 104
 105