sw/inc/ndtxt.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: ndtxt.hxx,v $
  10  * $Revision: 1.61 $
  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 #ifndef _NDTXT_HXX
  31 #define _NDTXT_HXX
  32
  33 #include "swdllapi.h"
  34 #include <error.h>
  35 #include <node.hxx>
  36 #include <hintids.hxx>
  37 #include <ndhints.hxx>
  38 #include <errhdl.hxx>
  39 #include <modeltoviewhelper.hxx>
  40 #include <SwNumberTreeTypes.hxx>
  41 class SwNumRule;
  42 class SwNodeNum;
  43 // --> OD 2008-05-06 #refactorlists#
  44 class SwList;
  45 // <--
  46 // --> OD 2008-12-02 #i96772#
  47 class SvxLRSpaceItem;
  48 // <--
  49
  50 #include <vector>
  51 #include <set>
  52
  53 namespace utl {
  54         class TransliterationWrapper;
  55 }
  56
  57 class SwTxtFmtColl;
  58 class SwCntntFrm;
  59 class SwTxtFld;                  // Fuer GetTxtFld()
  60 class SfxItemSet;
  61 class SwUndoTransliterate;
  62
  63
  64 struct SwSpellArgs;             // for Spell(), splargs.hxx
  65 struct SwConversionArgs;        // for Convert(), splargs.hxx
  66 class SwInterHyphInfo;          // for Hyphenate(), splargs.hxx
  67 class SwWrongList;      // fuer OnlineSpelling
  68 class SwGrammarMarkUp;
  69 class OutputDevice;
  70 class SwScriptInfo;
  71 struct SwDocStat;
  72 struct SwParaIdleData_Impl;
  73
  74 // Konstanten fuer das Text-Insert:
  75 #define INS_DEFAULT         0x0000 // keine Extras
  76 #define INS_EMPTYEXPAND     0x0001 // leere Hints beim Einfuegen aufspannen
  77 #define INS_NOHINTEXPAND    0x0002 // Hints an der InsPos nicht aufspannen
  78
  79 namespace com { namespace sun { namespace star { namespace uno {
  80     template < class > class Sequence;
  81 }}}}
  82
  83 typedef std::set< xub_StrLen > SwSoftPageBreakList;
  84
  85 // --------------------
  86 // SwTxtNode
  87 // --------------------
  88 class SW_DLLPUBLIC SwTxtNode: public SwCntntNode
  89 {
  90
  91         // fuer das Erzeugen des ersten TextNode
  92         friend class SwDoc;             // CTOR und AppendTxtNode()
  93         friend class SwNodes;
  94         friend class SwTxtFrm;
  95     friend class SwScriptInfo;
  96         friend void SwpHints::Insert( SwTxtAttr*, SwTxtNode&, USHORT );
  97     friend void SwpHints::BuildPortions( SwTxtNode&, SwTxtAttr&, USHORT );
  98
  99         //Kann 0 sein, nur dann nicht 0 wenn harte Attribute drin stehen.
 100         //Also niemals direkt zugreifen!
 101         SwpHints        *pSwpHints;
 102
 103     // --> OD 2005-11-02 #i51089 - TUNING#
 104     mutable SwNodeNum* mpNodeNum;  // Numerierung fuer diesen Absatz
 105     // <--
 106         XubString       aText;
 107
 108     SwParaIdleData_Impl* pParaIdleData_Impl;
 109
 110     // Some of the chars this para are hidden. Paragraph has to be reformatted
 111     // on changing the view to print preview.
 112     mutable BOOL bContainsHiddenChars : 1;
 113     // The whole paragraph is hidden because of the hidden text attribute
 114     mutable BOOL bHiddenCharsHidePara : 1;
 115     // The last two flags have to be recalculated if this flag is set:
 116     mutable BOOL bRecalcHiddenCharFlags : 1;
 117
 118     bool bNotifiable;
 119     mutable BOOL bLastOutlineState : 1;
 120
 121     // BYTE nOutlineLevel; //#outline level, removed by zhaojianwei.
 122     // --> OD 2008-11-19 #i70748#
 123     bool mbEmptyListStyleSetDueToSetOutlineLevelAttr;
 124     // <--
 125
 126     // --> OD 2008-03-27 #refactorlists#
 127     // boolean, indicating that a <SetAttr(..)> or <ResetAttr(..)> or
 128     // <ResetAllAttr(..)> method is running.
 129     // Needed to avoid duplicate handling of attribute change actions.
 130     bool mbInSetOrResetAttr;
 131     // <--
 132     // --> OD 2008-05-06 #refactorlists#
 133     // pointer to the list, to whose the text node is added to
 134     SwList* mpList;
 135     // <--
 136
 137     SW_DLLPRIVATE SwTxtNode( const SwNodeIndex &rWhere, SwTxtFmtColl *pTxtColl,
 138                              const SfxItemSet* pAutoAttr = 0 );
 139
 140         // Kopiert die Attribute an nStart nach pDest.
 141         SW_DLLPRIVATE void CopyAttr( SwTxtNode *pDest, const xub_StrLen nStart, const xub_StrLen nOldPos);
 142
 143         SW_DLLPRIVATE SwTxtNode* _MakeNewTxtNode( const SwNodeIndex&, BOOL bNext = TRUE,
 144                                                                 BOOL bChgFollow = TRUE );
 145
 146         SW_DLLPRIVATE void      _Cut( SwTxtNode *pDest, const SwIndex &rDestStart,
 147                                   const SwIndex &rStart, xub_StrLen nLen, BOOL bUpdate = TRUE );
 148
 149     SW_DLLPRIVATE SwTxtAttr* MakeTxtAttr( const SfxPoolItem& rNew, xub_StrLen nStt, xub_StrLen nEnd, bool bRedlineAttr = false );
 150     SW_DLLPRIVATE SwTxtAttr* MakeTxtAttr( const SfxItemSet& rSet, xub_StrLen nStt, xub_StrLen nEnd );
 151
 152     // Verlagere alles umfassende harte Attribute in den AttrSet des Absatzes
 153         SW_DLLPRIVATE void MoveTxtAttr_To_AttrSet();  // wird von SplitNode gerufen.
 154
 155         // lege den spz. AttrSet an
 156         SW_DLLPRIVATE virtual void NewAttrSet( SwAttrPool& );
 157
 158         SW_DLLPRIVATE void Replace0xFF( XubString& rTxt, xub_StrLen& rTxtStt,
 159                                                 xub_StrLen nEndPos, BOOL bExpandFlds ) const;
 160
 161     // Optimization: Asking for information about hidden characters at SwScriptInfo
 162     // updates these flags.
 163     inline bool IsCalcHiddenCharFlags() const { return bRecalcHiddenCharFlags; }
 164     inline void SetHiddenCharAttribute( bool bNewHiddenCharsHidePara, bool bNewContainsHiddenChars ) const
 165     {
 166         bHiddenCharsHidePara = bNewHiddenCharsHidePara;
 167         bContainsHiddenChars = bNewContainsHiddenChars;
 168         bRecalcHiddenCharFlags = false;
 169     }
 170
 171     SW_DLLPRIVATE void CalcHiddenCharFlags() const;
 172
 173     SW_DLLPRIVATE SwNumRule * _GetNumRule(BOOL bInParent = TRUE) const;
 174
 175     SW_DLLPRIVATE void SetLanguageAndFont( const SwPaM &rPaM,
 176             LanguageType nLang, USHORT nLangWhichId,
 177             const Font *pFont,  USHORT nFontWhichId );
 178
 179     //
 180     // Start: Data collected during idle time
 181     //
 182     SW_DLLPRIVATE void SetParaNumberOfWords( ULONG nTmpWords ) const;
 183     SW_DLLPRIVATE ULONG GetParaNumberOfWords() const;
 184     SW_DLLPRIVATE void SetParaNumberOfChars( ULONG nTmpChars ) const;
 185     SW_DLLPRIVATE ULONG GetParaNumberOfChars() const;
 186     SW_DLLPRIVATE void InitSwParaStatistics( bool bNew );
 187
 188     /** create number for this text node, if not already existing
 189
 190         OD 2005-11-02 #i51089 - TUNING#
 191         OD 2007-10-26 #i83479# - made private
 192
 193         @return number of this node
 194     */
 195     SwNodeNum* CreateNum() const;
 196
 197 public:
 198     bool IsWordCountDirty() const;
 199     bool IsWrongDirty() const;
 200     bool IsGrammarCheckDirty() const;
 201     bool IsSmartTagDirty() const;   // SMARTTAGS
 202     bool IsAutoCompleteWordDirty() const;
 203     void SetWordCountDirty( bool bNew ) const;
 204     void SetWrongDirty( bool bNew ) const;
 205     void SetGrammarCheckDirty( bool bNew ) const;
 206     void SetSmartTagDirty( bool bNew ) const;  // SMARTTAGS
 207     void SetAutoCompleteWordDirty( bool bNew ) const;
 208     void SetWrong( SwWrongList* pNew, bool bDelete = true );
 209     SwWrongList* GetWrong();
 210     // --> OD 2008-05-23 #i71360#
 211     const SwWrongList* GetWrong() const;
 212     // <--
 213     void SetGrammarCheck( SwGrammarMarkUp* pNew, bool bDelete = true );
 214     SwGrammarMarkUp* GetGrammarCheck();
 215     // SMARTTAGS
 216     void SetSmartTags( SwWrongList* pNew, bool bDelete = true );
 217     SwWrongList* GetSmartTags();
 218
 219     //
 220     // End: Data collected during idle time
 221     //
 222
 223 public:
 224     using SwCntntNode::GetAttr;
 225
 226     const String& GetTxt() const { return aText; }
 227
 228         // Zugriff auf SwpHints
 229         inline           SwpHints &GetSwpHints();
 230         inline const SwpHints &GetSwpHints() const;
 231         inline           SwpHints *GetpSwpHints() { return pSwpHints; }
 232         inline const SwpHints *GetpSwpHints() const { return pSwpHints; }
 233     inline BOOL  HasHints() const { return pSwpHints ? TRUE : FALSE; }
 234         inline           SwpHints &GetOrCreateSwpHints();
 235
 236         virtual ~SwTxtNode();
 237
 238         virtual xub_StrLen Len() const;
 239
 240         // steht in itratr
 241         void GetMinMaxSize( ULONG nIndex, ULONG& rMin, ULONG &rMax, ULONG &rAbs,
 242                                                 OutputDevice* pOut = 0 ) const;
 243
 244     // --> OD 2008-03-13 #refactorlists#
 245     // overriding to handle change of certain paragraph attributes
 246     virtual BOOL SetAttr( const SfxPoolItem& );
 247     virtual BOOL SetAttr( const SfxItemSet& rSet );
 248     virtual BOOL ResetAttr( USHORT nWhich1, USHORT nWhich2 = 0 );
 249     virtual BOOL ResetAttr( const SvUShorts& rWhichArr );
 250     virtual USHORT ResetAllAttr();
 251     // <--
 252
 253     /*
 254          * Einfuegen anderer Datentypen durch Erzeugen eines
 255          * temporaeren Strings.
 256          */
 257         SwTxtNode&      Insert( xub_Unicode c, const SwIndex &rIdx );
 258         SwTxtNode&      Insert( const XubString &rStr, const SwIndex &rIdx,
 259                                                 const USHORT nMode = INS_DEFAULT );
 260
 261         SwTxtNode&      Erase( const SwIndex &rIdx, xub_StrLen nCount = STRING_LEN,
 262                                            const USHORT nMode = INS_DEFAULT );
 263
 264         // Aktionen auf Attributen
 265         // loesche alle TextAttribute die als Attribut im Set vorhanden sind
 266         // (Set-Pointer != 0 ) oder alle deren Which-Wert mit nWhich mappen
 267         // oder wenn Which = 0, alle.
 268         void    RstAttr( const SwIndex &rIdx, xub_StrLen nLen, USHORT nWhich = 0,
 269                                         const SfxItemSet* pSet = 0, BOOL bInclRefToxMark = FALSE );
 270         void    GCAttr();
 271
 272         // loesche das Text-Attribut (muss beim Pool abgemeldet werden!)
 273         void    DestroyAttr( SwTxtAttr* pAttr );
 274
 275         // loesche alle Attribute aus dem SwpHintsArray.
 276     void    ClearSwpHintsArr( bool bDelFields );
 277
 278     // Insert pAttr into hints array.
 279     BOOL    Insert( SwTxtAttr *pAttr, USHORT nMode = 0 );
 280     // lege ein neues TextAttribut an und fuege es ins SwpHints-Array ein
 281         // returne den neuen Pointer (oder 0 bei Fehlern)!
 282     SwTxtAttr* InsertItem( const SfxPoolItem& rAttr,
 283                            xub_StrLen nStt, xub_StrLen nEnd, USHORT nMode = 0 );
 284
 285         // setze diese Attribute am TextNode. Wird der gesamte Bereich umspannt,
 286         // dann setze sie nur im AutoAttrSet (SwCntntNode:: SetAttr)
 287     BOOL SetAttr( const SfxItemSet& rSet,
 288                   xub_StrLen nStt, xub_StrLen nEnd, USHORT nMode = 0 );
 289         // erfrage die Attribute vom TextNode ueber den Bereich
 290     // --> OD 2008-01-16 #newlistlevelattrs#
 291     // Introduce 4th optional parameter <bMergeIndentValuesOfNumRule>.
 292     // If <bMergeIndentValuesOfNumRule> == TRUE, the indent attributes of
 293     // the corresponding list level of an applied list style is merged into
 294     // the requested item set as a LR-SPACE item, if <bOnlyTxtAttr> == FALSE,
 295     // corresponding node has not its own indent attributes and the
 296     // position-and-space mode of the list level is SvxNumberFormat::LABEL_ALIGNMENT.
 297     BOOL GetAttr( SfxItemSet& rSet, xub_StrLen nStt, xub_StrLen nEnd,
 298                   BOOL bOnlyTxtAttr  = FALSE,
 299                   BOOL bGetFromChrFmt = TRUE,
 300                   const bool bMergeIndentValuesOfNumRule = false ) const;
 301     // <--
 302
 303         // uebertrage Attribute eines AttrSets ( AutoFmt ) in das SwpHintsArray
 304         void FmtToTxtAttr( SwTxtNode* pNd );
 305
 306         // loeschen eines einzelnen Attributes (fuer SwUndoAttr)
 307         // ( nur das Attribut loeschen, dass mit Which,Start und End oder
 308         //   mit pTxtHint identisch ist (es gibt nur ein gueltiges))
 309         //      AUSNAHME: ToxMarks !!!
 310         void    Delete( USHORT nTxtWhich, xub_StrLen nStart, xub_StrLen nEnd = 0 );
 311         void    Delete( SwTxtAttr * pTxtAttr, BOOL bThisOnly = FALSE );
 312
 313         // Aktionen auf Text und Attributen
 314     // --> OD 2008-11-18 #i96213#
 315     // introduce optional parameter to control, if all attributes have to be copied.
 316     void Copy( SwTxtNode *pDest,
 317                const SwIndex &rStart,
 318                USHORT nLen,
 319                const bool bForceCopyOfAllAttrs = false );
 320     void Copy( SwTxtNode *pDest,
 321                const SwIndex &rDestStart,
 322                const SwIndex &rStart,
 323                xub_StrLen nLen,
 324                const bool bForceCopyOfAllAttrs = false );
 325     // <--
 326         void    Cut(SwTxtNode *pDest, const SwIndex &rStart, xub_StrLen nLen);
 327         inline void     Cut(SwTxtNode *pDest, const SwIndex &rDestStart,
 328                                         const SwIndex &rStart, xub_StrLen nLen);
 329         // ersetze im String an Position nIdx das Zeichen
 330         void Replace( const SwIndex& rStart, xub_Unicode cCh );
 331         void Replace( const SwIndex& rStart, xub_StrLen nLen, const XubString& rText );
 332         void ReplaceTextOnly( xub_StrLen nPos, xub_StrLen nLen, const XubString& rText,
 333                                         const ::com::sun::star::uno::Sequence<sal_Int32>& rOffsets );
 334
 335         // virtuelle Methoden aus dem CntntNode
 336         virtual SwCntntFrm *MakeFrm();
 337     virtual SwCntntNode *SplitCntntNode( const SwPosition & );
 338         virtual SwCntntNode *JoinNext();
 339         virtual SwCntntNode *JoinPrev();
 340
 341         SwCntntNode *AppendNode( const SwPosition & );
 342
 343         // setze ggf. das DontExpand-Flag an INet bzw. Zeichenvorlagen
 344         BOOL DontExpandFmt( const SwIndex& rIdx, BOOL bFlag = TRUE,
 345                                                 BOOL bFmtToTxtAttributes = TRUE );
 346
 347         // gebe das vorgegebene Attribut, welches an der TextPosition (rIdx)
 348         // gesetzt ist zurueck. Gibt es keines, returne 0-Pointer
 349         // gesetzt heisst: Start <= rIdx < End
 350         SwTxtAttr *GetTxtAttr( const SwIndex& rIdx, USHORT nWhichHt,
 351                                                    BOOL bExpand = FALSE ) const;
 352
 353         // Diese Methode liefert nur Textattribute auf der Position nIdx
 354         // zurueck, die kein EndIdx besitzen und denselben Which besitzen.
 355         // Ueblicherweise steht an dieser Position ein CH_TXTATR.
 356         // Bei RES_TXTATR_END entfaellt die Pruefung auf den Which-Wert.
 357         SwTxtAttr *GetTxtAttr( const xub_StrLen nIdx,
 358                                                    const USHORT nWhichHt = RES_TXTATR_END ) const;
 359
 360         SwTxtFld  *GetTxtFld( const SwIndex& rIdx )
 361                 { return (SwTxtFld *)GetTxtAttr( rIdx, RES_TXTATR_FIELD ); }
 362
 363         // Aktuelles Wort zurueckliefern
 364     XubString GetCurWord(xub_StrLen) const;
 365         USHORT Spell(SwSpellArgs*);
 366     USHORT Convert( SwConversionArgs & );
 367
 368         inline SwTxtFmtColl *GetTxtColl() const;
 369         virtual SwFmtColl *ChgFmtColl( SwFmtColl* );
 370         void _ChgTxtCollUpdateNum( const SwTxtFmtColl* pOld,
 371                                                                 const SwTxtFmtColl* pNew );
 372
 373         // kopiere die Collection mit allen Autoformaten zum Dest-Node
 374         // dieser kann auch in einem anderen Dokument stehen!
 375         // (Methode steht im ndcopy.cxx!!)
 376         void CopyCollFmt( SwTxtNode& rDestNd );
 377
 378     //const SwNodeNum* _GetNodeNum() const { return pNdNum; }
 379
 380     //
 381     // BEGIN OF BULLET/NUMBERING/OUTLINE STUFF:
 382     //
 383
 384     /**
 385        Returns numbering rule of this text node.
 386
 387        @param bInParent     serach in parent attributes, too
 388
 389        @return numbering rule of this text node or NULL if none is set
 390      */
 391     SwNumRule *GetNumRule(BOOL bInParent = TRUE) const;
 392
 393     inline const SwNodeNum* GetNum() const
 394     {
 395         return mpNodeNum;
 396     }
 397
 398     SwNumberTree::tNumberVector GetNumberVector() const;
 399
 400     /**
 401        Returns if this text node is an outline.
 402
 403        @retval TRUE      this text node is an outline
 404        @retval FALSE     else
 405      */
 406     BOOL IsOutline() const;
 407
 408     BOOL IsOutlineStateChanged() const;
 409
 410     void UpdateOutlineState();
 411
 412     /** -> #i23730#
 413
 414         Returns if this text node may be numbered.
 415
 416         A text node may be numbered if
 417           - it has no SwNodeNum
 418           - it has a SwNodeNum and it has a numbering rule and the according
 419             SwNumFmt defines a numbering type that is an enumeration.
 420
 421        @retval TRUE      this text node may be numbered
 422        @retval FALSE     else
 423      */
 424     //BOOL MayBeNumbered() const;
 425
 426     /**
 427        Notify this textnode that its numbering rule has changed.
 428      */
 429     void NumRuleChgd();
 430
 431     /** Returns outline of numbering string
 432
 433         OD 2005-11-17 #128041#
 434         Introduce parameter <_bInclPrefixAndSuffixStrings> in order to control,
 435         if the prefix and the suffix strings have to been included or not.
 436
 437         @param _bInclPrefixAndSuffixStrings
 438         optional input parameter - boolean indicating, if the prefix and the
 439         suffix strings have to been included or not. default value = <true>
 440
 441         @param _nRestrictToThisLevel
 442         optional input parameter - unsigned integer indicating the maximum outline
 443         level to which the output string must be restricted to. Default value is
 444         MAXLEVEL
 445     */
 446     XubString GetNumString( const bool _bInclPrefixAndSuffixStrings = true, const unsigned int _nRestrictToThisLevel = MAXLEVEL ) const;
 447
 448     /**
 449        Returns the additional indents of this text node and its numbering.
 450
 451        @param bTxtLeft  ???
 452
 453        @return additional indents
 454      */
 455      long GetLeftMarginWithNum( BOOL bTxtLeft = FALSE ) const;
 456
 457     /**
 458        Returns the combined first line indent of this text node and
 459        its numbering.
 460
 461        @param the first line indent of this text node taking the
 462                numbering into account (return parameter)
 463
 464        @retval TRUE   this node has SwNodeNum and has numbering rule
 465        @retval FALSE  else
 466      */
 467     BOOL GetFirstLineOfsWithNum( short& rFirstOffset ) const;
 468
 469     // --> OD 2008-12-02 #i96772#
 470     void ClearLRSpaceItemDueToListLevelIndents( SvxLRSpaceItem& o_rLRSpaceItem ) const;
 471     // <--
 472
 473     /** return left margin for tab stop position calculation
 474
 475         OD 2008-06-30 #i91133#
 476         Needed for text formatting
 477         Method considers new list level attributes, which also can provide a left margin value
 478
 479         @author OD
 480     */
 481     long GetLeftMarginForTabCalculation() const;
 482
 483     /** -> #i29560
 484         Returns if this text node has a number.
 485
 486         This text node has a number if it has a SwNodeNum and a
 487         numbering rule and the numbering format specified for the
 488         level of the SwNodeNum is of an enumeration type.
 489
 490         @retval TRUE    This text node has a number.
 491         @retval FALSE   else
 492      */
 493     BOOL HasNumber() const;
 494
 495     /** -> #i29560
 496         Returns if this text node has a bullet.
 497
 498         This text node has a bullet if it has a SwNodeNum and a
 499         numbering rule and the numbering format specified for the
 500         level of the SwNodeNum is of a bullet type.
 501
 502         @retval TRUE    This text node has a bullet.
 503         @retval FALSE   else
 504      */
 505     BOOL HasBullet() const;
 506
 507     /** -> #i27615#
 508         Returns is this text node is numbered.
 509
 510         This node is numbered if it has a SwNodeNum and it has a
 511         numbering rule and has not a hidden SwNodeNum.
 512
 513         ATTENTION: Returns TRUE even if the SwNumFmt has type
 514         SVX_NUM_NUMBER_NONE.
 515
 516         @retval TRUE      This node is numbered.
 517         @retval FALSE     else
 518      */
 519     BOOL IsNumbered() const;
 520
 521     /** -> #i27615#
 522         Returns if this text node has a marked label.
 523
 524         @retval true       This text node has a marked label.
 525         @retval false      else
 526      */
 527     bool HasMarkedLabel() const;
 528
 529     /** Sets the list level of this text node.
 530
 531         Side effect, when the text node is a list item:
 532         The text node's representation in the list tree (<SwNodeNum> instance)
 533         is updated.
 534
 535         @param nLevel level to set
 536     */
 537     void SetAttrListLevel(int nLevel);
 538
 539     bool HasAttrListLevel() const;
 540
 541     int GetAttrListLevel() const;
 542
 543     /** Returns the actual list level of this text node, when it is a list item
 544
 545         @return the actual list level of this text node, if it is a list item,
 546                -1 otherwise
 547     */
 548     int GetActualListLevel() const;
 549
 550     /**
 551        Returns outline level of this text node.
 552
 553        If a text node has an outline number (i.e. it has an SwNodeNum
 554        and a outline numbering rule) the outline level is the level of
 555        this SwNodeNum.
 556
 557        If a text node has no outline number and has a paragraph style
 558        attached the outline level is the outline level of the
 559        paragraph style.
 560
 561        Otherwise the text node has no outline level (NO_NUMBERING).
 562
 563        NOTE: The outline level of text nodes is subject to change. The
 564        plan is to have an SwTxtNode::nOutlineLevel member that is
 565        updated from a paragraph style upon appliance of that paragraph
 566        style.
 567
 568        @return outline level or NO_NUMBERING if there is no outline level
 569      */
 570     int GetAttrOutlineLevel() const;//#OutlineLevel,added by zhaojianwei
 571
 572     /**
 573        Sets the out line level *at* a text node.
 574
 575        @param nLevel     the level to be set
 576
 577        If the text node has an outline number the level is set at the
 578        outline number.
 579
 580        If the text node has no outline number but has a paragraph
 581        style applied the outline level is set at the paragraph style.
 582
 583        NOTE: This is subject to change, see GetOutlineLevel.
 584      */
 585     //void SetOutlineLevel(int nLevel);
 586           void SetAttrOutlineLevel(int nLevel);//#OutlineLevel,added by zhaojianwei
 587
 588     // --> OD 2008-11-19 #i70748#
 589     bool IsEmptyListStyleDueToSetOutlineLevelAttr();
 590     void SetEmptyListStyleDueToSetOutlineLevelAttr();
 591     void ResetEmptyListStyleDueToResetOutlineLevelAttr();
 592     // <--
 593
 594     /**
 595        Returns the width of leading tabs/blanks in this paragraph.
 596        This space will be converted into numbering indent if the paragraph
 597        is set to be numbered.
 598
 599        @return     the width of the leading whitespace
 600      */
 601     USHORT GetWidthOfLeadingTabs() const;
 602
 603
 604     /**
 605        Returns if the paragraph has a visible numbering or bullet.
 606        This includes all kinds of numbering/bullet/outlines.
 607        Note: This function returns false, if the numbering format is
 608        SVX_NUM_NUMBER_NONE or if the numbering/bullet has been deleted.
 609
 610        @return     TRUE if the paragraph has a visible numbering/bullet/outline
 611      */
 612     bool HasVisibleNumberingOrBullet() const;
 613
 614     // --> OD 2008-02-19 #refactorlists#
 615     void SetListId( const String sListId );
 616     String GetListId() const;
 617     // <--
 618
 619     /** Determines, if the list level indent attributes can be applied to the
 620         paragraph.
 621
 622         OD 2008-01-17 #newlistlevelattrs#
 623         The list level indents can be applied to the paragraph under the one
 624         of following conditions:
 625         - the list style is directly applied to the paragraph and the paragraph
 626           has no own indent attributes.
 627         - the list style is applied to the paragraph through one of its paragraph
 628           styles, the paragraph has no own indent attributes and on the paragraph
 629           style hierarchy from the paragraph to the paragraph style with the
 630           list style no indent attributes are found.
 631
 632         @author OD
 633
 634         @return boolean
 635     */
 636     bool AreListLevelIndentsApplicable() const;
 637
 638     /** Retrieves the list tab stop position, if the paragraph's list level defines
 639         one and this list tab stop has to merged into the tap stops of the paragraph
 640
 641         OD 2008-01-17 #newlistlevelattrs#
 642
 643         @author OD
 644
 645         @param nListTabStopPosition
 646         output parameter - containing the list tab stop position
 647
 648         @return boolean - indicating, if a list tab stop position is provided
 649     */
 650     bool GetListTabStopPosition( long& nListTabStopPosition ) const;
 651
 652     /** Retrieves the character following the list label, if the paragraph's
 653         list level defines one.
 654
 655         OD 2008-01-17 #newlistlevelattrs#
 656
 657         @author OD
 658
 659         @return XubString - the list tab stop position
 660     */
 661     XubString GetLabelFollowedBy() const;
 662
 663     //
 664     // END OF BULLET/NUMBERING/OUTLINE STUFF:
 665     //
 666
 667     void fillSoftPageBreakList( SwSoftPageBreakList& rBreak ) const;
 668
 669     USHORT GetLang( const xub_StrLen nBegin, const xub_StrLen nLen = 0,
 670                     USHORT nScript = 0 ) const;
 671
 672     // steht in ndcopy.cxx
 673         BOOL IsSymbol( const xub_StrLen nBegin ) const; // steht in itratr.cxx
 674         virtual SwCntntNode* MakeCopy( SwDoc*, const SwNodeIndex& ) const;
 675
 676         // interaktive Trennung: wir finden den TxtFrm und rufen sein CalcHyph
 677         BOOL Hyphenate( SwInterHyphInfo &rHyphInf );
 678         void DelSoftHyph( const xub_StrLen nStart, const xub_StrLen nEnd );
 679
 680     // --> OD 2007-11-15 #i83479#
 681     // add 4th optional parameter <bAddSpaceAfterListLabelStr> indicating,
 682     // when <bWithNum = true> that a space is inserted after the string for
 683     // the list label.
 684     // add 5th optional parameter <bWithSpacesForLevel> indicating, if additional
 685     // spaces are inserted in front of the expanded text string depending on
 686     // the list level.
 687         XubString GetExpandTxt( const xub_StrLen nIdx = 0,
 688                             const xub_StrLen nLen = STRING_LEN,
 689                             const bool bWithNum = false,
 690                             const bool bAddSpaceAfterListLabelStr = false,
 691                             const bool bWithSpacesForLevel = false ) const;
 692     // <--
 693         BOOL GetExpandTxt( SwTxtNode& rDestNd, const SwIndex* pDestIdx = 0,
 694                                                 xub_StrLen nIdx = 0, xub_StrLen nLen = STRING_LEN,
 695                        BOOL bWithNum = FALSE, BOOL bWithFtn = TRUE,
 696                        BOOL bReplaceTabsWithSpaces = FALSE ) const;
 697
 698     /*
 699      *
 700      */
 701     const ModelToViewHelper::ConversionMap*
 702             BuildConversionMap( rtl::OUString& rExpandText ) const;
 703
 704         XubString GetRedlineTxt( xub_StrLen nIdx = 0,
 705                                                   xub_StrLen nLen = STRING_LEN,
 706                                                   BOOL bExpandFlds = FALSE,
 707                                                   BOOL bWithNum = FALSE ) const;
 708         //Liefert fuer die Initalfunktion tatsaechliche Anzahl der Initialzeichen
 709         //bei nWishLen == 0 die des ersten Wortes
 710         USHORT GetDropLen( USHORT nWishLen) const;
 711
 712     // Passes back info needed on the dropcap dimensions
 713     bool GetDropSize(int& rFontHeight, int& rDropHeight, int& rDropDescent) const;
 714
 715
 716     //
 717     // Hidden Paragraph Field:
 718     //
 719     inline BOOL CalcHiddenParaField()
 720         { if(pSwpHints) return pSwpHints->CalcHiddenParaField(); return FALSE; }
 721         // Setzen des CalcVisible-Flags
 722     inline void SetCalcHiddenParaField(){ if(pSwpHints) pSwpHints->SetCalcHiddenParaField(); }
 723
 724         // Ist der Absatz sichtbar
 725     inline BOOL HasHiddenParaField() const
 726         { return pSwpHints ? pSwpHints->HasHiddenParaField() : FALSE; }
 727
 728     //
 729     // Hidden Paragraph Field:
 730     //
 731     inline bool HasHiddenCharAttribute( bool bWholePara ) const
 732     {
 733         if ( bRecalcHiddenCharFlags )
 734             CalcHiddenCharFlags();
 735         return bWholePara ? bHiddenCharsHidePara : bContainsHiddenChars;
 736     }
 737     inline void SetCalcHiddenCharFlags() const { bRecalcHiddenCharFlags = TRUE; }
 738
 739 // --> FME 2004-06-08 #i12836# enhanced pdf
 740     //
 741     // Returns if the node is hidden due to
 742     // 1. HiddenParaField
 743     // 2. HiddenCharAttribute
 744     // 3. HiddenSection
 745     //
 746     bool IsHidden() const;
 747 // <--
 748
 749     inline SwTxtAttr* MakeRedlineTxtAttr( const SfxPoolItem& rNew )
 750         { return MakeTxtAttr( rNew, 0, 0, true ); }
 751
 752         TYPEINFO();     // fuer rtti
 753
 754         // fuers Umhaengen der TxtFmtCollections (Outline-Nummerierung!!)
 755         virtual void Modify( SfxPoolItem*, SfxPoolItem* );
 756
 757         // aus SwIndexReg
 758         virtual void Update( const SwIndex & aPos, USHORT xub_StrLen,
 759                          BOOL bNegativ = FALSE, BOOL bDelete = FALSE );
 760
 761         // change text to Upper/Lower/Hiragana/Katagana/...
 762         void TransliterateText( utl::TransliterationWrapper& rTrans,
 763                                                         xub_StrLen nStart, xub_StrLen nEnd,
 764                                                         SwUndoTransliterate* pUndo = 0 );
 765
 766     // count words in given range
 767     void CountWords( SwDocStat& rStat, xub_StrLen nStart, xub_StrLen nEnd ) const;
 768
 769     // #111840#
 770     /**
 771        Returns position of certain text attribute.
 772
 773        @param pAttr     text attribute to search
 774
 775        @return position of given attribute or NULL in case of failure
 776      */
 777     SwPosition * GetPosition(const SwTxtAttr * pAttr);
 778
 779     // Checks some global conditions like loading or destruction of document
 780     // to economize notifications
 781     bool IsNotificationEnabled() const;
 782
 783     // Checks a temporary notification blocker and the global conditons of IsNotificationEnabled()
 784     bool IsNotifiable() const;
 785
 786     void SetListRestart( bool bRestart );
 787     // --> OD 2005-11-02 #i51089 - TUNING#
 788     bool IsListRestart() const;
 789     // <--
 790
 791     void SetAttrListRestartValue( SwNumberTree::tSwNumTreeNumber nNum );
 792     bool HasAttrListRestartValue() const;
 793     SwNumberTree::tSwNumTreeNumber GetAttrListRestartValue() const;
 794     SwNumberTree::tSwNumTreeNumber GetActualListStartValue() const;
 795
 796     void SetCountedInList( bool bCounted );
 797     bool IsCountedInList() const;
 798
 799     // --> OD 2008-03-13 #refactorlists#
 800 //    void SyncNumberAndNumRule();
 801 //    void UnregisterNumber();
 802     void AddToList();
 803     void RemoveFromList();
 804     bool IsInList() const;
 805     // <--
 806
 807     bool IsFirstOfNumRule() const;
 808
 809         USHORT GetScalingOfSelectedText( xub_StrLen nStt, xub_StrLen nEnd ) const;
 810
 811     DECL_FIXEDMEMPOOL_NEWDEL(SwTxtNode)
 812 };
 813
 814 //-----------------------------------------------------------------------------
 815
 816 inline SwpHints &SwTxtNode::GetSwpHints()
 817 {
 818         ASSERT_ID( pSwpHints, ERR_NOHINTS);
 819         return *pSwpHints;
 820 }
 821 inline const SwpHints &SwTxtNode::GetSwpHints() const
 822 {
 823         ASSERT_ID( pSwpHints, ERR_NOHINTS);
 824         return *pSwpHints;
 825 }
 826
 827 inline SwpHints& SwTxtNode::GetOrCreateSwpHints()
 828 {
 829         if( !pSwpHints )
 830                 pSwpHints = new SwpHints;
 831         return *pSwpHints;
 832 }
 833
 834 inline SwTxtFmtColl* SwTxtNode::GetTxtColl() const
 835 {
 836         return (SwTxtFmtColl*)GetRegisteredIn();
 837 }
 838
 839 // fuer den IBM-Compiler nicht inlinen wg. 42876
 840 #ifndef ICC
 841 // Inline Metoden aus Node.hxx - erst hier ist der TxtNode bekannt !!
 842 inline       SwTxtNode   *SwNode::GetTxtNode()
 843 {
 844          return ND_TEXTNODE == nNodeType ? (SwTxtNode*)this : 0;
 845 }
 846 inline const SwTxtNode   *SwNode::GetTxtNode() const
 847 {
 848          return ND_TEXTNODE == nNodeType ? (const SwTxtNode*)this : 0;
 849 }
 850 #endif
 851
 852 inline void     SwTxtNode::Cut(SwTxtNode *pDest, const SwIndex &rDestStart,
 853                                                         const SwIndex &rStart, xub_StrLen nLen)
 854 {
 855         _Cut( pDest, rDestStart, rStart, nLen, TRUE );
 856 }
 857
 858
 859 #endif