LibreOffice Module sw (master)  1
unotextcursor.hxx
Go to the documentation of this file.
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;
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
67 
68 class SwXTextCursor final
69  : public SwXTextCursor_Base
70  , public OTextCursorHelper
71 {
72 
73 private:
74 
77  const css::uno::Reference< css::text::XText > m_xParentText;
79 
81  if(!m_pUnoCursor)
82  throw css::uno::RuntimeException("SwXTextCursor: disposed or invalid", nullptr);
83  return *m_pUnoCursor;
84  }
85 
86  virtual ~SwXTextCursor() override;
87 
88 public:
89 
91  SwDoc & rDoc,
92  css::uno::Reference< css::text::XText > const& xParent,
93  const CursorType eType,
94  SwPosition const& rPos,
95  SwPosition const*const pMark = nullptr);
97  css::uno::Reference< css::text::XText > const& xParent,
98  SwPaM const& rSourceCursor,
99  const CursorType eType = CursorType::All);
100 
102  bool IsAtEndOfMeta() const;
103 
104  void DeleteAndInsert(OUString const& rText,
105  const bool bForceExpandHints);
106 
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 
114 
115  static const css::uno::Sequence< sal_Int8 >& getUnoTunnelId();
116 
117  // XUnoTunnel
118  virtual sal_Int64 SAL_CALL getSomething(
119  const css::uno::Sequence< sal_Int8 >& rIdentifier) override;
120 
121  // XServiceInfo
122  virtual OUString SAL_CALL getImplementationName() override;
123  virtual sal_Bool SAL_CALL supportsService(
124  const OUString& rServiceName) override;
125  virtual css::uno::Sequence< OUString > SAL_CALL
126  getSupportedServiceNames() override;
127 
128  // XPropertySet
129  virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL
130  getPropertySetInfo() override;
131  virtual void SAL_CALL setPropertyValue(
132  const OUString& rPropertyName,
133  const css::uno::Any& rValue) override;
134  virtual css::uno::Any SAL_CALL getPropertyValue(
135  const OUString& rPropertyName) override;
136  virtual void SAL_CALL addPropertyChangeListener(
137  const OUString& rPropertyName,
138  const css::uno::Reference<
139  css::beans::XPropertyChangeListener >& xListener) override;
140  virtual void SAL_CALL removePropertyChangeListener(
141  const OUString& rPropertyName,
142  const css::uno::Reference<
143  css::beans::XPropertyChangeListener >& xListener) override;
144  virtual void SAL_CALL addVetoableChangeListener(
145  const OUString& rPropertyName,
146  const css::uno::Reference<
147  css::beans::XVetoableChangeListener >& xListener) override;
148  virtual void SAL_CALL removeVetoableChangeListener(
149  const OUString& rPropertyName,
150  const css::uno::Reference<
151  css::beans::XVetoableChangeListener >& xListener) override;
152 
153  // XPropertyState
154  virtual css::beans::PropertyState SAL_CALL
155  getPropertyState(const OUString& rPropertyName) override;
156  virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL
158  const css::uno::Sequence< OUString >& rPropertyNames) override;
159  virtual void SAL_CALL setPropertyToDefault(
160  const OUString& rPropertyName) override;
161  virtual css::uno::Any SAL_CALL getPropertyDefault(
162  const OUString& rPropertyName) override;
163 
164  // XMultiPropertySet
165  virtual void SAL_CALL setPropertyValues(
166  const css::uno::Sequence< OUString >& aPropertyNames,
167  const css::uno::Sequence< css::uno::Any >& aValues ) override;
168 
169  virtual css::uno::Sequence< css::uno::Any > SAL_CALL
170  getPropertyValues( const css::uno::Sequence< OUString >& aPropertyNames ) override;
171 
172  virtual void SAL_CALL addPropertiesChangeListener(
173  const css::uno::Sequence< OUString >& aPropertyNames,
174  const css::uno::Reference< css::beans::XPropertiesChangeListener >& xListener ) override;
175 
176  virtual void SAL_CALL removePropertiesChangeListener(
177  const css::uno::Reference< css::beans::XPropertiesChangeListener >& xListener ) override;
178 
179  virtual void SAL_CALL firePropertiesChangeEvent(
180  const css::uno::Sequence< OUString >& aPropertyNames,
181  const css::uno::Reference< css::beans::XPropertiesChangeListener >& xListener ) override;
182 
183  // XMultiPropertyStates
184  virtual void SAL_CALL setAllPropertiesToDefault() override;
185  virtual void SAL_CALL setPropertiesToDefault(
186  const css::uno::Sequence< OUString >& rPropertyNames) override;
187  virtual css::uno::Sequence< css::uno::Any >
188  SAL_CALL getPropertyDefaults(
189  const css::uno::Sequence< OUString >& rPropertyNames) override;
190 
191  // XElementAccess
192  virtual css::uno::Type SAL_CALL getElementType() override;
193  virtual sal_Bool SAL_CALL hasElements() override;
194 
195  // XEnumerationAccess
196  virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL
197  createEnumeration() override;
198 
199  // XContentEnumerationAccess
200  virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL
201  createContentEnumeration(const OUString& rServiceName) override;
202  virtual css::uno::Sequence< OUString > SAL_CALL
203  getAvailableServiceNames() override;
204 
205  // XSortable
206  virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL
207  createSortDescriptor() override;
208  virtual void SAL_CALL sort(
209  const css::uno::Sequence< css::beans::PropertyValue >& xDescriptor) override;
210 
211  // XDocumentInsertable
212  virtual void SAL_CALL insertDocumentFromURL(
213  const OUString& rURL,
214  const css::uno::Sequence< css::beans::PropertyValue >& rOptions) override;
215 
216  // XTextRange
217  virtual css::uno::Reference< css::text::XText >
218  SAL_CALL getText() override;
219  virtual css::uno::Reference< css::text::XTextRange > SAL_CALL getStart() override;
220  virtual css::uno::Reference< css::text::XTextRange > SAL_CALL getEnd() override;
221  virtual OUString SAL_CALL getString() override;
222  virtual void SAL_CALL setString(const OUString& rString) override;
223 
224  // XTextCursor
225  virtual void SAL_CALL collapseToStart() override;
226  virtual void SAL_CALL collapseToEnd() override;
227  virtual sal_Bool SAL_CALL isCollapsed() override;
228  virtual sal_Bool SAL_CALL goLeft(sal_Int16 nCount, sal_Bool bExpand) override;
229  virtual sal_Bool SAL_CALL goRight(sal_Int16 nCount, sal_Bool bExpand) override;
230  virtual void SAL_CALL gotoStart(sal_Bool bExpand) override;
231  virtual void SAL_CALL gotoEnd(sal_Bool bExpand) override;
232  virtual void SAL_CALL gotoRange(
233  const css::uno::Reference< css::text::XTextRange >& xRange,
234  sal_Bool bExpand) override;
235 
236  // XWordCursor
237  virtual sal_Bool SAL_CALL isStartOfWord() override;
238  virtual sal_Bool SAL_CALL isEndOfWord() override;
239  virtual sal_Bool SAL_CALL gotoNextWord(sal_Bool bExpand) override;
240  virtual sal_Bool SAL_CALL gotoPreviousWord(sal_Bool bExpand) override;
241  virtual sal_Bool SAL_CALL gotoEndOfWord(sal_Bool bExpand) override;
242  virtual sal_Bool SAL_CALL gotoStartOfWord(sal_Bool bExpand) override;
243 
244  // XSentenceCursor
245  virtual sal_Bool SAL_CALL isStartOfSentence() override;
246  virtual sal_Bool SAL_CALL isEndOfSentence() override;
247  virtual sal_Bool SAL_CALL gotoNextSentence(sal_Bool Expand) override;
248  virtual sal_Bool SAL_CALL gotoPreviousSentence(sal_Bool Expand) override;
249  virtual sal_Bool SAL_CALL gotoStartOfSentence(sal_Bool Expand) override;
250  virtual sal_Bool SAL_CALL gotoEndOfSentence(sal_Bool Expand) override;
251 
252  // XParagraphCursor
253  virtual sal_Bool SAL_CALL isStartOfParagraph() override;
254  virtual sal_Bool SAL_CALL isEndOfParagraph() override;
255  virtual sal_Bool SAL_CALL gotoStartOfParagraph(sal_Bool Expand) override;
256  virtual sal_Bool SAL_CALL gotoEndOfParagraph(sal_Bool Expand) override;
257  virtual sal_Bool SAL_CALL gotoNextParagraph(sal_Bool Expand) override;
258  virtual sal_Bool SAL_CALL gotoPreviousParagraph(sal_Bool Expand) override;
259 
260  // XRedline
261  virtual void SAL_CALL makeRedline(
262  const OUString& rRedlineType,
263  const css::uno::Sequence< css::beans::PropertyValue >& RedlineProperties) override;
264 
265  //XMarkingAccess
266  virtual void SAL_CALL invalidateMarkings(::sal_Int32 nType) override;
267 
268 };
269 
270 #endif // INCLUDED_SW_INC_UNOTEXTCURSOR_HXX
271 
272 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual void SAL_CALL invalidateMarkings(::sal_Int32 nType) override
Definition: unoobj.cxx:2426
sw::UnoCursorPointer m_pUnoCursor
Type
virtual void SAL_CALL firePropertiesChangeEvent(const css::uno::Sequence< OUString > &aPropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > &xListener) override
Definition: unoobj.cxx:2260
virtual sal_Bool SAL_CALL goLeft(sal_Int16 nCount, sal_Bool bExpand) override
Definition: unoobj.cxx:909
virtual OUString SAL_CALL getImplementationName() override
Definition: unoobj.cxx:825
virtual sal_Bool SAL_CALL gotoEndOfSentence(sal_Bool Expand) override
Definition: unoobj.cxx:1487
Marks a position in the document model.
Definition: pam.hxx:35
virtual sal_Bool SAL_CALL gotoStartOfParagraph(sal_Bool Expand) override
Definition: unoobj.cxx:1533
::cppu::WeakImplHelper< css::lang::XServiceInfo, css::beans::XPropertySet, css::beans::XPropertyState, css::beans::XMultiPropertySet, css::beans::XMultiPropertyStates, css::container::XEnumerationAccess, css::container::XContentEnumerationAccess, css::util::XSortable, css::document::XDocumentInsertable, css::text::XSentenceCursor, css::text::XWordCursor, css::text::XParagraphCursor, css::text::XRedline, css::text::XMarkingAccess > SwXTextCursor_Base
virtual css::uno::Type SAL_CALL getElementType() override
Definition: unoobj.cxx:2874
virtual sal_Bool SAL_CALL isStartOfParagraph() override
Definition: unoobj.cxx:1511
virtual sal_Bool SAL_CALL goRight(sal_Int16 nCount, sal_Bool bExpand) override
Definition: unoobj.cxx:927
CursorType
virtual sal_Bool SAL_CALL isEndOfWord() override
Definition: unoobj.cxx:1183
signed char sal_Int8
virtual const SwDoc * GetDoc() const override
Definition: unoobj.cxx:667
virtual sal_Bool SAL_CALL gotoPreviousWord(sal_Bool bExpand) override
Definition: unoobj.cxx:1242
Definition: doc.hxx:188
virtual sal_Int64 SAL_CALL getSomething(const css::uno::Sequence< sal_Int8 > &rIdentifier) override
Definition: unoobj.cxx:857
virtual void SAL_CALL addVetoableChangeListener(const OUString &rPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &xListener) override
Definition: unoobj.cxx:2142
void DeleteAndInsert(OUString const &rText, const bool bForceExpandHints)
Definition: unoobj.cxx:711
bool IsAtEndOfMeta() const
Definition: unoobj.cxx:795
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo() override
Definition: unoobj.cxx:2043
virtual css::uno::Reference< css::text::XText > SAL_CALL getText() override
Definition: unoobj.cxx:1615
virtual sal_Bool SAL_CALL gotoPreviousSentence(sal_Bool Expand) override
Definition: unoobj.cxx:1436
virtual css::uno::Reference< css::text::XTextRange > SAL_CALL getStart() override
Definition: unoobj.cxx:1623
virtual sal_Bool SAL_CALL gotoNextWord(sal_Bool bExpand) override
Definition: unoobj.cxx:1195
virtual void SAL_CALL setPropertyToDefault(const OUString &rPropertyName) override
Definition: unoobj.cxx:2182
virtual void SAL_CALL sort(const css::uno::Sequence< css::beans::PropertyValue > &xDescriptor) override
Definition: unoobj.cxx:2795
virtual sal_Bool SAL_CALL gotoStartOfSentence(sal_Bool Expand) override
Definition: unoobj.cxx:1464
virtual void SAL_CALL collapseToStart() override
Definition: unoobj.cxx:863
virtual sal_Bool SAL_CALL gotoEndOfWord(sal_Bool bExpand) override
Definition: unoobj.cxx:1282
const CursorType m_eType
virtual sal_Bool SAL_CALL isEndOfParagraph() override
Definition: unoobj.cxx:1522
SwUnoCursor & GetCursorOrThrow()
const SfxItemPropertySet & m_rPropSet
virtual css::uno::Reference< css::text::XTextRange > SAL_CALL getEnd() override
Definition: unoobj.cxx:1649
virtual css::uno::Sequence< OUString > SAL_CALL getAvailableServiceNames() override
Definition: unoobj.cxx:2885
SwXTextCursor(SwDoc &rDoc, css::uno::Reference< css::text::XText > const &xParent, const CursorType eType, SwPosition const &rPos, SwPosition const *const pMark=nullptr)
virtual sal_Bool SAL_CALL hasElements() override
Definition: unoobj.cxx:2879
virtual void SAL_CALL setString(const OUString &rString) override
Definition: unoobj.cxx:1686
virtual sal_Bool SAL_CALL gotoNextSentence(sal_Bool Expand) override
Definition: unoobj.cxx:1401
virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL createSortDescriptor() override
Definition: unoobj.cxx:2536
virtual void SAL_CALL addPropertyChangeListener(const OUString &rPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &xListener) override
Definition: unoobj.cxx:2126
PaM is Point and Mark: a selection of the document model.
Definition: pam.hxx:136
virtual void SAL_CALL setPropertiesToDefault(const css::uno::Sequence< OUString > &rPropertyNames) override
Definition: unoobj.cxx:2323
virtual OUString SAL_CALL getString() override
Definition: unoobj.cxx:1674
virtual css::beans::PropertyState SAL_CALL getPropertyState(const OUString &rPropertyName) override
Definition: unoobj.cxx:2158
virtual ~SwXTextCursor() override
Definition: unoobj.cxx:705
virtual const SwPaM * GetPaM() const override
Definition: unoobj.cxx:661
virtual void SAL_CALL gotoStart(sal_Bool bExpand) override
Definition: unoobj.cxx:945
virtual sal_Bool SAL_CALL isCollapsed() override
Definition: unoobj.cxx:895
unsigned char sal_Bool
virtual sal_Bool SAL_CALL isStartOfSentence() override
Definition: unoobj.cxx:1354
virtual void SAL_CALL gotoRange(const css::uno::Reference< css::text::XTextRange > &xRange, sal_Bool bExpand) override
Definition: unoobj.cxx:1030
virtual void SAL_CALL makeRedline(const OUString &rRedlineType, const css::uno::Sequence< css::beans::PropertyValue > &RedlineProperties) override
Definition: unoobj.cxx:2464
virtual sal_Bool SAL_CALL gotoPreviousParagraph(sal_Bool Expand) override
Definition: unoobj.cxx:1599
virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL getPropertyStates(const css::uno::Sequence< OUString > &rPropertyNames) override
Definition: unoobj.cxx:2170
virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPropertyValues(const css::uno::Sequence< OUString > &aPropertyNames) override
Definition: unoobj.cxx:2239
virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createEnumeration() override
Definition: unoobj.cxx:2849
SwUnoCursor & GetCursor()
Definition: unoobj.cxx:658
virtual sal_Bool SAL_CALL gotoStartOfWord(sal_Bool bExpand) override
Definition: unoobj.cxx:1318
virtual void SAL_CALL setPropertyValue(const OUString &rPropertyName, const css::uno::Any &rValue) override
Definition: unoobj.cxx:2067
virtual void SAL_CALL insertDocumentFromURL(const OUString &rURL, const css::uno::Sequence< css::beans::PropertyValue > &rOptions) override
Definition: unoobj.cxx:2475
virtual void SAL_CALL addPropertiesChangeListener(const css::uno::Sequence< OUString > &aPropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > &xListener) override
Definition: unoobj.cxx:2248
static const css::uno::Sequence< sal_Int8 > & getUnoTunnelId()
Definition: unoobj.cxx:850
virtual sal_Bool SAL_CALL gotoEndOfParagraph(sal_Bool Expand) override
Definition: unoobj.cxx:1558
virtual sal_Bool SAL_CALL isEndOfSentence() override
Definition: unoobj.cxx:1377
virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createContentEnumeration(const OUString &rServiceName) override
Definition: unoobj.cxx:2839
virtual void SAL_CALL collapseToEnd() override
Definition: unoobj.cxx:879
virtual void SAL_CALL setPropertyValues(const css::uno::Sequence< OUString > &aPropertyNames, const css::uno::Sequence< css::uno::Any > &aValues) override
Definition: unoobj.cxx:2197
virtual void SAL_CALL setAllPropertiesToDefault() override
Definition: unoobj.cxx:2301
virtual void SAL_CALL removePropertiesChangeListener(const css::uno::Reference< css::beans::XPropertiesChangeListener > &xListener) override
Definition: unoobj.cxx:2254
virtual sal_Bool SAL_CALL gotoNextParagraph(sal_Bool Expand) override
Definition: unoobj.cxx:1583
virtual void SAL_CALL removeVetoableChangeListener(const OUString &rPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &xListener) override
Definition: unoobj.cxx:2150
const css::uno::Reference< css::text::XText > m_xParentText
virtual sal_Bool SAL_CALL supportsService(const OUString &rServiceName) override
Definition: unoobj.cxx:830
virtual css::uno::Any SAL_CALL getPropertyValue(const OUString &rPropertyName) override
Definition: unoobj.cxx:2100
virtual void SAL_CALL removePropertyChangeListener(const OUString &rPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &xListener) override
Definition: unoobj.cxx:2134
virtual sal_Bool SAL_CALL isStartOfWord() override
Definition: unoobj.cxx:1172
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
Definition: unoobj.cxx:836
virtual css::uno::Any SAL_CALL getPropertyDefault(const OUString &rPropertyName) override
Definition: unoobj.cxx:2190
virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPropertyDefaults(const css::uno::Sequence< OUString > &rPropertyNames) override
Definition: unoobj.cxx:2386
virtual void SAL_CALL gotoEnd(sal_Bool bExpand) override
Definition: unoobj.cxx:1002
#define DECLARE_XINTERFACE()