autodoc/source/display/html/pm_aldef.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_aldef.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_HTML_PM_ALDEF_HXX
  32 #define ADC_DISPLAY_HTML_PM_ALDEF_HXX
  33
  34 // BASE CLASSES
  35 #include "pm_base.hxx"
  36 // USED SERVICES
  37 #include <ary/cpp/c_types4cpp.hxx>
  38 using ary::cpp::De_id;
  39
  40 namespace ary
  41 {
  42     namespace cpp
  43     {
  44         class DefineEntity;
  45     }
  46 }
  47
  48 class Docu_Display;
  49 class NavigationBar;
  50
  51
  52
  53
  54
  55 class PageMaker_AllDefs : public SpecializedPageMaker
  56 {
  57   public:
  58                         PageMaker_AllDefs(
  59                             PageDisplay &       io_rPage );
  60
  61     virtual                             ~PageMaker_AllDefs();
  62
  63     virtual void        MakePage();
  64
  65   private:
  66     typedef std::vector<De_id>              List_Ids;
  67     typedef List_Ids::const_iterator        ids_iterator;
  68
  69     virtual void        Write_NavBar();
  70     virtual void        Write_TopArea();
  71     virtual void        Write_DocuArea();
  72     virtual void        Write_DefinesList();
  73     virtual void        Write_MacrosList();
  74     void                Write_Define(
  75                             De_id               i_nId );
  76     void                Write_Macro(
  77                             De_id               i_nId );
  78     void                Write_DefsDocu(
  79                             csi::xml::Element & o_rOut,
  80                             const ary::cpp::DefineEntity &
  81                                                 i_rTextReplacement );
  82
  83     // DATA
  84     Dyn<Docu_Display>   pDocuDisplay;
  85     Dyn<NavigationBar>  pNavi;
  86 };
  87
  88
  89
  90
  91 #endif