1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef ADC_DISPLAY_HI_DISPLAY_HXX
29 #define ADC_DISPLAY_HI_DISPLAY_HXX
30 
31 
32 
33 // USED SERVICES
34     // BASE CLASSES
35 #include <autodoc/dsp_html_std.hxx>
36     // COMPONENTS
37 #include <cosv/ploc.hxx>
38     // PARAMETERS
39 
40 
41 
42 namespace ary
43 {
44     namespace idl
45     {
46         class Module;
47         class CodeEntity;
48     }   // namspace idl
49 }   // namspace csi
50 
51 
52 class MainDisplay_Idl;
53 class HtmlEnvironment_Idl;
54 
55 class HtmlDisplay_Idl : public autodoc::HtmlDisplay_Idl_Ifc
56 {
57   public:
58                         HtmlDisplay_Idl();
59                         ~HtmlDisplay_Idl();
60   private:
61     // Interface HtmlDisplay_Idl_Ifc:
62     virtual void        do_Run(
63                             const char *        i_sOutputDirectory,
64                             const ary::idl::Gate &
65                                                 i_rAryGate,
66                             const display::CorporateFrame &
67                                                 i_rLayout );
68     void                SetRunData(
69                             const char *        i_sOutputDirectory,
70                             const ary::idl::Gate &
71                                                 i_rAryGate,
72                             const display::CorporateFrame &
73                                                 i_rLayout );
74     void                Create_StartFile();
75     void                Create_FilesInNameTree();
76     void                Create_IndexFiles();
77     void                Create_FilesInProjectTree();
78     void                Create_PackageList();
79     void                Create_HelpFile();
80     void                Create_CssFile();
81 
82     /** @descr
83         - makes sure, the module's directory exists
84         - creates the module's docu file
85         - creates docu files for all members of the module
86         - does the same recursive for all sub-modules.
87     */
88     void                RecursiveDisplay_Module(
89                             const ary::idl::Module &
90                                                 i_rNamespace );
91     bool                IsModule(
92                             const ary::idl::CodeEntity &
93                                                 i_ce ) const;
94     const ary::idl::Module &
95                         Module_Cast(            /// @precond Cast must be valid.
96                             const ary::idl::CodeEntity &
97                                                 i_ce ) const;
98     // DATA
99     Dyn<HtmlEnvironment_Idl>
100                         pCurPageEnv;
101     Dyn<MainDisplay_Idl>
102                         pMainDisplay;
103 };
104 
105 
106 
107 // IMPLEMENTATION
108 
109 
110 #endif
111 
112