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_HFI_DOC_HXX
29 #define ADC_DISPLAY_HFI_DOC_HXX
30 
31 
32 
33 // USED SERVICES
34 	// BASE CLASSES
35 #include "hi_factory.hxx"
36 	// COMPONENTS
37 	// PARAMETERS
38 
39 
40 class HF_DocEntryList;
41 
42 
43 class HF_IdlDocu : public HtmlFactory_Idl
44 {
45   public:
46                         HF_IdlDocu(
47                             Environment &       io_rEnv,
48                             HF_DocEntryList &   o_rOut );
49     virtual             ~HF_IdlDocu();
50 
51 
52     /** Produces documentation by the CodeInfo accompanying
53         ->i_ce.
54     */
55     void                Produce_fromCodeEntity(
56                             const client &      i_ce ) const;
57 
58     /** Produces documentation by the CodeInfo accompanying
59         a link or reference to a CodeEntity.
60 
61         @param i_rScopeGivingCe
62         Gives the scope from which links are to be calculated.
63     */
64     void                Produce_fromReference(
65                             const ce_info &     i_rDocuForReference,
66                             const client &      i_rScopeGivingCe ) const;
67 
68   private:
69     // Locals
70     /** Produces documentation.
71 
72         @param i_rScopeGivingCe
73         Gives the scope from which links are to be calculated.
74     */
75     void                Produce_byDocuAndScope(
76                             const ce_info &     i_rDocu,
77                             const client *      i_pClient,      /// May be 0.
78                             const client &      i_rScopeGivingCe ) const;
79 
80     // DATA
81     HF_DocEntryList &   rOut;
82 };
83 
84 
85 #endif
86