sc/inc/textuno.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 #pragma once
  21
  22 #include "address.hxx"
  23 #include <editeng/unotext.hxx>
  24 #include <svl/lstner.hxx>
  25 #include <com/sun/star/text/XTextFieldsSupplier.hpp>
  26 #include <com/sun/star/sheet/XHeaderFooterContent.hpp>
  27 #include <com/sun/star/lang/XServiceInfo.hpp>
  28 #include <comphelper/servicehelper.hxx>
  29 #include <cppuhelper/implbase.hxx>
  30 #include <cppuhelper/weakref.hxx>
  31
  32 #include <rtl/ref.hxx>
  33
  34 #include <memory>
  35
  36 class EditEngine;
  37 class EditTextObject;
  38 class SvxEditEngineForwarder;
  39 class ScDocShell;
  40 class ScCellObj;
  41 class ScSimpleEditSource;
  42 class ScCellEditSource;
  43 class ScEditEngineDefaulter;
  44 class ScFieldEditEngine;
  45 class ScHeaderFooterTextObj;
  46
  47 struct ScHeaderFieldData;
  48
  49 enum class ScHeaderFooterPart{ LEFT, CENTER, RIGHT };
  50
  51 //  ScHeaderFooterContentObj is a dumb container which must be re-written into
  52 //  the page template using setPropertyValue
  53
  54 class ScHeaderFooterContentObj final : public cppu::WeakImplHelper<
  55                             css::sheet::XHeaderFooterContent,
  56                             css::lang::XServiceInfo >
  57 {
  58 private:
  59     rtl::Reference<ScHeaderFooterTextObj> mxLeftText;
  60     rtl::Reference<ScHeaderFooterTextObj> mxCenterText;
  61     rtl::Reference<ScHeaderFooterTextObj> mxRightText;
  62
  63 public:
  64                             ScHeaderFooterContentObj();
  65     virtual                 ~ScHeaderFooterContentObj() override;
  66
  67                             // for ScPageHFItem (using getImplementation)
  68     const EditTextObject* GetLeftEditObject() const;
  69     const EditTextObject* GetCenterEditObject() const;
  70     const EditTextObject* GetRightEditObject() const;
  71
  72     void Init( const EditTextObject* pLeft,
  73                               const EditTextObject* pCenter,
  74                               const EditTextObject* pRight);
  75
  76                             // XHeaderFooterContent
  77     virtual css::uno::Reference< css::text::XText > SAL_CALL
  78                             getLeftText() override;
  79     virtual css::uno::Reference< css::text::XText > SAL_CALL
  80                             getCenterText() override;
  81     virtual css::uno::Reference< css::text::XText > SAL_CALL
  82                             getRightText() override;
  83
  84     static rtl::Reference<ScHeaderFooterContentObj> getImplementation(const css::uno::Reference<css::sheet::XHeaderFooterContent>& rObj);
  85
  86                             // XServiceInfo
  87     virtual OUString SAL_CALL getImplementationName() override;
  88     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
  89     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
  90
  91 };
  92
  93 //  ScHeaderFooterTextData: shared data between sub objects of a ScHeaderFooterTextObj
  94
  95 class ScHeaderFooterTextData
  96 {
  97 private:
  98     std::unique_ptr<EditTextObject> mpTextObj;
  99     css::uno::WeakReference<css::sheet::XHeaderFooterContent> xContentObj;
 100     ScHeaderFooterPart          nPart;
 101     std::unique_ptr<ScEditEngineDefaulter>  pEditEngine;
 102     std::unique_ptr<SvxEditEngineForwarder> pForwarder;
 103     bool                        bDataValid;
 104
 105 public:
 106     ScHeaderFooterTextData(const ScHeaderFooterTextData&) = delete;
 107     const ScHeaderFooterTextData& operator=(const ScHeaderFooterTextData&) = delete;
 108     ScHeaderFooterTextData(
 109         css::uno::WeakReference<css::sheet::XHeaderFooterContent> xContent, ScHeaderFooterPart nP, const EditTextObject* pTextObj);
 110     ~ScHeaderFooterTextData();
 111
 112                             // helper functions
 113     SvxTextForwarder*       GetTextForwarder();
 114     void UpdateData();
 115     void UpdateData(EditEngine& rEditEngine);
 116     ScEditEngineDefaulter*  GetEditEngine() { GetTextForwarder(); return pEditEngine.get(); }
 117
 118     ScHeaderFooterPart      GetPart() const         { return nPart; }
 119     css::uno::Reference<css::sheet::XHeaderFooterContent> GetContentObj() const { return xContentObj; }
 120
 121     const EditTextObject* GetTextObject() const { return mpTextObj.get(); }
 122 };
 123
 124 /**
 125  * Each of these instances represent, the left, center or right part of the
 126  * header of footer of a page.
 127  *
 128  * ScHeaderFooterTextObj changes the text in a ScHeaderFooterContentObj.
 129  */
 130 class ScHeaderFooterTextObj final : public cppu::WeakImplHelper<
 131                             css::text::XText,
 132                             css::text::XTextRangeMover,
 133                             css::container::XEnumerationAccess,
 134                             css::text::XTextFieldsSupplier,
 135                             css::lang::XServiceInfo >
 136 {
 137 private:
 138     ScHeaderFooterTextData      aTextData;
 139     rtl::Reference<SvxUnoText> mxUnoText;
 140
 141     void                    CreateUnoText_Impl();
 142
 143 public:
 144     ScHeaderFooterTextObj(
 145         const css::uno::WeakReference<css::sheet::XHeaderFooterContent>& xContent, ScHeaderFooterPart nP, const EditTextObject* pTextObj);
 146     virtual ~ScHeaderFooterTextObj() override;
 147
 148     const EditTextObject* GetTextObject() const;
 149     const SvxUnoText&       GetUnoText();
 150
 151     static void             FillDummyFieldData( ScHeaderFieldData& rData );
 152
 153                             // XText
 154     virtual void SAL_CALL   insertTextContent( const css::uno::Reference< css::text::XTextRange >& xRange,
 155                                 const css::uno::Reference< css::text::XTextContent >& xContent,
 156                                 sal_Bool bAbsorb ) override;
 157     virtual void SAL_CALL   removeTextContent( const css::uno::Reference< css::text::XTextContent >& xContent ) override;
 158
 159                             // XSimpleText
 160     virtual css::uno::Reference< css::text::XTextCursor > SAL_CALL
 161                             createTextCursor() override;
 162     virtual css::uno::Reference< css::text::XTextCursor > SAL_CALL
 163                             createTextCursorByRange( const css::uno::Reference< css::text::XTextRange >& aTextPosition ) override;
 164     virtual void SAL_CALL   insertString( const css::uno::Reference< css::text::XTextRange >& xRange,
 165                                         const OUString& aString, sal_Bool bAbsorb ) override;
 166     virtual void SAL_CALL   insertControlCharacter( const css::uno::Reference< css::text::XTextRange >& xRange,
 167                                         sal_Int16 nControlCharacter, sal_Bool bAbsorb ) override;
 168
 169                             // XTextRange
 170     virtual css::uno::Reference< css::text::XText > SAL_CALL
 171                             getText() override;
 172     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL
 173                             getStart() override;
 174     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL
 175                             getEnd() override;
 176     virtual OUString SAL_CALL getString() override;
 177     virtual void SAL_CALL   setString( const OUString& aString ) override;
 178
 179                             // XTextRangeMover
 180     virtual void SAL_CALL   moveTextRange( const css::uno::Reference< css::text::XTextRange >& xRange,
 181                                         sal_Int16 nParagraphs ) override;
 182
 183                             // XEnumerationAccess
 184     virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL
 185                             createEnumeration() override;
 186
 187                             // XElementAccess
 188     virtual css::uno::Type SAL_CALL getElementType() override;
 189     virtual sal_Bool SAL_CALL hasElements() override;
 190
 191                             // XTextFieldsSupplier
 192     virtual css::uno::Reference< css::container::XEnumerationAccess > SAL_CALL
 193                             getTextFields() override;
 194     virtual css::uno::Reference< css::container::XNameAccess > SAL_CALL
 195                             getTextFieldMasters() override;
 196
 197                             // XServiceInfo
 198     virtual OUString SAL_CALL getImplementationName() override;
 199     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
 200     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 201
 202 };
 203
 204 //  derived cursor objects for getImplementation and getText/getStart/getEnd
 205
 206 //! uno3: SvxUnoTextCursor is not derived from XUnoTunnel, but should be (?)
 207
 208 class ScCellTextCursor final : public SvxUnoTextCursor
 209 {
 210     rtl::Reference<ScCellObj> mxTextObj;
 211
 212 public:
 213                             ScCellTextCursor(ScCellObj& rText);
 214         virtual             ~ScCellTextCursor() noexcept override;
 215
 216     ScCellTextCursor(ScCellTextCursor const &) = default;
 217     ScCellTextCursor(ScCellTextCursor &&) = default;
 218     ScCellTextCursor & operator =(ScCellTextCursor const &) = delete; // due to SvxUnoTextCursor
 219     ScCellTextCursor & operator =(ScCellTextCursor &&) = delete; // due to SvxUnoTextCursor
 220
 221     ScCellObj&              GetCellObj() const  { return *mxTextObj; }
 222
 223                             // SvxUnoTextCursor methods reimplemented here:
 224     virtual css::uno::Reference< css::text::XText > SAL_CALL
 225                             getText() override;
 226     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL
 227                             getStart() override;
 228     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL
 229                             getEnd() override;
 230
 231                             // XUnoTunnel
 232     UNO3_GETIMPLEMENTATION_DECL(ScCellTextCursor)
 233 };
 234
 235 class ScHeaderFooterTextCursor final : public SvxUnoTextCursor
 236 {
 237 private:
 238     rtl::Reference<ScHeaderFooterTextObj> rTextObj;
 239
 240 public:
 241                             ScHeaderFooterTextCursor(rtl::Reference<ScHeaderFooterTextObj> const & rText);
 242         virtual             ~ScHeaderFooterTextCursor() noexcept override;
 243
 244     ScHeaderFooterTextCursor(ScHeaderFooterTextCursor const &) = default;
 245     ScHeaderFooterTextCursor(ScHeaderFooterTextCursor &&) = default;
 246     ScHeaderFooterTextCursor & operator =(ScHeaderFooterTextCursor const &) = delete; // due to SvxUnoTextCursor
 247     ScHeaderFooterTextCursor & operator =(ScHeaderFooterTextCursor &&) = delete; // due to SvxUnoTextCursor
 248
 249                             // SvxUnoTextCursor methods reimplemented here:
 250     virtual css::uno::Reference< css::text::XText > SAL_CALL
 251                             getText() override;
 252     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL
 253                             getStart() override;
 254     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL
 255                             getEnd() override;
 256
 257                             // XUnoTunnel
 258     UNO3_GETIMPLEMENTATION_DECL(ScHeaderFooterTextCursor)
 259 };
 260
 261 class ScDrawTextCursor final : public SvxUnoTextCursor
 262 {
 263 private:
 264     css::uno::Reference< css::text::XText > xParentText;
 265
 266 public:
 267                             ScDrawTextCursor( css::uno::Reference< css::text::XText > xParent,
 268                                             const SvxUnoTextBase& rText );
 269     virtual                  ~ScDrawTextCursor() noexcept override;
 270
 271     ScDrawTextCursor(ScDrawTextCursor const &) = default;
 272     ScDrawTextCursor(ScDrawTextCursor &&) = default;
 273     ScDrawTextCursor & operator =(ScDrawTextCursor const &) = delete; // due to SvxUnoTextCursor
 274     ScDrawTextCursor & operator =(ScDrawTextCursor &&) = delete; // due to SvxUnoTextCursor
 275
 276                             // SvxUnoTextCursor methods reimplemented here:
 277     virtual css::uno::Reference< css::text::XText > SAL_CALL
 278                             getText() override;
 279     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL
 280                             getStart() override;
 281     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL
 282                             getEnd() override;
 283
 284                             // XUnoTunnel
 285     UNO3_GETIMPLEMENTATION_DECL(ScDrawTextCursor)
 286 };
 287
 288 // ScAnnotationTextCursor isn't needed anymore - SvxUnoTextCursor is used instead
 289
 290 //  ScEditEngineTextObj for formatted cell content that is not inserted in a cell or header/footer
 291 //  (used for XML export of change tracking contents)
 292
 293 class ScSimpleEditSourceHelper
 294 {
 295     std::unique_ptr<ScEditEngineDefaulter>  pEditEngine;
 296     std::unique_ptr<SvxEditEngineForwarder> pForwarder;
 297     std::unique_ptr<ScSimpleEditSource>     pOriginalSource;
 298
 299 public:
 300             ScSimpleEditSourceHelper();
 301             ~ScSimpleEditSourceHelper();
 302
 303     ScSimpleEditSource* GetOriginalSource() const   { return pOriginalSource.get(); }
 304     ScEditEngineDefaulter* GetEditEngine() const    { return pEditEngine.get(); }
 305 };
 306
 307 class ScEditEngineTextObj final : public ScSimpleEditSourceHelper, public SvxUnoText
 308 {
 309 public:
 310                         ScEditEngineTextObj();
 311         virtual         ~ScEditEngineTextObj() noexcept override;
 312
 313     void                SetText( const EditTextObject& rTextObject );
 314     std::unique_ptr<EditTextObject> CreateTextObject();
 315 };
 316
 317 //  ScCellTextData: shared data between sub objects of a cell text object
 318
 319 class ScCellTextData : public SfxListener
 320 {
 321 protected:
 322     ScDocShell*             pDocShell;
 323     ScAddress               aCellPos;
 324     std::unique_ptr<ScFieldEditEngine> pEditEngine;
 325     std::unique_ptr<SvxEditEngineForwarder> pForwarder;
 326     std::unique_ptr<ScCellEditSource> pOriginalSource;
 327     bool                    bDataValid;
 328     bool                    bInUpdate;
 329     bool                    bDirty;
 330     bool                    bDoUpdate;
 331
 332 public:
 333                             ScCellTextData(ScDocShell* pDocSh, const ScAddress& rP);
 334     virtual                 ~ScCellTextData() override;
 335
 336     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
 337
 338                             // helper functions for ScSharedCellEditSource:
 339     virtual SvxTextForwarder* GetTextForwarder();
 340     void                    UpdateData();
 341     ScFieldEditEngine*      GetEditEngine() { GetTextForwarder(); return pEditEngine.get(); }
 342
 343     ScCellEditSource* GetOriginalSource();        // used as argument for SvxUnoText ctor
 344
 345                             // used for ScCellEditSource:
 346     ScDocShell*             GetDocShell() const     { return pDocShell; }
 347     const ScAddress&        GetCellPos() const      { return aCellPos; }
 348
 349     bool                    IsDirty() const         { return bDirty; }
 350     void                    SetDoUpdate(bool bValue)    { bDoUpdate = bValue; }
 351 };
 352
 353 class ScCellTextObj final : public ScCellTextData, public SvxUnoText
 354 {
 355 public:
 356                  ScCellTextObj(ScDocShell* pDocSh, const ScAddress& rP);
 357         virtual  ~ScCellTextObj() COVERITY_NOEXCEPT_FALSE override;
 358 };
 359
 360 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */