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 <config_options.h>
  24 #include <editeng/editengdllapi.h>
  25 #include <editeng/editdata.hxx>
  26
  27 #include <com/sun/star/uno/Reference.h>
  28 #include <memory>
  29
  30 namespace com::sun::star {
  31   namespace datatransfer { 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     OverflowingText(css::uno::Reference< css::datatransfer::XTransferable > const & xOverflowingContent);
  72
  73     std::unique_ptr<OutlinerParaObject> JuxtaposeParaObject(Outliner *, OutlinerParaObject const *);
  74     std::unique_ptr<OutlinerParaObject> DeeplyMergeParaObject(Outliner *, OutlinerParaObject const *);
  75
  76 private:
  77     css::uno::Reference< css::datatransfer::XTransferable > mxOverflowingContent;
  78 };
  79
  80 class NonOverflowingText
  81 {
  82 public:
  83     NonOverflowingText(const ESelection &aSel, bool bLastParaInterrupted);
  84
  85     std::unique_ptr<OutlinerParaObject> RemoveOverflowingText(Outliner *) const;
  86     ESelection GetOverflowPointSel() const;
  87     bool IsLastParaInterrupted() const;
  88
  89 private:
  90     const ESelection maContentSel;
  91     const bool mbLastParaInterrupted;
  92 };
  93
  94
  95 /*
  96  * classes OFlowChainedText and UFlowChainedText:
  97  * contain and handle the state of a broken up text _after_ a flow event
  98  * (respectively after Overflow and Underflow).
  99  *
 100  */
 101 class UNLESS_MERGELIBS(EDITENG_DLLPUBLIC) OFlowChainedText
 102 {
 103 public:
 104     OFlowChainedText(Outliner const *, bool );
 105     ~OFlowChainedText();
 106
 107     std::unique_ptr<OutlinerParaObject> InsertOverflowingText(Outliner *, OutlinerParaObject const *);
 108     std::unique_ptr<OutlinerParaObject> RemoveOverflowingText(Outliner *);
 109
 110     ESelection GetOverflowPointSel() const;
 111
 112     bool IsLastParaInterrupted() const;
 113
 114 private:
 115     std::unique_ptr<NonOverflowingText> mpNonOverflowingTxt;
 116     std::unique_ptr<OverflowingText> mpOverflowingTxt;
 117
 118     bool mbIsDeepMerge;
 119 };
 120
 121 // UFlowChainedText is a simpler class than OFlowChainedText: it almost only joins para-objects
 122 class UNLESS_MERGELIBS(EDITENG_DLLPUBLIC) UFlowChainedText
 123 {
 124 public:
 125     UFlowChainedText(Outliner const *, bool);
 126     std::unique_ptr<OutlinerParaObject> CreateMergedUnderflowParaObject(Outliner *, OutlinerParaObject const *);
 127
 128 private:
 129     css::uno::Reference< css::datatransfer::XTransferable > mxUnderflowingTxt;
 130
 131     bool mbIsDeepMerge;
 132 };
 133
 134 #endif
 135
 136 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */