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