autodoc/source/display/idl/hfi_doc.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ADC_DISPLAY_HFI_DOC_HXX
  30 #define ADC_DISPLAY_HFI_DOC_HXX
  31
  32
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include "hi_factory.hxx"
  37     // COMPONENTS
  38     // PARAMETERS
  39
  40
  41 class HF_DocEntryList;
  42
  43
  44 class HF_IdlDocu : public HtmlFactory_Idl
  45 {
  46   public:
  47                         HF_IdlDocu(
  48                             Environment &       io_rEnv,
  49                             HF_DocEntryList &   o_rOut );
  50     virtual             ~HF_IdlDocu();
  51
  52
  53     /** Produces documentation by the CodeInfo accompanying
  54         ->i_ce.
  55     */
  56     void                Produce_fromCodeEntity(
  57                             const client &      i_ce ) const;
  58
  59     /** Produces documentation by the CodeInfo accompanying
  60         a link or reference to a CodeEntity.
  61
  62         @param i_rScopeGivingCe
  63         Gives the scope from which links are to be calculated.
  64     */
  65     void                Produce_fromReference(
  66                             const ce_info &     i_rDocuForReference,
  67                             const client &      i_rScopeGivingCe ) const;
  68
  69   private:
  70     // Locals
  71     /** Produces documentation.
  72
  73         @param i_rScopeGivingCe
  74         Gives the scope from which links are to be calculated.
  75     */
  76     void                Produce_byDocuAndScope(
  77                             const ce_info &     i_rDocu,
  78                             const client *      i_pClient,      /// May be 0.
  79                             const client &      i_rScopeGivingCe ) const;
  80
  81     // DATA
  82     HF_DocEntryList &   rOut;
  83 };
  84
  85
  86 #endif
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */