autodoc/source/display/html/pm_base.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: pm_base.hxx,v $
  10  * $Revision: 1.5.18.1 $
  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_PM_BASE_HXX
  32 #define ADC_DISPLAY_PM_BASE_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38     // COMPONENTS
  39     // PARAMETERS
  40 #include "hdimpl.hxx"
  41
  42
  43
  44 class OuputPage_Environment;
  45 namespace csi
  46 {
  47     namespace xml
  48     {
  49         class Element;
  50     }
  51 }
  52 class PageDisplay;
  53
  54
  55 /** Interface for making a special kind of HTML-Page
  56 */
  57 class SpecializedPageMaker
  58 {
  59   public:
  60     virtual             ~SpecializedPageMaker() {}
  61
  62     virtual void        MakePage() = 0;
  63
  64     virtual void        Write_NavBar();
  65     virtual void        Write_TopArea();
  66     virtual void        Write_DocuArea();
  67 //    virtual void        Write_ChildList(
  68 //                            ary::SlotAccessId   i_nSlot,
  69 //                            const char *        i_nListTitle,
  70 //                            const char *        i_nLabel );
  71
  72   protected:
  73                         SpecializedPageMaker(
  74                             PageDisplay &       io_rPage );
  75
  76     OuputPage_Environment &
  77                         Env() const             { return *pEnv; }
  78     csi::xml::Element & CurOut();
  79     PageDisplay &       Page()                  { return *pPage; }
  80
  81   private:
  82     OuputPage_Environment *
  83                         pEnv;
  84     csi::xml::Element * pCurOut;
  85     PageDisplay *       pPage;
  86 };
  87
  88
  89
  90 #endif
  91