sw/inc/unotextcursor.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_SW_INC_UNOTEXTCURSOR_HXX
  21 #define INCLUDED_SW_INC_UNOTEXTCURSOR_HXX
  22
  23 #include <com/sun/star/lang/XServiceInfo.hpp>
  24 #include <com/sun/star/beans/XPropertySet.hpp>
  25 #include <com/sun/star/beans/XPropertyState.hpp>
  26 #include <com/sun/star/beans/XMultiPropertySet.hpp>
  27 #include <com/sun/star/beans/XMultiPropertyStates.hpp>
  28 #include <com/sun/star/container/XEnumerationAccess.hpp>
  29 #include <com/sun/star/container/XContentEnumerationAccess.hpp>
  30 #include <com/sun/star/util/XSortable.hpp>
  31 #include <com/sun/star/document/XDocumentInsertable.hpp>
  32 #include <com/sun/star/text/XSentenceCursor.hpp>
  33 #include <com/sun/star/text/XWordCursor.hpp>
  34 #include <com/sun/star/text/XParagraphCursor.hpp>
  35 #include <com/sun/star/text/XRedline.hpp>
  36 #include <com/sun/star/text/XMarkingAccess.hpp>
  37
  38 #include <cppuhelper/implbase.hxx>
  39
  40 #include <comphelper/uno3.hxx>
  41
  42 #include "unobaseclass.hxx"
  43 #include "TextCursorHelper.hxx"
  44 #include "unocrsr.hxx"
  45
  46 class SwDoc;
  47 struct SwPosition;
  48 class SwUnoCursor;
  49 class SfxItemPropertySet;
  50
  51 typedef ::cppu::WeakImplHelper
  52 <   css::lang::XServiceInfo
  53 ,   css::beans::XPropertySet
  54 ,   css::beans::XPropertyState
  55 ,   css::beans::XMultiPropertySet
  56 ,   css::beans::XMultiPropertyStates
  57 ,   css::container::XEnumerationAccess
  58 ,   css::container::XContentEnumerationAccess
  59 ,   css::util::XSortable
  60 ,   css::document::XDocumentInsertable
  61 ,   css::text::XSentenceCursor
  62 ,   css::text::XWordCursor
  63 ,   css::text::XParagraphCursor
  64 ,   css::text::XRedline
  65 ,   css::text::XMarkingAccess
  66 > SwXTextCursor_Base;
  67
  68 class SwXTextCursor final
  69     : public SwXTextCursor_Base
  70     , public OTextCursorHelper
  71 {
  72
  73 private:
  74
  75     const SfxItemPropertySet &  m_rPropSet;
  76     const CursorType            m_eType;
  77     const css::uno::Reference< css::text::XText > m_xParentText;
  78     sw::UnoCursorPointer m_pUnoCursor;
  79     SetAttrMode m_nAttrMode = SetAttrMode::DEFAULT;
  80
  81     SwUnoCursor& GetCursorOrThrow() {
  82         if(!m_pUnoCursor)
  83             throw css::uno::RuntimeException("SwXTextCursor: disposed or invalid", nullptr);
  84         return *m_pUnoCursor;
  85     }
  86
  87     virtual ~SwXTextCursor() override;
  88
  89 public:
  90
  91     SwXTextCursor(
  92             SwDoc & rDoc,
  93             css::uno::Reference< css::text::XText > xParent,
  94             const CursorType eType,
  95             SwPosition const& rPos,
  96             SwPosition const*const pMark = nullptr);
  97     SwXTextCursor(
  98             css::uno::Reference< css::text::XText > xParent,
  99             SwPaM const& rSourceCursor,
 100             const CursorType eType = CursorType::All);
 101
 102     SwUnoCursor& GetCursor();
 103     bool IsAtEndOfMeta() const;
 104     bool IsAtEndOfContentControl() const;
 105
 106     void DeleteAndInsert(std::u16string_view aText, ::sw::DeleteAndInsertMode eMode);
 107     // OTextCursorHelper
 108     virtual const SwPaM*        GetPaM() const override;
 109     virtual SwPaM*              GetPaM() override;
 110     virtual const SwDoc*        GetDoc() const override;
 111     virtual SwDoc*              GetDoc() override;
 112
 113     // XServiceInfo
 114     virtual OUString SAL_CALL getImplementationName() override;
 115     virtual sal_Bool SAL_CALL supportsService(
 116             const OUString& rServiceName) override;
 117     virtual css::uno::Sequence< OUString > SAL_CALL
 118         getSupportedServiceNames() override;
 119
 120     // XPropertySet
 121     virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL
 122         getPropertySetInfo() override;
 123     virtual void SAL_CALL setPropertyValue(
 124             const OUString& rPropertyName,
 125             const css::uno::Any& rValue) override;
 126     virtual css::uno::Any SAL_CALL getPropertyValue(
 127             const OUString& rPropertyName) override;
 128     virtual void SAL_CALL addPropertyChangeListener(
 129             const OUString& rPropertyName,
 130             const css::uno::Reference<
 131                 css::beans::XPropertyChangeListener >& xListener) override;
 132     virtual void SAL_CALL removePropertyChangeListener(
 133             const OUString& rPropertyName,
 134             const css::uno::Reference<
 135                 css::beans::XPropertyChangeListener >& xListener) override;
 136     virtual void SAL_CALL addVetoableChangeListener(
 137             const OUString& rPropertyName,
 138             const css::uno::Reference<
 139                 css::beans::XVetoableChangeListener >& xListener) override;
 140     virtual void SAL_CALL removeVetoableChangeListener(
 141             const OUString& rPropertyName,
 142             const css::uno::Reference<
 143                 css::beans::XVetoableChangeListener >& xListener) override;
 144
 145     // XPropertyState
 146     virtual css::beans::PropertyState SAL_CALL
 147         getPropertyState(const OUString& rPropertyName) override;
 148     virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL
 149         getPropertyStates(
 150             const css::uno::Sequence< OUString >& rPropertyNames) override;
 151     virtual void SAL_CALL setPropertyToDefault(
 152             const OUString& rPropertyName) override;
 153     virtual css::uno::Any SAL_CALL getPropertyDefault(
 154             const OUString& rPropertyName) override;
 155
 156     // XMultiPropertySet
 157     virtual void SAL_CALL setPropertyValues(
 158             const css::uno::Sequence< OUString >& aPropertyNames,
 159             const css::uno::Sequence< css::uno::Any >& aValues ) override;
 160
 161     virtual css::uno::Sequence< css::uno::Any > SAL_CALL
 162         getPropertyValues( const css::uno::Sequence< OUString >& aPropertyNames ) override;
 163
 164     virtual void SAL_CALL addPropertiesChangeListener(
 165         const css::uno::Sequence< OUString >& aPropertyNames,
 166         const css::uno::Reference< css::beans::XPropertiesChangeListener >& xListener ) override;
 167
 168     virtual void SAL_CALL removePropertiesChangeListener(
 169         const css::uno::Reference< css::beans::XPropertiesChangeListener >& xListener ) override;
 170
 171     virtual void SAL_CALL firePropertiesChangeEvent(
 172         const css::uno::Sequence< OUString >& aPropertyNames,
 173         const css::uno::Reference< css::beans::XPropertiesChangeListener >& xListener ) override;
 174
 175     // XMultiPropertyStates
 176     virtual void SAL_CALL setAllPropertiesToDefault() override;
 177     virtual void SAL_CALL setPropertiesToDefault(
 178             const css::uno::Sequence< OUString >&  rPropertyNames) override;
 179     virtual css::uno::Sequence< css::uno::Any >
 180         SAL_CALL getPropertyDefaults(
 181             const css::uno::Sequence< OUString >&  rPropertyNames) override;
 182
 183     // XElementAccess
 184     virtual css::uno::Type SAL_CALL getElementType() override;
 185     virtual sal_Bool SAL_CALL hasElements() override;
 186
 187     // XEnumerationAccess
 188     virtual css::uno::Reference< css::container::XEnumeration >  SAL_CALL
 189         createEnumeration() override;
 190
 191     // XContentEnumerationAccess
 192     virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL
 193         createContentEnumeration(const OUString& rServiceName) override;
 194     virtual css::uno::Sequence< OUString > SAL_CALL
 195         getAvailableServiceNames() override;
 196
 197     // XSortable
 198     virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL
 199         createSortDescriptor() override;
 200     virtual void SAL_CALL sort(
 201             const css::uno::Sequence< css::beans::PropertyValue >& xDescriptor) override;
 202
 203     // XDocumentInsertable
 204     virtual void SAL_CALL insertDocumentFromURL(
 205             const OUString& rURL,
 206             const css::uno::Sequence< css::beans::PropertyValue >& rOptions) override;
 207
 208     // XTextRange
 209     virtual css::uno::Reference< css::text::XText >
 210         SAL_CALL getText() override;
 211     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL getStart() override;
 212     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL getEnd() override;
 213     virtual OUString SAL_CALL getString() override;
 214     virtual void SAL_CALL setString(const OUString& rString) override;
 215
 216     // XTextCursor
 217     virtual void SAL_CALL collapseToStart() override;
 218     virtual void SAL_CALL collapseToEnd() override;
 219     virtual sal_Bool SAL_CALL isCollapsed() override;
 220     virtual sal_Bool SAL_CALL goLeft(sal_Int16 nCount, sal_Bool bExpand) override;
 221     virtual sal_Bool SAL_CALL goRight(sal_Int16 nCount, sal_Bool bExpand) override;
 222     virtual void SAL_CALL gotoStart(sal_Bool bExpand) override;
 223     virtual void SAL_CALL gotoEnd(sal_Bool bExpand) override;
 224     virtual void SAL_CALL gotoRange(
 225             const css::uno::Reference< css::text::XTextRange >& xRange,
 226             sal_Bool bExpand) override;
 227
 228     // XWordCursor
 229     virtual sal_Bool SAL_CALL isStartOfWord() override;
 230     virtual sal_Bool SAL_CALL isEndOfWord() override;
 231     virtual sal_Bool SAL_CALL gotoNextWord(sal_Bool bExpand) override;
 232     virtual sal_Bool SAL_CALL gotoPreviousWord(sal_Bool bExpand) override;
 233     virtual sal_Bool SAL_CALL gotoEndOfWord(sal_Bool bExpand) override;
 234     virtual sal_Bool SAL_CALL gotoStartOfWord(sal_Bool bExpand) override;
 235
 236     // XSentenceCursor
 237     virtual sal_Bool SAL_CALL isStartOfSentence() override;
 238     virtual sal_Bool SAL_CALL isEndOfSentence() override;
 239     virtual sal_Bool SAL_CALL gotoNextSentence(sal_Bool Expand) override;
 240     virtual sal_Bool SAL_CALL gotoPreviousSentence(sal_Bool Expand) override;
 241     virtual sal_Bool SAL_CALL gotoStartOfSentence(sal_Bool Expand) override;
 242     virtual sal_Bool SAL_CALL gotoEndOfSentence(sal_Bool Expand) override;
 243
 244     // XParagraphCursor
 245     virtual sal_Bool SAL_CALL isStartOfParagraph() override;
 246     virtual sal_Bool SAL_CALL isEndOfParagraph() override;
 247     virtual sal_Bool SAL_CALL gotoStartOfParagraph(sal_Bool Expand) override;
 248     virtual sal_Bool SAL_CALL gotoEndOfParagraph(sal_Bool Expand) override;
 249     virtual sal_Bool SAL_CALL gotoNextParagraph(sal_Bool Expand) override;
 250     virtual sal_Bool SAL_CALL gotoPreviousParagraph(sal_Bool Expand) override;
 251
 252     // XRedline
 253     virtual void SAL_CALL makeRedline(
 254             const OUString& rRedlineType,
 255             const css::uno::Sequence< css::beans::PropertyValue >& RedlineProperties) override;
 256
 257     //XMarkingAccess
 258     virtual void SAL_CALL invalidateMarkings(::sal_Int32 nType) override;
 259
 260 };
 261
 262 #endif // INCLUDED_SW_INC_UNOTEXTCURSOR_HXX
 263
 264 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */