autodoc/source/display/inc/idl/hi_display.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: hi_display.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_HI_DISPLAY_HXX
  32 #define ADC_DISPLAY_HI_DISPLAY_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <autodoc/dsp_html_std.hxx>
  39     // COMPONENTS
  40 #include <cosv/ploc.hxx>
  41     // PARAMETERS
  42
  43
  44
  45 namespace ary
  46 {
  47     namespace idl
  48     {
  49         class Module;
  50         class CodeEntity;
  51     }   // namspace idl
  52 }   // namspace csi
  53
  54
  55 class MainDisplay_Idl;
  56 class HtmlEnvironment_Idl;
  57
  58 class HtmlDisplay_Idl : public autodoc::HtmlDisplay_Idl_Ifc
  59 {
  60   public:
  61                         HtmlDisplay_Idl();
  62                         ~HtmlDisplay_Idl();
  63   private:
  64     // Interface HtmlDisplay_Idl_Ifc:
  65     virtual void        do_Run(
  66                             const char *        i_sOutputDirectory,
  67                             const ary::idl::Gate &
  68                                                 i_rAryGate,
  69                             const display::CorporateFrame &
  70                                                 i_rLayout );
  71     void                SetRunData(
  72                             const char *        i_sOutputDirectory,
  73                             const ary::idl::Gate &
  74                                                 i_rAryGate,
  75                             const display::CorporateFrame &
  76                                                 i_rLayout );
  77     void                Create_StartFile();
  78     void                Create_FilesInNameTree();
  79     void                Create_IndexFiles();
  80     void                Create_FilesInProjectTree();
  81     void                Create_PackageList();
  82     void                Create_HelpFile();
  83     void                Create_CssFile();
  84
  85     /** @descr
  86         - makes sure, the module's directory exists
  87         - creates the module's docu file
  88         - creates docu files for all members of the module
  89         - does the same recursive for all sub-modules.
  90     */
  91     void                RecursiveDisplay_Module(
  92                             const ary::idl::Module &
  93                                                 i_rNamespace );
  94     bool                IsModule(
  95                             const ary::idl::CodeEntity &
  96                                                 i_ce ) const;
  97     const ary::idl::Module &
  98                         Module_Cast(            /// @precond Cast must be valid.
  99                             const ary::idl::CodeEntity &
 100                                                 i_ce ) const;
 101     // DATA
 102     Dyn<HtmlEnvironment_Idl>
 103                         pCurPageEnv;
 104     Dyn<MainDisplay_Idl>
 105                         pMainDisplay;
 106 };
 107
 108
 109
 110 // IMPLEMENTATION
 111
 112
 113 #endif
 114