autodoc/source/display/idl/hfi_service.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_service.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_SERVICE_HXX
  32 #define ADC_DISPLAY_HFI_SERVICE_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37 #include "hi_factory.hxx"
  38     // COMPONENTS
  39     // PARAMETERS
  40 #include <ary/idl/i_comrela.hxx>
  41
  42 class HF_NaviSubRow;
  43 class HF_SubTitleTable;
  44
  45 class HF_IdlService : public HtmlFactory_Idl
  46 {
  47   public:
  48     typedef ::ary::idl::CommentedRelation       comref;
  49     typedef ::ary::StdConstIterator< comref >   comref_list;
  50
  51                         HF_IdlService(
  52                             Environment &       io_rEnv,
  53                             Xml::Element &      o_rOut );
  54     virtual             ~HF_IdlService();
  55
  56     void                Produce_byData(
  57                            const client &       i_ce ) const;
  58    private:
  59     // Overwritten from HtmlFactory_Idl:
  60     virtual void        produce_SummaryDeclaration(
  61                             Xml::Element &      o_row,
  62                             const client &      i_ce ) const;
  63
  64     // Locals
  65     DYN HF_NaviSubRow & make_Navibar(
  66                             const client &      i_ce ) const;
  67
  68     void                produce_Link(
  69                             Xml::Element &      o_row,
  70                             type_id             i_type ) const;
  71     void                produce_LinkSummary(
  72                             const client &      i_ce,
  73                             Xml::Element &      o_row,
  74                             const comref &  i_commentedRef ) const;
  75
  76     void                produce_MemberDetails(        /// of property
  77                             HF_SubTitleTable &  o_table,
  78                             const client &      i_ce ) const;
  79
  80     void                produce_CommentedRelations(
  81                             const client &  i_ce,
  82                             comref_list &   it_list,
  83                             const String &  i_summaryTitle,
  84                             const String &  i_summaryLabel,
  85                             const String &  i_detailsTitle,
  86                             const String &  i_detailsLabel,
  87                             const E_DocType i_docType ) const;
  88
  89 };
  90
  91
  92
  93 // IMPLEMENTATION
  94
  95 extern const String
  96     C_sCePrefix_Service;
  97
  98
  99
 100 #endif
 101
 102