include/editeng/overflowingtxt.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_EDITENG_OVERFLOWINGTXT_HXX
  21 #define INCLUDED_EDITENG_OVERFLOWINGTXT_HXX
  22
  23 #include <editeng/editengdllapi.h>
  24 #include <editeng/editdata.hxx>
  25
  26 #include <com/sun/star/uno/Reference.h>
  27 #include <memory>
  28
  29 namespace com { namespace sun { namespace star {
  30   namespace datatransfer {
  31     class XTransferable;
  32 } } } }
  33 namespace rtl {
  34     class OUString;
  35 };
  36 using ::rtl::OUString;
  37
  38
  39 class OutlinerParaObject;
  40 class Outliner;
  41
  42
  43 /*
  44  * A collection of static methods for attaching text.
  45  * Strongly coupled with some of the classes in this file.
  46  */
  47 class TextChainingUtils
  48 {
  49 public:
  50     static css::uno::Reference< css::datatransfer::XTransferable> CreateTransferableFromText(Outliner const *);
  51
  52     static std::unique_ptr<OutlinerParaObject> JuxtaposeParaObject(
  53             css::uno::Reference< css::datatransfer::XTransferable > const & xOverflowingContent,
  54             Outliner *,
  55             OutlinerParaObject const *);
  56     static std::unique_ptr<OutlinerParaObject> DeeplyMergeParaObject(
  57             css::uno::Reference< css::datatransfer::XTransferable > const & xOverflowingContent,
  58             Outliner *,
  59             OutlinerParaObject const *);
  60 };
  61
  62 /*
  63  * The classes OverflowingText and NonOverflowingText handle the
  64  * actual preparation of the OutlinerParaObjects to be used in destination
  65  * and source box respectively.
  66 */
  67
  68 class OverflowingText
  69 {
  70 public:
  71     std::unique_ptr<OutlinerParaObject> JuxtaposeParaObject(Outliner *, OutlinerParaObject const *);
  72     std::unique_ptr<OutlinerParaObject> DeeplyMergeParaObject(Outliner *, OutlinerParaObject const *);
  73
  74 private:
  75     friend class Outliner;
  76     OverflowingText(css::uno::Reference< css::datatransfer::XTransferable > const & xOverflowingContent);
  77
  78     css::uno::Reference< css::datatransfer::XTransferable > mxOverflowingContent;
  79 };
  80
  81 class NonOverflowingText
  82 {
  83 public:
  84     std::unique_ptr<OutlinerParaObject> RemoveOverflowingText(Outliner *) const;
  85     ESelection GetOverflowPointSel() const;
  86     bool IsLastParaInterrupted() const;
  87
  88 private:
  89     NonOverflowingText(const ESelection &aSel, bool bLastParaInterrupted);
  90
  91     friend class Outliner;
  92     const ESelection maContentSel;
  93     const bool mbLastParaInterrupted;
  94 };
  95
  96
  97 /*
  98  * classes OFlowChainedText and UFlowChainedText:
  99  * contain and handle the state of a broken up text _after_ a flow event
 100  * (respectively after Overflow and Underflow).
 101  *
 102  */
 103 class EDITENG_DLLPUBLIC OFlowChainedText
 104 {
 105 public:
 106     OFlowChainedText(Outliner const *, bool );
 107     ~OFlowChainedText();
 108
 109     std::unique_ptr<OutlinerParaObject> InsertOverflowingText(Outliner *, OutlinerParaObject const *);
 110     std::unique_ptr<OutlinerParaObject> RemoveOverflowingText(Outliner *);
 111
 112     ESelection GetOverflowPointSel() const;
 113
 114     bool IsLastParaInterrupted() const;
 115
 116 private:
 117     std::unique_ptr<NonOverflowingText> mpNonOverflowingTxt;
 118     std::unique_ptr<OverflowingText> mpOverflowingTxt;
 119
 120     bool mbIsDeepMerge;
 121 };
 122
 123 // UFlowChainedText is a simpler class than OFlowChainedText: it almost only joins para-objects
 124 class EDITENG_DLLPUBLIC UFlowChainedText
 125 {
 126 public:
 127     UFlowChainedText(Outliner const *, bool);
 128     std::unique_ptr<OutlinerParaObject> CreateMergedUnderflowParaObject(Outliner *, OutlinerParaObject const *);
 129
 130 private:
 131     css::uno::Reference< css::datatransfer::XTransferable > mxUnderflowingTxt;
 132
 133     bool mbIsDeepMerge;
 134 };
 135
 136 #endif
 137
 138 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */