autodoc/source/display/idl/hfi_xrefpage.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_XREFPAGE_HXX
  30 #define ADC_DISPLAY_HFI_XREFPAGE_HXX
  31
  32
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include "hi_factory.hxx"
  37     // COMPONENTS
  38     // PARAMETERS
  39
  40
  41 class HF_IdlXrefs : public HtmlFactory_Idl
  42 {
  43   public:
  44     typedef void (*F_GET_SUBLIST)(dyn_ce_list&, const client&);
  45
  46                         HF_IdlXrefs(
  47                             Environment &       io_rEnv,
  48                             Xml::Element &      o_rOut,
  49                             const String &      i_prefix,
  50                             const client &      i_ce);
  51     virtual             ~HF_IdlXrefs();
  52
  53     /** @descr
  54         Only lists which are tried to be produced by Produce_List() or
  55         Produce_Tree(), will occur in the content directory of the page.
  56         They will have links, if the list or tree has at least one element,
  57         else the list is mentioned in the directory without link.
  58
  59         @param i_label [*i_label == '#']
  60     */
  61     void                Produce_List(
  62                             const char *        i_title,
  63                             const char *        i_label,
  64                             ce_list &           i_iterator ) const;
  65     void                Write_ManualLinks(
  66                             const client &      i_ce ) const;
  67     /** @descr
  68         Only lists which are tried to be produced by Produce_List() or
  69         Produce_Tree(), will occur in the content directory of the page.
  70         They will have links, if the list or tree has at least one element,
  71         else the list is mentioned in the directory without link.
  72
  73         @param i_label [*i_label == '#']
  74     */
  75     void                Produce_Tree(
  76                             const char *        i_title,
  77                             const char *        i_label,
  78                             const client &      i_ce,
  79                             F_GET_SUBLIST       i_sublistcreator ) const;
  80
  81   private:
  82     // Locals
  83     void                produce_Main(
  84                             const String &      i_prefix,
  85                             const client &      i_ce ) const;
  86     void                make_Navibar(
  87                             const client &      i_ce ) const;
  88     /// @return true if there are any elements in sub lists.
  89     void                recursive_make_ListInTree(
  90                             Xml::Element &      o_rDisplay,
  91                             uintt               i_level,    /// 0 is highest
  92                             const client &      i_ce,
  93                             ce_list &           i_iterator,
  94                             F_GET_SUBLIST       i_sublistcreator ) const;
  95
  96     // DATA
  97     Xml::Element &      rContentDirectory;
  98     const client *      pClient;
  99 };
 100
 101
 102
 103 // IMPLEMENTATION
 104
 105 #endif
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */