autodoc/source/display/html/pm_index.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_index.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_HTML_PM_INDEX_HXX
  32 #define ADC_DISPLAY_HTML_PM_INDEX_HXX
  33
  34 // BASE CLASSES
  35 #include "pm_base.hxx"
  36 #include <ary/ary_disp.hxx>
  37 #include <cosv/tpl/processor.hxx>
  38 // USED SERVICES
  39 namespace adcdisp
  40 {
  41      class IndexList;
  42 }
  43 namespace ary
  44 {
  45     namespace cpp
  46     {
  47         class Namespace;
  48         class Class;
  49         class Enum;
  50         class Typedef;
  51         class Function;
  52         class Variable;
  53         class EnumValue;
  54         class Define;
  55         class Macro;
  56     }
  57 }
  58
  59 class NavigationBar;
  60
  61
  62
  63
  64 class PageMaker_Index : public SpecializedPageMaker,
  65                         public ary::Display,
  66                         public csv::ConstProcessor<ary::cpp::Namespace>,
  67                         public csv::ConstProcessor<ary::cpp::Class>,
  68                         public csv::ConstProcessor<ary::cpp::Enum>,
  69                         public csv::ConstProcessor<ary::cpp::Typedef>,
  70                         public csv::ConstProcessor<ary::cpp::Function>,
  71                         public csv::ConstProcessor<ary::cpp::Variable>,
  72                         public csv::ConstProcessor<ary::cpp::EnumValue>,
  73                         public csv::ConstProcessor<ary::cpp::Define>,
  74                         public csv::ConstProcessor<ary::cpp::Macro>
  75 {
  76   public:
  77                         PageMaker_Index(
  78                             PageDisplay &       io_rPage,
  79                             char                i_c );
  80
  81     virtual                             ~PageMaker_Index();
  82
  83     virtual void        MakePage();
  84
  85   private:
  86     // Interface csv::ConstProcessor<>
  87     virtual void        do_Process(
  88                             const ary::cpp::Namespace &
  89                                                 i_rData );
  90     virtual void        do_Process(
  91                             const ary::cpp::Class &
  92                                                 i_rData );
  93     virtual void        do_Process(
  94                             const ary::cpp::Enum &
  95                                                 i_rData );
  96     virtual void        do_Process(
  97                             const ary::cpp::Typedef &
  98                                                 i_rData );
  99     virtual void        do_Process(
 100                             const ary::cpp::Function &
 101                                                 i_rData );
 102     virtual void        do_Process(
 103                             const ary::cpp::Variable &
 104                                                 i_rData );
 105     virtual void        do_Process(
 106                             const ary::cpp::EnumValue &
 107                                                 i_rData );
 108     virtual void        do_Process(
 109                             const ary::cpp::Define &
 110                                                 i_rData );
 111     virtual void        do_Process(
 112                             const ary::cpp::Macro &
 113                                                 i_rData );
 114     // Interface ary::cpp::Display:
 115     virtual const ary::cpp::Gate *
 116                         inq_Get_ReFinder() const;
 117     // Locals
 118     virtual void        Write_NavBar();
 119     virtual void        Write_TopArea();
 120     virtual void        Write_CompleteAlphabeticalList();
 121
 122     void                Write_CeIndexEntry(
 123                             const ary::cpp::CodeEntity &
 124                                                 i_rCe,
 125                             const char *        i_sType,
 126                             const char *        i_sOwnerType );
 127
 128     // DATA
 129     Dyn<NavigationBar>  pNavi;
 130     char                c;
 131     adcdisp::IndexList *
 132                         pCurIndex;
 133 };
 134
 135
 136
 137
 138 #endif