include/svx/textchainflow.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 INCLUDED_SVX_TEXTCHAINFLOW_HXX
  21 #define INCLUDED_SVX_TEXTCHAINFLOW_HXX
  22
  23 #include <svx/textchain.hxx>
  24 #include <memory>
  25
  26 class SdrTextObj;
  27 class SdrOutliner;
  28 class NonOverflowingText;
  29 class OverflowingText;
  30 class TextChain;
  31 class OutlinerParaObject;
  32 class OFlowChainedText;
  33 class UFlowChainedText;
  34
  35 class TextChainFlow
  36 {
  37 public:
  38     TextChainFlow(SdrTextObj *pChainTarget);
  39     virtual ~TextChainFlow();
  40
  41     // Check for flow events in Outliner
  42     virtual void CheckForFlowEvents(SdrOutliner *);
  43
  44     void ExecuteUnderflow(SdrOutliner *);
  45
  46     // Uses two outliners: one for the non-overflow text and one for overflowing (might be the same)
  47     void ExecuteOverflow(SdrOutliner *, SdrOutliner *);
  48
  49     bool IsOverflow() const;
  50     bool IsUnderflow() const;
  51
  52     SdrTextObj *GetLinkTarget() const;
  53
  54 protected:
  55     // Cursor related
  56     bool mbPossiblyCursorOut;
  57     ESelection maOverflowPosSel;
  58     ESelection maPostChainingSel;
  59
  60     std::unique_ptr<OFlowChainedText> mpOverflChText;
  61     std::unique_ptr<UFlowChainedText> mpUnderflChText;
  62
  63     void impCheckForFlowEvents(SdrOutliner *, SdrOutliner *);
  64
  65     TextChain *GetTextChain() const;
  66
  67     virtual void impLeaveOnlyNonOverflowingText(SdrOutliner *);
  68     void impMoveChainedTextToNextLink(SdrOutliner *);
  69
  70     virtual void impSetFlowOutlinerParams(SdrOutliner *, SdrOutliner *);
  71
  72 private:
  73     bool mbOFisUFinduced;
  74
  75     void impUpdateCursorInfo();
  76
  77     SdrTextObj *mpTargetLink;
  78     SdrTextObj *mpNextLink;
  79
  80     TextChain *mpTextChain;
  81
  82     bool bUnderflow;
  83     bool bOverflow;
  84 };
  85
  86
  87 // NOTE: EditingTextChainFlow might be strongly coupled with behavior in SdrTextObj::onChainingEvent
  88 class EditingTextChainFlow : public TextChainFlow
  89 {
  90 public:
  91     EditingTextChainFlow(SdrTextObj *);
  92     virtual void CheckForFlowEvents(SdrOutliner *) override;
  93
  94     //virtual void ExecuteOverflow(SdrOutliner *, SdrOutliner *) override;
  95
  96 protected:
  97     virtual void impLeaveOnlyNonOverflowingText(SdrOutliner *) override;
  98
  99     virtual void impSetFlowOutlinerParams(SdrOutliner *, SdrOutliner *) override;
 100
 101 private:
 102     void impBroadcastCursorInfo() const;
 103 };
 104
 105 #endif // INCLUDED_SVX_TEXTCHAINFLOW_HXX
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */