Add a comment to clarify what kind of inputs the class handles
[LibreOffice.git] / sw / source / core / inc / unoflatpara.hxx
blob30631fabae6a130eeae232a65c395031404eb752
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #pragma once
22 #include <cppuhelper/implbase.hxx>
24 #include <com/sun/star/beans/XPropertySet.hpp>
25 #include <com/sun/star/text/XFlatParagraph.hpp>
26 #include <com/sun/star/text/XFlatParagraphIterator.hpp>
27 #include <svl/listener.hxx>
28 #include "unotextmarkup.hxx"
29 #include <nodeoffset.hxx>
31 #include <set>
33 namespace com::sun::star::container { class XStringKeyMap; }
34 namespace com::sun::star::text { class XTextRange; }
35 class SwTextNode;
36 class SwDoc;
37 class ModelToViewHelper;
39 typedef ::cppu::ImplInheritanceHelper
40 < SwXTextMarkup
41 , css::beans::XPropertySet
42 , css::text::XFlatParagraph
43 > SwXFlatParagraph_Base;
45 class SwXFlatParagraph final
46 : public SwXFlatParagraph_Base
48 public:
49 SwXFlatParagraph( SwTextNode& rTextNode, OUString aExpandText, const ModelToViewHelper& rConversionMap );
50 virtual ~SwXFlatParagraph() override;
52 // XPropertySet
53 virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL
54 getPropertySetInfo() override;
55 virtual void SAL_CALL setPropertyValue(
56 const OUString& rPropertyName,
57 const css::uno::Any& rValue) override;
58 virtual css::uno::Any SAL_CALL getPropertyValue(
59 const OUString& rPropertyName) override;
60 virtual void SAL_CALL addPropertyChangeListener(
61 const OUString& rPropertyName,
62 const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener) override;
63 virtual void SAL_CALL removePropertyChangeListener(
64 const OUString& rPropertyName,
65 const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener) override;
66 virtual void SAL_CALL addVetoableChangeListener(
67 const OUString& rPropertyName,
68 const css::uno::Reference< css::beans::XVetoableChangeListener >& xListener) override;
69 virtual void SAL_CALL removeVetoableChangeListener(
70 const OUString& rPropertyName,
71 const css::uno::Reference< css::beans::XVetoableChangeListener >& xListener) override;
73 // text::XTextMarkup:
74 virtual css::uno::Reference< css::container::XStringKeyMap > SAL_CALL getMarkupInfoContainer() override;
76 virtual void SAL_CALL commitStringMarkup(::sal_Int32 nType, const OUString & aIdentifier, ::sal_Int32 nStart, ::sal_Int32 nLength,
77 const css::uno::Reference< css::container::XStringKeyMap > & xMarkupInfoContainer) override;
79 virtual void SAL_CALL commitTextRangeMarkup(::sal_Int32 nType, const OUString & aIdentifier, const css::uno::Reference< css::text::XTextRange> & xRange,
80 const css::uno::Reference< css::container::XStringKeyMap > & xMarkupInfoContainer) override;
82 // text::XFlatParagraph:
83 virtual OUString SAL_CALL getText() override;
84 virtual sal_Bool SAL_CALL isModified() override;
85 virtual void SAL_CALL setChecked(::sal_Int32 nType, sal_Bool bVal) override;
86 virtual sal_Bool SAL_CALL isChecked(::sal_Int32 nType) override;
87 virtual css::lang::Locale SAL_CALL getLanguageOfText(::sal_Int32 nPos, ::sal_Int32 nLen) override;
88 virtual css::lang::Locale SAL_CALL getPrimaryLanguageOfText(::sal_Int32 nPos, ::sal_Int32 nLen) override;
89 virtual void SAL_CALL changeText(::sal_Int32 nPos, ::sal_Int32 nLen, const OUString & aNewText, const css::uno::Sequence< css::beans::PropertyValue > & aAttributes) override;
90 virtual void SAL_CALL changeAttributes(::sal_Int32 nPos, ::sal_Int32 nLen, const css::uno::Sequence< css::beans::PropertyValue > & aAttributes) override;
91 virtual css::uno::Sequence< ::sal_Int32 > SAL_CALL getLanguagePortions() override;
93 using SwXTextMarkup::GetTextNode;
95 private:
96 SwXFlatParagraph( const SwXFlatParagraph & ) = delete;
97 SwXFlatParagraph & operator = ( const SwXFlatParagraph & ) = delete;
99 OUString maExpandText;
100 OUString maOrigText;
103 class SwXFlatParagraphIterator final :
104 public ::cppu::WeakImplHelper
106 css::text::XFlatParagraphIterator
108 public SvtListener
110 public:
111 SwXFlatParagraphIterator( SwDoc& rDoc, sal_Int32 nType, bool bAutomatic );
112 virtual ~SwXFlatParagraphIterator() override;
114 // text::XFlatParagraphIterator:
115 virtual css::uno::Reference< css::text::XFlatParagraph > SAL_CALL getFirstPara() override;
116 virtual css::uno::Reference< css::text::XFlatParagraph > SAL_CALL getNextPara() override;
117 virtual css::uno::Reference< css::text::XFlatParagraph > SAL_CALL getLastPara() override;
118 virtual css::uno::Reference< css::text::XFlatParagraph > SAL_CALL getParaBefore(const css::uno::Reference< css::text::XFlatParagraph > & xPara) override;
119 virtual css::uno::Reference< css::text::XFlatParagraph > SAL_CALL getParaAfter(const css::uno::Reference< css::text::XFlatParagraph > & xPara) override;
121 virtual void Notify( const SfxHint& ) override;
123 private:
124 SwXFlatParagraphIterator( const SwXFlatParagraphIterator & ) = delete;
125 SwXFlatParagraphIterator & operator =(const SwXFlatParagraphIterator & ) = delete;
127 SwDoc* mpDoc;
128 const sal_Int32 mnType;
129 const bool mbAutomatic;
131 SwNodeOffset mnCurrentNode; // used for non-automatic mode
132 SwNodeOffset mnEndNode; // used for non-automatic mode
135 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */