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