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