sw/inc/ToxTabStopTokenHandler.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
  10
  11 #ifndef TOXTABSTOPTOKENHANDLER_HXX_
  12 #define TOXTABSTOPTOKENHANDLER_HXX_
  13
  14 #include <rtl/ustring.hxx>
  15
  16 #include <editeng/tstpitem.hxx>
  17
  18 struct SwFormToken;
  19 class SwPageDesc;
  20 class SwRootFrame;
  21 class SwTextNode;
  22
  23 namespace sw {
  24
  25 /** This class handles tab stop tokens in the pattern for tox entries.
  26  *
  27  * @internal
  28  * This is an interface class. It allows to mock the class in unit tests
  29  */
  30 class ToxTabStopTokenHandler
  31 {
  32 public:
  33     virtual ~ToxTabStopTokenHandler() {}
  34
  35     /** Return value of HandleTabStopToken */
  36     struct HandledTabStopToken {
  37         OUString text;
  38         SvxTabStop tabStop;
  39     };
  40
  41     /** Handle a tab stop token.
  42      *
  43      * @returns A HandledTabStopToken. Make sure to append the text field to the text of the target node
  44      *          and to provide the returned SvxTabStop to the attributes of the node.
  45      */
  46     virtual HandledTabStopToken
  47     HandleTabStopToken(const SwFormToken& aToken, const SwTextNode& targetNode,
  48             const SwRootFrame *currentLayout) const = 0;
  49 };
  50
  51 /** The default implementation of ToxTabStopTokenHandler */
  52 class DefaultToxTabStopTokenHandler final : public ToxTabStopTokenHandler
  53 {
  54 public:
  55
  56     enum TabStopReferencePolicy {TABSTOPS_RELATIVE_TO_INDENT, TABSTOPS_RELATIVE_TO_PAGE};
  57
  58     /**
  59     * @param indexOfSectionNode
  60     * The index of the section node. It is needed to determine whether a page description was given by a node
  61     * before the tox section.
  62     *
  63     * @param defaultPageDescription
  64     * Which page description shall be used if we do not find one or the found page description was provided by
  65     * a node before the tox section
  66     *
  67     * @param tabPositionIsRelativeToParagraphIndent
  68     * Whether the tab position is relative to the paragraph indent. (toxForm.IsRelTabPos() is true or false.)
  69     *
  70     * @param tabstopReferencePolicy
  71     * How tab stops are positioned. (#i21237) The default behavior is to place tab stops relative to the page.
  72     */
  73     DefaultToxTabStopTokenHandler(sal_uInt32 indexOfSectionNode, const SwPageDesc& defaultPageDescription,
  74             bool tabPositionIsRelativeToParagraphIndent,
  75             TabStopReferencePolicy referencePolicy);
  76
  77     /** Handle a tab stop token.
  78      *
  79      * If the token contains tab alignment information, that is used to create the SvxTabStop.
  80      * Else, the information about the tab stop is taken from a page description.
  81      * Depending on the TabStopReferencePolicy provided in the constructor, the
  82      * method behaves differently when deriving the tab stop position.
  83      */
  84     ToxTabStopTokenHandler::HandledTabStopToken
  85     HandleTabStopToken(const SwFormToken& aToken, const SwTextNode& targetNode,
  86             const SwRootFrame *currentLayout) const override;
  87
  88 private:
  89     /** Test whether the page layout can be obtained by a layout rectangle.
  90      *
  91      * Is used to determine how to find tab stop position.
  92      */
  93     static bool
  94     CanUseLayoutRectangle(const SwTextNode& targetNode, const SwRootFrame *currentLayout);
  95
  96     /** Calculate the page margin from the page description.
  97      *
  98      * This is the fallback method to determine the position of a tab stop.
  99      */
 100     tools::Long
 101     CalculatePageMarginFromPageDescription(const SwTextNode& targetNode) const;
 102
 103     sal_uInt32 mIndexOfSectionNode;
 104     const SwPageDesc& mDefaultPageDescription;
 105     bool mTabPositionIsRelativeToParagraphIndent;
 106     TabStopReferencePolicy mTabStopReferencePolicy;
 107 };
 108
 109 }
 110
 111 #endif /* TOXTABSTOPTOKENHANDLER_HXX_ */
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */