autodoc/source/display/html/pm_class.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_class.hxx,v $
  10  * $Revision: 1.3 $
  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_CLASS_HXX
  32 #define ADC_DISPLAY_HTML_PM_CLASS_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include "pm_base.hxx"
  39     // COMPONENTS
  40     // PARAMETERS
  41
  42
  43 namespace ary
  44 {
  45      namespace cpp
  46     {
  47          class Class;
  48     }
  49 }
  50
  51 class ChildList_Display;
  52 class NavigationBar;
  53
  54
  55 class PageMaker_Class : public SpecializedPageMaker
  56 {
  57   public:
  58     enum E_ChidList
  59     {
  60         cl_NestedClasses = 0,
  61         cl_NestedStructs,
  62         cl_NestedUnions,
  63         cl_Enums,
  64         cl_Typedefs,
  65         cl_Operations,
  66         cl_StaticOperations,
  67         cl_Data,
  68         cl_StaticData,
  69         cl_MAX
  70     };
  71                         PageMaker_Class(
  72                             PageDisplay &       io_rPage,
  73                             const ary::cpp::Class &
  74                                                 i_rClass );
  75
  76     virtual                             ~PageMaker_Class();
  77
  78     virtual void        MakePage();
  79
  80   private:
  81     enum E_MemberProtection { mp_public = 0, mp_protected, mp_private, mp_MAX };
  82
  83     virtual void        Write_NavBar();
  84     virtual void        Write_TopArea();
  85     virtual void        Write_DocuArea();
  86     virtual void        Write_ChildList(
  87                             ary::SlotAccessId   i_nSlot,
  88                             E_ChidList          i_eChildListIndex,
  89                             const char *        i_sLabel,
  90                             const char *        i_sListTitle,
  91                             csi::xml::Element & o_rPublic,
  92                             csi::xml::Element & o_rProtected,
  93                             csi::xml::Element & o_rPrivate );
  94     void                Write_ChildList_forClasses(
  95                             csi::xml::Element & o_rPublic,
  96                             csi::xml::Element & o_rProtected,
  97                             csi::xml::Element & o_rPrivate,
  98                             const char *        i_sLabel,
  99                             const char *        i_sListTitle,
 100                             ary::cpp::E_ClassKey
 101                                                 i_eFilter  );
 102     void                Write_ChildLists();
 103     static const char * ChildListLabel(
 104                             const char *        i_sLabel,
 105                             E_MemberProtection  i_eMpr );
 106     csi::html::DefListDefinition &
 107                         Setup_MemberSegment_Out(
 108                             E_MemberProtection  i_eMpr );
 109     void                Create_NaviSubRow(
 110                             E_MemberProtection  i_eMpr );
 111     void                Write_BaseHierarchy();
 112     void                Write_DerivedList();
 113
 114     const ary::cpp::Class &
 115                         Me() const              { return *pMe; }
 116     // DATA
 117     const ary::cpp::Class *
 118                         pMe;
 119     Dyn<ChildList_Display>
 120                         pChildDisplay;
 121     Dyn<NavigationBar>  pNavi;
 122
 123     Dyn<csi::xml::Element>
 124                         pProtectionArea[mp_MAX];
 125
 126     bool                bChildLists_Exist[3*cl_MAX];
 127 };
 128
 129
 130
 131
 132
 133 #endif
 134