sw/inc/IDocumentContentOperations.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: IDocumentContentOperations.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31  #ifndef IDOCUMENTCONTENTOPERATIONS_HXX_INCLUDED
  32  #define IDOCUMENTCONTENTOPERATIONS_HXX_INCLUDED
  33
  34  #ifndef _SAL_TYPES_H_
  35  #include <sal/types.h>
  36  #endif
  37
  38  class SwPaM;
  39  struct SwPosition;
  40  class SwNode;
  41  class SwNodeRange;
  42  class String;
  43  class Graphic;
  44  class SfxItemSet;
  45  class SfxPoolItem;
  46  class GraphicObject;
  47  class SdrObject;
  48  class SwFrmFmt;
  49  class SwDrawFrmFmt;
  50  class SwFlyFrmFmt;
  51  class SwNodeIndex;
  52
  53  namespace utl { class TransliterationWrapper; }
  54  namespace svt { class EmbeddedObjectRef; }
  55
  56  /** Text operation/manipulation interface
  57  */
  58  class IDocumentContentOperations
  59  {
  60  public:
  61     enum SwMoveFlags
  62     {
  63         DOC_MOVEDEFAULT = 0x00,
  64         DOC_MOVEALLFLYS = 0x01,
  65         DOC_CREATEUNDOOBJ = 0x02,
  66         DOC_MOVEREDLINES = 0x04,
  67         DOC_NO_DELFRMS = 0x08
  68     };
  69
  70  public:
  71     /** Kopieren eines Bereiches im oder in ein anderes Dokument !
  72         Die Position kann auch im Bereich liegen !!
  73     */
  74     virtual bool Copy(SwPaM&, SwPosition&, bool bCopyAll ) const = 0;
  75
  76     /** Loesche die Section, in der der Node steht.
  77     */
  78     virtual void DeleteSection(SwNode* pNode) = 0;
  79
  80     /** loeschen eines BereichesSwFlyFrmFmt
  81     */
  82     virtual bool Delete(SwPaM&) = 0;
  83
  84     /** loeschen gesamter Absaetze
  85     */
  86     virtual bool DelFullPara(SwPaM&) = 0;
  87
  88     /** complete delete of a given PaM
  89
  90         OD 2009-08-20 #i100466#
  91         Add optional parameter <bForceJoinNext>, default value <false>
  92         Needed for hiding of deletion redlines
  93     */
  94     virtual bool DeleteAndJoin( SwPaM&,
  95                                 const bool bForceJoinNext = false ) = 0;
  96
  97     /** verschieben eines Bereiches
  98     */
  99     virtual bool Move(SwPaM&, SwPosition&, SwMoveFlags) = 0;
 100
 101     /** verschieben ganzer Nodes
 102     */
 103     virtual bool Move(SwNodeRange&, SwNodeIndex&, SwMoveFlags) = 0;
 104
 105     /** verschieben eines Bereiches
 106     */
 107     virtual bool MoveAndJoin(SwPaM&, SwPosition&, SwMoveFlags) = 0;
 108
 109     /** Ueberschreiben eines einzelnen Zeichens. rRg.Start() bezeichnet
 110         den Node und die Position in dem Node, an der eingefuegt wird,
 111     */
 112     virtual bool Overwrite(const SwPaM &rRg, sal_Unicode c) = 0;
 113
 114     /** Ueberschreiben eines Strings in einem bestehenden Textnode.
 115     */
 116     virtual bool Overwrite(const SwPaM &rRg, const String& rStr) = 0;
 117
 118     /** Einfuegen eines einzelnen Zeichens. rRg.Start() bezeichnet
 119         den Node und die Position in dem Node, an der eingefuegt wird.
 120     */
 121     virtual bool Insert(const SwPaM &rRg, sal_Unicode c) = 0;
 122
 123     /** Einfuegen eines Strings in einen bestehenden
 124         Textnode. Der Text wird kopiert.
 125     */
 126     virtual bool Insert(const SwPaM &rRg, const String&, bool bHintExpand) = 0;
 127
 128     /** change text to Upper/Lower/Hiragana/Katagana/...
 129     */
 130     virtual void TransliterateText(const SwPaM& rPaM, utl::TransliterationWrapper&) = 0;
 131
 132     /** Einfuegen einer Grafik, Formel. Die XXXX werden kopiert.
 133     */
 134     virtual SwFlyFrmFmt* Insert(const SwPaM &rRg, const String& rGrfName, const String& rFltName, const Graphic* pGraphic,
 135                         const SfxItemSet* pFlyAttrSet, const SfxItemSet* pGrfAttrSet, SwFrmFmt*) = 0;
 136
 137     /**
 138     */
 139     virtual SwFlyFrmFmt* Insert(const SwPaM& rRg, const GraphicObject& rGrfObj, const SfxItemSet* pFlyAttrSet,
 140                         const SfxItemSet* pGrfAttrSet, SwFrmFmt*) = 0;
 141
 142     /** austauschen einer Grafik (mit Undo)
 143     */
 144     virtual void ReRead(SwPaM&, const String& rGrfName, const String& rFltName, const Graphic* pGraphic, const GraphicObject* pGrfObj) = 0;
 145
 146     /** Einfuegen eines DrawObjectes. Das Object muss bereits im DrawModel
 147         angemeldet sein.
 148     */
 149     virtual SwDrawFrmFmt* Insert(const SwPaM &rRg, SdrObject& rDrawObj, const SfxItemSet* pFlyAttrSet, SwFrmFmt*) = 0;
 150
 151     /** Einfuegen von OLE-Objecten.
 152     */
 153     virtual SwFlyFrmFmt* Insert(const SwPaM &rRg, const svt::EmbeddedObjectRef& xObj, const SfxItemSet* pFlyAttrSet,
 154                         const SfxItemSet* pGrfAttrSet, SwFrmFmt*) = 0;
 155
 156     virtual SwFlyFrmFmt* InsertOLE(const SwPaM &rRg, const String& rObjName, sal_Int64 nAspect, const SfxItemSet* pFlyAttrSet,
 157                            const SfxItemSet* pGrfAttrSet, SwFrmFmt*) = 0;
 158
 159     /** Aufspalten eines Nodes an rPos (nur fuer den TxtNode implementiert)
 160     */
 161     virtual bool SplitNode(const SwPosition &rPos, bool bChkTableStart) = 0;
 162
 163     /**
 164     */
 165     virtual bool AppendTxtNode(SwPosition& rPos) = 0;
 166
 167     /** Ersetz einen selektierten Bereich in einem TextNode mit dem
 168         String. Ist fuers Suchen&Ersetzen gedacht.
 169         bRegExpRplc - ersetze Tabs (\\t) und setze den gefundenen String
 170                  ein ( nicht \& )
 171                     z.B.: Fnd: "zzz", Repl: "xx\t\\t..&..\&"
 172                         --> "xx\t<Tab>..zzz..&"
 173     */
 174     virtual bool Replace(SwPaM& rPam, const String& rNewStr, bool bRegExpRplc) = 0;
 175
 176     /** Einfuegen eines Attributs. Erstreckt sich rRg ueber
 177         mehrere Nodes, wird das Attribut aufgespaltet, sofern
 178         dieses Sinn macht. Nodes, in denen dieses Attribut keinen
 179         Sinn macht, werden ignoriert.  In vollstaendig in der
 180         Selektion eingeschlossenen Nodes wird das Attribut zu
 181         harter Formatierung, in den anderen (Text-)Nodes wird das
 182         Attribut in das Attributearray eingefuegt. Bei einem
 183         Zeichenattribut wird ein "leerer" Hint eingefuegt,
 184         wenn keine Selektion
 185         vorliegt; andernfalls wird das Attribut als harte
 186         Formatierung dem durch rRg.Start() bezeichneten Node
 187         hinzugefuegt.  Wenn das Attribut nicht eingefuegt werden
 188         konnte, liefert die Methode sal_False.
 189     */
 190     virtual bool Insert(const SwPaM &rRg, const SfxPoolItem&, sal_uInt16 nFlags) = 0;
 191
 192     /**
 193     */
 194     virtual bool Insert(const SwPaM &rRg, const SfxItemSet&, sal_uInt16 nFlags) = 0;
 195
 196     /** Removes any leading white space from the paragraph
 197     */
 198     virtual void RemoveLeadingWhiteSpace(const SwPosition & rPos ) = 0;
 199
 200  protected:
 201     virtual ~IDocumentContentOperations() {};
 202 };
 203
 204 #endif // IDOCUMENTCONTENTOPERATIONS_HXX_INCLUDED
 205