autodoc/source/display/inc/toolkit/hf_linachain.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: hf_linachain.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_HF_LINACHAIN_HXX
  32 #define ADC_DISPLAY_HF_LINACHAIN_HXX
  33
  34 // BASE CLASSES
  35 #include "htmlfactory.hxx"
  36 #include "out_position.hxx"
  37
  38
  39
  40
  41 class HF_LinkedNameChain : public HtmlMaker
  42 {
  43   public:
  44     /** F_LinkMaker makes a link out of the name of the
  45         parent position.
  46
  47         Returns true, if there is a link, false if not.
  48     */
  49     typedef String (*F_LinkMaker)(const char *);
  50
  51
  52                         HF_LinkedNameChain(
  53                             Xml::Element &      o_rOut );
  54     virtual             ~HF_LinkedNameChain();
  55
  56     void                Produce_CompleteChain(
  57                             const output::Position &
  58                                                 i_curPosition,
  59                             F_LinkMaker         i_linkMaker ) const;
  60     void                Produce_CompleteChain_forModule(
  61                             const output::Position &
  62                                                 i_curPosition,  /// current Module's node
  63                             F_LinkMaker         i_linkMaker ) const;
  64   private:
  65     void                produce_Level(
  66                             output::Node &      i_levelNode,
  67                             const output::Position &
  68                                                 i_startPosition,
  69                             F_LinkMaker         i_linkMaker ) const;
  70 };
  71
  72
  73
  74
  75 #endif