include/editeng/outlobj.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_OUTLOBJ_HXX
  21 #define INCLUDED_EDITENG_OUTLOBJ_HXX
  22
  23 #include <editeng/paragraphdata.hxx>
  24 #include <editeng/editengdllapi.h>
  25 #include <rtl/ustring.hxx>
  26 #include <svl/style.hxx>
  27 #include <o3tl/cow_wrapper.hxx>
  28 #include <memory>
  29
  30 class EditTextObject;
  31 enum class OutlinerMode;
  32
  33 /**
  34  * This is the guts of OutlinerParaObject, refcounted and shared among
  35  * multiple instances of OutlinerParaObject.
  36  */
  37 struct OutlinerParaObjData
  38 {
  39     // data members
  40     std::unique_ptr<EditTextObject>  mpEditTextObject;
  41     ParagraphDataVector              maParagraphDataVector;
  42     bool                             mbIsEditDoc;
  43
  44     // constructor
  45     OutlinerParaObjData( std::unique_ptr<EditTextObject> pEditTextObject, const ParagraphDataVector& rParagraphDataVector, bool bIsEditDoc );
  46
  47     OutlinerParaObjData( const OutlinerParaObjData& r );
  48
  49     // assignment operator
  50     OutlinerParaObjData& operator=(const OutlinerParaObjData& rCandidate) = delete;
  51
  52     // destructor
  53     ~OutlinerParaObjData();
  54
  55     bool operator==(const OutlinerParaObjData& rCandidate) const;
  56
  57     // #i102062#
  58     bool isWrongListEqual(const OutlinerParaObjData& rCompare) const;
  59 };
  60
  61 class EDITENG_DLLPUBLIC OutlinerParaObject
  62 {
  63     ::o3tl::cow_wrapper< OutlinerParaObjData > mpImpl;
  64
  65 public:
  66     // constructors/destructor
  67     OutlinerParaObject( const EditTextObject&, const ParagraphDataVector&, bool bIsEditDoc);
  68     OutlinerParaObject( const EditTextObject&);
  69     OutlinerParaObject( std::unique_ptr<EditTextObject> );
  70     OutlinerParaObject( const OutlinerParaObject&);
  71     ~OutlinerParaObject();
  72
  73     // assignment operator
  74     OutlinerParaObject& operator=(const OutlinerParaObject& rCandidate);
  75
  76     // compare operator
  77     bool operator==(const OutlinerParaObject& rCandidate) const;
  78
  79     // #i102062#
  80     bool isWrongListEqual(const OutlinerParaObject& rCompare) const;
  81
  82     // outliner mode access
  83     OutlinerMode GetOutlinerMode() const;
  84     void SetOutlinerMode(OutlinerMode nNew);
  85
  86     // vertical access
  87     bool IsVertical() const;
  88     bool IsTopToBottom() const;
  89     void SetVertical(bool bNew, bool bTopToBottom = true);
  90
  91     // data read access
  92     sal_Int32 Count() const;
  93     sal_Int16 GetDepth(sal_Int32 nPara) const;
  94     const EditTextObject& GetTextObject() const;
  95     const ParagraphData& GetParagraphData(sal_Int32 nIndex) const;
  96
  97     // portion info support
  98     void ClearPortionInfo();
  99
 100     // StyleSheet support
 101     bool ChangeStyleSheets(const OUString& rOldName, SfxStyleFamily eOldFamily,
 102         const OUString& rNewName, SfxStyleFamily eNewFamily);
 103     void ChangeStyleSheetName(SfxStyleFamily eFamily, const OUString& rOldName,
 104         const OUString& rNewName);
 105     void SetStyleSheets(sal_uInt16 nLevel, const OUString& rNewName,
 106         const SfxStyleFamily& rNewFamily);
 107
 108     void dumpAsXml(xmlTextWriterPtr pWriter) const;
 109 };
 110
 111 #endif
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */