include/editeng/editobj.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 _EDITOBJ_HXX
  21 #define _EDITOBJ_HXX
  22
  23 #include <tools/stream.hxx>
  24 #include <tools/debug.hxx>
  25 #include <rsc/rscsfx.hxx>
  26 #include <svl/itemset.hxx>
  27 #include "svl/itempool.hxx"
  28 #include <editeng/eeitem.hxx>
  29 #include <editeng/editdata.hxx>
  30 #include "editeng/editengdllapi.h"
  31 #include "editeng/macros.hxx"
  32
  33 #include <com/sun/star/text/textfield/Type.hpp>
  34
  35 #include <vector>
  36
  37 DBG_NAMEEX( EE_EditTextObject )
  38
  39 class SfxItemPool;
  40 class SfxStyleSheetPool;
  41 class SvxFieldItem;
  42 class SvxFieldData;
  43
  44 namespace editeng {
  45
  46 class FieldUpdater;
  47 class FieldUpdaterImpl;
  48
  49 }
  50
  51 class EditTextObjectImpl;
  52
  53 class EDITENG_DLLPUBLIC EditTextObject : public SfxItemPoolUser
  54 {
  55     friend class EditTextObjectImpl;
  56     friend class editeng::FieldUpdaterImpl;
  57     friend class ImpEditEngine;
  58
  59     EditTextObjectImpl* mpImpl;
  60
  61     EDITENG_DLLPRIVATE EditTextObject&      operator=( const EditTextObject& );
  62
  63     EditTextObject(); // disabled
  64
  65     EditTextObject( SfxItemPool* pPool );
  66
  67     void StoreData( SvStream& rStrm ) const;
  68     void CreateData( SvStream& rStrm );
  69
  70 public:
  71     EditTextObject( const EditTextObject& r );
  72     virtual ~EditTextObject();
  73
  74     sal_uInt16 GetUserType() const;    // For OutlinerMode, it can however not save in compatible format
  75     void SetUserType( sal_uInt16 n );
  76
  77     bool IsVertical() const;
  78     void SetVertical( bool bVertical );
  79
  80     sal_uInt16 GetScriptType() const;
  81
  82     EditTextObject* Clone() const;
  83
  84     bool Store( SvStream& rOStream ) const;
  85
  86     static EditTextObject* Create(
  87         SvStream& rIStream, SfxItemPool* pGlobalTextObjectPool = NULL );
  88
  89     sal_Int32 GetParagraphCount() const;
  90
  91     String GetText(sal_Int32 nPara) const;
  92
  93     void ClearPortionInfo();
  94
  95     bool HasOnlineSpellErrors() const;
  96
  97     void GetCharAttribs( sal_Int32 nPara, std::vector<EECharAttrib>& rLst ) const;
  98
  99     bool RemoveCharAttribs( sal_uInt16 nWhich = 0 );
 100
 101     bool IsFieldObject() const;
 102     const SvxFieldItem* GetField() const;
 103     const SvxFieldData* GetFieldData(sal_Int32 nPara, size_t nPos, sal_Int32 nType) const;
 104     bool HasField( sal_Int32 nType = com::sun::star::text::textfield::Type::UNSPECIFIED ) const;
 105
 106     const SfxItemSet& GetParaAttribs(sal_Int32 nPara) const;
 107
 108     void GetStyleSheet(sal_Int32 nPara, String& rName, SfxStyleFamily& eFamily) const;
 109     void SetStyleSheet(sal_Int32 nPara, const String& rName, const SfxStyleFamily& eFamily);
 110     bool ChangeStyleSheets(
 111         const XubString& rOldName, SfxStyleFamily eOldFamily, const XubString& rNewName, SfxStyleFamily eNewFamily );
 112     void ChangeStyleSheetName( SfxStyleFamily eFamily, const XubString& rOldName, const XubString& rNewName );
 113
 114     editeng::FieldUpdater GetFieldUpdater();
 115
 116     bool operator==( const EditTextObject& rCompare ) const;
 117
 118     // #i102062#
 119     bool isWrongListEqual(const EditTextObject& rCompare) const;
 120
 121     virtual void ObjectInDestruction(const SfxItemPool& rSfxItemPool);
 122
 123 #if DEBUG_EDIT_ENGINE
 124     void Dump() const;
 125 #endif
 126 };
 127
 128 #endif  // _EDITOBJ_HXX
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */