autodoc/source/display/idl/hfi_module.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_MODULE_HXX
  30 #define ADC_DISPLAY_HFI_MODULE_HXX
  31
  32
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include "hi_factory.hxx"
  37     // COMPONENTS
  38     // PARAMETERS
  39
  40
  41 class HF_NaviSubRow;
  42
  43 class HF_IdlModule : public HtmlFactory_Idl
  44 {
  45   public:
  46                         HF_IdlModule(
  47                             Environment &       io_rEnv,    // The CurDirectory() is the one of the here displayed Module.
  48                             Xml::Element &      o_rOut );
  49     virtual             ~HF_IdlModule();
  50
  51     void                Produce_byData(
  52                            const client &       i_ce ) const;
  53   private:
  54     typedef std::vector< const ary::idl::CodeEntity* >  ce_ptr_list;
  55
  56     DYN HF_NaviSubRow & make_Navibar(
  57                             const client &      i_ce ) const;
  58     bool                produce_ChildList(
  59                             const String &      i_sName,
  60                             const String &      i_sLabel,
  61                             const ce_ptr_list & i_list ) const;
  62     void                produce_Link(
  63                             Xml::Element &      o_row,
  64                             const client *      i_ce ) const;
  65     void                produce_LinkDoc(
  66                             Xml::Element &      o_row,
  67                             const client *      i_ce ) const;
  68 };
  69
  70
  71
  72 // IMPLEMENTATION
  73
  74
  75 extern const String
  76     C_sCePrefix_Module;
  77
  78
  79
  80
  81
  82 #endif
  83
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */