autodoc/source/display/inc/toolkit/hf_linachain.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ADC_DISPLAY_HF_LINACHAIN_HXX
  21 #define ADC_DISPLAY_HF_LINACHAIN_HXX
  22
  23 // BASE CLASSES
  24 #include "htmlfactory.hxx"
  25 #include "out_position.hxx"
  26
  27
  28
  29
  30 class HF_LinkedNameChain : public HtmlMaker
  31 {
  32   public:
  33     /** F_LinkMaker makes a link out of the name of the
  34         parent position.
  35
  36         Returns true, if there is a link, false if not.
  37     */
  38     typedef String (*F_LinkMaker)(const char *);
  39
  40
  41                         HF_LinkedNameChain(
  42                             Xml::Element &      o_rOut );
  43     virtual             ~HF_LinkedNameChain();
  44
  45     void                Produce_CompleteChain(
  46                             const output::Position &
  47                                                 i_curPosition,
  48                             F_LinkMaker         i_linkMaker ) const;
  49     void                Produce_CompleteChain_forModule(
  50                             const output::Position &
  51                                                 i_curPosition,  /// current Module's node
  52                             F_LinkMaker         i_linkMaker ) const;
  53   private:
  54     void                produce_Level(
  55                             output::Node &      i_levelNode,
  56                             const output::Position &
  57                                                 i_startPosition,
  58                             F_LinkMaker         i_linkMaker ) const;
  59 };
  60
  61
  62
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */