autodoc/source/display/html/nav_main.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: nav_main.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_NAV_MAIN_HXX
  32 #define ADC_DISPLAY_HTML_NAV_MAIN_HXX
  33
  34 // USED SERVICES
  35
  36 namespace ary
  37 {
  38 namespace cpp
  39 {
  40     class CodeEntity;
  41 }
  42 namespace loc
  43 {
  44     class File;
  45 }
  46 }
  47 namespace csi
  48 {
  49 namespace xml
  50 {
  51     class Element;
  52 }
  53 }
  54
  55 class OuputPage_Environment;
  56 class MainItem;
  57
  58
  59
  60
  61 class MainRow
  62 {
  63   public:
  64                         MainRow(
  65                             const OuputPage_Environment &
  66                                                 i_rEnv );
  67                         ~MainRow();
  68
  69     void                SetupItems_Overview();
  70     void                SetupItems_AllDefs();
  71     void                SetupItems_Index();
  72     void                SetupItems_Help();
  73
  74     void                SetupItems_Ce(
  75                             const ary::cpp::CodeEntity &
  76                                                 i_rCe );
  77     void                SetupItems_FunctionGroup(); /// For class member methods.
  78     void                SetupItems_DataGroup();     /// For class member data.
  79
  80     void                Write2(
  81                             csi::xml::Element & o_rOut ) const;
  82   private:
  83     // Local
  84     enum E_Style
  85     {
  86         eSelf,
  87         eNo,
  88         eStd
  89     };
  90
  91     /** @precond
  92         Only combinations of 1 eSelf and 2 eStd are allowed
  93         as arguments, here.
  94     */
  95     void                Create_ItemList_Global(
  96                             E_Style             i_eOverview,
  97                             E_Style             i_eIndex,
  98                             E_Style             i_eHelp );
  99     void                Create_ItemList_InDirTree_Cpp(
 100                             E_Style             i_eNsp,
 101                             E_Style             i_eClass,
 102                             E_Style             i_eTree,
 103                             const char *        i_sTreeLink );
 104     void                Add_Item(
 105                             E_Style             i_eStyle,
 106                             const String  &     i_sText,
 107                             const char *        i_sLink,
 108                             const char *        i_sTip );
 109     // DATA
 110     typedef std::vector< DYN MainItem* > ItemList;
 111
 112
 113     ItemList            aItems;
 114     const OuputPage_Environment *
 115                         pEnv;
 116 };
 117
 118
 119
 120
 121 #endif