sw/inc/tox.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 #ifndef INCLUDED_SW_INC_TOX_HXX
  20 #define INCLUDED_SW_INC_TOX_HXX
  21
  22 #include <cppuhelper/weakref.hxx>
  23 #include <sal/log.hxx>
  24
  25 #include <i18nlangtag/lang.h>
  26 #include <svl/poolitem.hxx>
  27
  28 #include <editeng/svxenum.hxx>
  29 #include <swtypes.hxx>
  30 #include <toxe.hxx>
  31 #include <calbck.hxx>
  32 #include <o3tl/typed_flags_set.hxx>
  33
  34 #include <vector>
  35
  36 namespace com { namespace sun { namespace star {
  37     namespace text { class XDocumentIndexMark; }
  38 } } }
  39
  40 class SwTOXType;
  41 class SwTOXMark;
  42 class SwTextTOXMark;
  43 class SwDoc;
  44
  45 typedef std::vector<SwTOXMark*> SwTOXMarks;
  46
  47 // Entry of content index, alphabetical index or user defined index
  48
  49 extern const sal_Unicode C_NUM_REPL;
  50 extern const sal_Unicode C_END_PAGE_NUM;
  51 extern const OUString S_PAGE_DELI;
  52
  53 class SW_DLLPUBLIC SwTOXMark
  54     : public SfxPoolItem
  55     , public SwModify
  56 {
  57     friend void InitCore();
  58     friend class SwTextTOXMark;
  59
  60     OUString m_aAltText;    // Text of caption is different.
  61     OUString m_aPrimaryKey;
  62     OUString m_aSecondaryKey;
  63     OUString m_aCitationKeyReading;
  64
  65     // three more strings for phonetic sorting
  66     OUString m_aTextReading;
  67     OUString m_aPrimaryKeyReading;
  68     OUString m_aSecondaryKeyReading;
  69
  70     SwTextTOXMark* m_pTextAttr;
  71
  72     sal_uInt16  m_nLevel;
  73     OUString    m_aBookmarkName;
  74     OUString    m_aEntryTypeName;       // stored specific entry type name for INDEX field \f
  75     bool    m_bAutoGenerated : 1;     // generated using a concordance file
  76     bool    m_bMainEntry : 1;         // main entry emphasized by character style
  77
  78     css::uno::WeakReference<css::text::XDocumentIndexMark> m_wXDocumentIndexMark;
  79
  80     SwTOXMark();                    // to create the default attribute in InitCore
  81
  82 protected:
  83     // SwClient
  84     virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem* pNew ) override;
  85
  86 public:
  87
  88     // single argument ctors shall be explicit.
  89     explicit SwTOXMark( const SwTOXType* pTyp );
  90     virtual ~SwTOXMark() override;
  91
  92     SwTOXMark( const SwTOXMark& rCopy );
  93     SwTOXMark& operator=( const SwTOXMark& rCopy );
  94
  95     // "pure virtual methods" of SfxPoolItem
  96     virtual bool            operator==( const SfxPoolItem& ) const override;
  97     virtual SfxPoolItem*    Clone( SfxItemPool* pPool = nullptr ) const override;
  98
  99     void InvalidateTOXMark();
 100
 101     OUString                GetText() const;
 102
 103     inline bool             IsAlternativeText() const;
 104     inline const OUString&  GetAlternativeText() const;
 105
 106     inline void             SetAlternativeText( const OUString& rAlt );
 107
 108     // content or user defined index
 109     inline void             SetLevel(sal_uInt16 nLevel);
 110     inline sal_uInt16       GetLevel() const;
 111     inline void             SetBookmarkName( const OUString& bName);
 112     inline const OUString&  GetBookmarkName() const;
 113     inline void             SetEntryTypeName( const OUString& sName);
 114     inline const OUString&  GetEntryTypeName() const;
 115
 116     // for alphabetical index only
 117     inline void             SetPrimaryKey(const OUString& rStr );
 118     inline void             SetSecondaryKey(const OUString& rStr);
 119     inline void             SetTextReading(const OUString& rStr);
 120     inline void             SetPrimaryKeyReading(const OUString& rStr );
 121     inline void             SetSecondaryKeyReading(const OUString& rStr);
 122     inline void             SetCitationKeyReading(const OUString& rStr);
 123
 124     inline OUString const & GetPrimaryKey() const;
 125     inline OUString const & GetSecondaryKey() const;
 126     inline OUString const & GetTextReading() const;
 127     inline OUString const & GetPrimaryKeyReading() const;
 128     inline OUString const & GetSecondaryKeyReading() const;
 129
 130     bool                    IsAutoGenerated() const {return m_bAutoGenerated;}
 131     void                    SetAutoGenerated(bool bSet) {m_bAutoGenerated = bSet;}
 132
 133     bool                    IsMainEntry() const {return m_bMainEntry;}
 134     void                    SetMainEntry(bool bSet) { m_bMainEntry = bSet;}
 135
 136     inline const SwTOXType*    GetTOXType() const;
 137
 138     const SwTextTOXMark* GetTextTOXMark() const   { return m_pTextAttr; }
 139           SwTextTOXMark* GetTextTOXMark()         { return m_pTextAttr; }
 140
 141     SAL_DLLPRIVATE css::uno::WeakReference<css::text::XDocumentIndexMark> const& GetXTOXMark() const
 142             { return m_wXDocumentIndexMark; }
 143     SAL_DLLPRIVATE void SetXTOXMark(css::uno::Reference<css::text::XDocumentIndexMark> const& xMark)
 144             { m_wXDocumentIndexMark = xMark; }
 145     void DeRegister() { GetRegisteredInNonConst()->Remove( this ); }
 146     void RegisterToTOXType( SwTOXType& rMark );
 147     static void InsertTOXMarks( SwTOXMarks& aMarks, const SwTOXType& rType );
 148 };
 149
 150 // index types
 151 class SwTOXType : public SwModify
 152 {
 153 public:
 154     SwTOXType(TOXTypes eTyp, const OUString& aName);
 155
 156     // @@@ public copy ctor, but no copy assignment?
 157     SwTOXType(const SwTOXType& rCopy);
 158
 159     inline const OUString&  GetTypeName() const;
 160     inline TOXTypes         GetType() const;
 161
 162 private:
 163     OUString        m_aName;
 164     TOXTypes        m_eType;
 165
 166     // @@@ public copy ctor, but no copy assignment?
 167     SwTOXType & operator= (const SwTOXType &) = delete;
 168 };
 169
 170 // Structure of the index lines
 171 #define FORM_TITLE              0
 172 #define FORM_ALPHA_DELIMITTER   1
 173 #define FORM_PRIMARY_KEY        2
 174 #define FORM_SECONDARY_KEY      3
 175 #define FORM_ENTRY              4
 176
 177 /*
 178  Pattern structure
 179
 180  <E#> - entry number                    <E# CharStyleName,PoolId>
 181  <ET> - entry text                      <ET CharStyleName,PoolId>
 182  <E>  - entry text and number           <E CharStyleName,PoolId>
 183  <T>  - tab stop                        <T,,Position,Adjust>
 184  <C>  - chapter info n = {0, 1, 2, 3, 4 } values of SwChapterFormat <C CharStyleName,PoolId>
 185  <TX> - text token                      <X CharStyleName,PoolId, TOX_STYLE_DELIMITERTextContentTOX_STYLE_DELIMITER>
 186  <#>  - Page number                     <# CharStyleName,PoolId>
 187  <LS> - Link start                      <LS>
 188  <LE> - Link end                        <LE>
 189  <A00> - Authority entry field          <A02 CharStyleName, PoolId>
 190  */
 191
 192 // These enum values are stored and must not be changed!
 193 enum FormTokenType
 194 {
 195     TOKEN_ENTRY_NO,
 196     TOKEN_ENTRY_TEXT,
 197     TOKEN_ENTRY,
 198     TOKEN_TAB_STOP,
 199     TOKEN_TEXT,
 200     TOKEN_PAGE_NUMS,
 201     TOKEN_CHAPTER_INFO,
 202     TOKEN_LINK_START,
 203     TOKEN_LINK_END,
 204     TOKEN_AUTHORITY,
 205     TOKEN_END
 206 };
 207
 208 struct SW_DLLPUBLIC SwFormToken
 209 {
 210     OUString        sText;
 211     OUString        sCharStyleName;
 212     SwTwips         nTabStopPosition;
 213     FormTokenType   eTokenType;
 214     sal_uInt16          nPoolId;
 215     SvxTabAdjust    eTabAlign;
 216     sal_uInt16          nChapterFormat;     //SwChapterFormat;
 217     sal_uInt16          nOutlineLevel;//the maximum permitted outline level in numbering
 218     sal_uInt16          nAuthorityField;    //enum ToxAuthorityField
 219     sal_Unicode     cTabFillChar;
 220     bool        bWithTab;      // true: do generate tab
 221                                    // character only the tab stop
 222                                    // #i21237#
 223
 224     SwFormToken(FormTokenType eType ) :
 225         nTabStopPosition(0),
 226         eTokenType(eType),
 227         nPoolId(USHRT_MAX),
 228         eTabAlign( SvxTabAdjust::Left ),
 229         nChapterFormat(0 /*CF_NUMBER*/),
 230         nOutlineLevel(MAXLEVEL),   //default to maximum outline level
 231         nAuthorityField(0 /*AUTH_FIELD_IDENTIFIER*/),
 232         cTabFillChar(' '),
 233         bWithTab(true)  // #i21237#
 234     {}
 235
 236     OUString GetString() const;
 237 };
 238
 239 struct SwFormTokenEqualToFormTokenType
 240 {
 241     FormTokenType eType;
 242
 243     SwFormTokenEqualToFormTokenType(FormTokenType _eType) : eType(_eType) {}
 244     bool operator()(const SwFormToken & rToken)
 245     {
 246         return rToken.eTokenType == eType;
 247     }
 248 };
 249
 250 /// Vector of tokens.
 251 typedef std::vector<SwFormToken> SwFormTokens;
 252
 253 /**
 254    Helper class that converts vectors of tokens to strings and vice
 255    versa.
 256  */
 257 class SW_DLLPUBLIC SwFormTokensHelper
 258 {
 259     /// the tokens
 260     SwFormTokens m_Tokens;
 261
 262 public:
 263     /**
 264        constructor
 265
 266        @param rStr   string representation of the tokens
 267     */
 268     SwFormTokensHelper(const OUString & rStr);
 269
 270     /**
 271        Returns vector of tokens.
 272
 273        @return vector of tokens
 274     */
 275     const SwFormTokens & GetTokens() const { return m_Tokens; }
 276 };
 277
 278 class SW_DLLPUBLIC SwForm
 279 {
 280     SwFormTokens    m_aPattern[ AUTH_TYPE_END + 1 ]; // #i21237#
 281     OUString  m_aTemplate[ AUTH_TYPE_END + 1 ];
 282
 283     TOXTypes    m_eType;
 284     sal_uInt16      m_nFormMaxLevel;
 285
 286     bool    m_bIsRelTabPos : 1;
 287     bool    m_bCommaSeparated : 1;
 288
 289 public:
 290     SwForm( TOXTypes eTOXType = TOX_CONTENT );
 291     SwForm( const SwForm& rForm );
 292
 293     SwForm& operator=( const SwForm& rForm );
 294
 295     inline void SetTemplate(sal_uInt16 nLevel, const OUString& rName);
 296     inline OUString const & GetTemplate(sal_uInt16 nLevel) const;
 297
 298     // #i21237#
 299     void    SetPattern(sal_uInt16 nLevel, const SwFormTokens& rName);
 300     void    SetPattern(sal_uInt16 nLevel, const OUString& rStr);
 301     const SwFormTokens& GetPattern(sal_uInt16 nLevel) const;
 302
 303     // fill tab stop positions from template to pattern- #i21237#
 304     void AdjustTabStops( SwDoc& rDoc );
 305
 306     inline TOXTypes GetTOXType() const;
 307     inline sal_uInt16   GetFormMax() const;
 308
 309     bool IsRelTabPos() const    {   return m_bIsRelTabPos; }
 310     void SetRelTabPos( bool b ) {   m_bIsRelTabPos = b;       }
 311
 312     bool IsCommaSeparated() const       { return m_bCommaSeparated;}
 313     void SetCommaSeparated( bool b)     { m_bCommaSeparated = b;}
 314
 315     static sal_uInt16 GetFormMaxLevel( TOXTypes eType );
 316
 317     static OUString GetFormEntry();
 318     static OUString GetFormTab();
 319     static OUString GetFormPageNums();
 320     static OUString GetFormLinkStt();
 321     static OUString GetFormLinkEnd();
 322     static OUString GetFormEntryNum();
 323     static OUString GetFormEntryText();
 324     static OUString GetFormChapterMark();
 325     static OUString GetFormText();
 326     static OUString GetFormAuth();
 327 };
 328
 329 // Content to create indexes of
 330 enum class SwTOXElement : sal_uInt16
 331 {
 332     NONE                  = 0x0000,
 333     Mark                  = 0x0001,
 334     OutlineLevel          = 0x0002,
 335     Template              = 0x0004,
 336     Ole                   = 0x0008,
 337     Table                 = 0x0010,
 338     Graphic               = 0x0020,
 339     Frame                 = 0x0040,
 340     Sequence              = 0x0080,
 341     TableLeader           = 0x0100,
 342     TableInToc            = 0x0200,
 343     Bookmark              = 0x0400,
 344     Newline               = 0x0800,
 345     ParagraphOutlineLevel = 0x1000,
 346     IndexEntryType        = 0x2000,
 347 };
 348 namespace o3tl {
 349     template<> struct typed_flags<SwTOXElement> : is_typed_flags<SwTOXElement, 0x3fff> {};
 350 }
 351
 352 enum class SwTOIOptions : sal_uInt16
 353 {
 354     NONE            = 0x00,
 355     SameEntry       = 0x01,
 356     FF              = 0x02,
 357     CaseSensitive   = 0x04,
 358     KeyAsEntry      = 0x08,
 359     AlphaDelimiter  = 0x10,
 360     Dash            = 0x20,
 361     InitialCaps     = 0x40,
 362 };
 363 namespace o3tl {
 364     template<> struct typed_flags<SwTOIOptions> : is_typed_flags<SwTOIOptions, 0x7f> {};
 365 }
 366
 367 //which part of the caption is to be displayed
 368 enum SwCaptionDisplay
 369 {
 370     CAPTION_COMPLETE,
 371     CAPTION_NUMBER,
 372     CAPTION_TEXT
 373 };
 374
 375 enum class SwTOOElements : sal_uInt16
 376 {
 377     NONE            = 0x00,
 378     Math            = 0x01,
 379     Chart           = 0x02,
 380     Calc            = 0x08,
 381     DrawImpress     = 0x10,
 382     Other           = 0x80,
 383 };
 384 namespace o3tl {
 385     template<> struct typed_flags<SwTOOElements> : is_typed_flags<SwTOOElements, 0x9b> {};
 386 }
 387
 388 #define TOX_STYLE_DELIMITER u'\x0001'
 389
 390 // Class for all indexes
 391 class SW_DLLPUBLIC SwTOXBase : public SwClient
 392 {
 393     SwForm      m_aForm;              // description of the lines
 394     OUString    m_aName;              // unique name
 395     OUString    m_aTitle;             // title
 396     OUString    m_aBookmarkName;      //Bookmark Name
 397     OUString    m_aEntryTypeName;   // Type name
 398
 399     OUString    m_sMainEntryCharStyle; // name of the character style applied to main index entries
 400
 401     OUString    m_aStyleNames[MAXLEVEL]; // (additional) style names TOX_CONTENT, TOX_USER
 402     OUString    m_sSequenceName;      // FieldTypeName of a caption sequence
 403
 404     LanguageType    m_eLanguage;
 405     OUString        m_sSortAlgorithm;
 406
 407     union {
 408         sal_uInt16      nLevel;             // consider outline levels
 409         SwTOIOptions    nOptions;           // options of alphabetical index
 410     } m_aData;
 411
 412     SwTOXElement     m_nCreateType;        // sources to create the index from
 413     SwTOOElements    m_nOLEOptions;        // OLE sources
 414     SwCaptionDisplay m_eCaptionDisplay;
 415     bool        m_bProtected : 1;         // index protected ?
 416     bool        m_bFromChapter : 1;       // create from chapter or document
 417     bool        m_bFromObjectNames : 1;   // create a table or object index
 418                                     // from the names rather than the caption
 419     bool        m_bLevelFromChapter : 1; // User index: get the level from the source chapter
 420
 421 protected:
 422     // Add a data member, for record the TOC field expression of MS Word binary format
 423     // For keeping fidelity and may giving a better exporting performance
 424     OUString maMSTOCExpression;
 425     bool mbKeepExpression;
 426
 427 public:
 428     SwTOXBase( const SwTOXType* pTyp, const SwForm& rForm,
 429                SwTOXElement nCreaType, const OUString& rTitle );
 430     SwTOXBase( const SwTOXBase& rCopy, SwDoc* pDoc = nullptr );
 431     virtual ~SwTOXBase() override;
 432
 433     virtual bool GetInfo( SfxPoolItem& rInfo ) const override;
 434
 435     // a kind of CopyCtor - check if the TOXBase is at TOXType of the doc.
 436     // If not, so create it an copy all other used things.
 437     void                CopyTOXBase( SwDoc*, const SwTOXBase& );
 438
 439     const SwTOXType*    GetTOXType() const;
 440
 441     SwTOXElement        GetCreateType() const;      // creation types
 442
 443     const OUString&     GetTOXName() const {return m_aName;}
 444     void                SetTOXName(const OUString& rSet) {m_aName = rSet;}
 445
 446     // for record the TOC field expression of MS Word binary format
 447     const OUString&     GetMSTOCExpression() const{return maMSTOCExpression;}
 448     void                SetMSTOCExpression(const OUString& rExp) {maMSTOCExpression = rExp;}
 449     void                EnableKeepExpression() {mbKeepExpression = true;}
 450     void                DisableKeepExpression() {mbKeepExpression = false;}
 451
 452     const OUString&     GetTitle() const;           // Title
 453     const OUString&     GetBookmarkName() const;
 454     OUString            GetTypeName() const;        // Name
 455     const SwForm&       GetTOXForm() const;         // description of the lines
 456
 457     void                SetCreate(SwTOXElement);
 458     void                SetTitle(const OUString& rTitle);
 459     void                SetTOXForm(const SwForm& rForm);
 460     void                SetBookmarkName(const OUString& bName);
 461
 462     TOXTypes            GetType() const;
 463
 464     const OUString&     GetMainEntryCharStyle() const {return m_sMainEntryCharStyle;}
 465     void                SetMainEntryCharStyle(const OUString& rSet)  {m_sMainEntryCharStyle = rSet;}
 466
 467     // for record the Index field expression of MS Word
 468     const OUString&     GetEntryTypeName() const;
 469     void  SetEntryTypeName(const OUString& sName);
 470
 471     // content index only
 472     inline void             SetLevel(sal_uInt16);                   // consider outline level
 473     inline sal_uInt16       GetLevel() const;
 474
 475     // alphabetical index only
 476     inline SwTOIOptions     GetOptions() const;                 // alphabetical index options
 477     inline void             SetOptions(SwTOIOptions nOpt);
 478
 479     // index of objects
 480     SwTOOElements           GetOLEOptions() const {return m_nOLEOptions;}
 481     void                    SetOLEOptions(SwTOOElements nOpt) {m_nOLEOptions = nOpt;}
 482
 483     // index of objects
 484
 485     OUString const &        GetStyleNames(sal_uInt16 nLevel) const
 486                                 {
 487                                 SAL_WARN_IF( nLevel >= MAXLEVEL, "sw", "Which level?");
 488                                 return m_aStyleNames[nLevel];
 489                                 }
 490     void                    SetStyleNames(const OUString& rSet, sal_uInt16 nLevel)
 491                                 {
 492                                 SAL_WARN_IF( nLevel >= MAXLEVEL, "sw", "Which level?");
 493                                 m_aStyleNames[nLevel] = rSet;
 494                                 }
 495     bool                    IsFromChapter() const { return m_bFromChapter;}
 496     void                    SetFromChapter(bool bSet) { m_bFromChapter = bSet;}
 497
 498     bool                    IsFromObjectNames() const {return m_bFromObjectNames;}
 499     void                    SetFromObjectNames(bool bSet) {m_bFromObjectNames = bSet;}
 500
 501     bool                    IsLevelFromChapter() const {return m_bLevelFromChapter;}
 502     void                    SetLevelFromChapter(bool bSet) {m_bLevelFromChapter = bSet;}
 503
 504     bool                    IsProtected() const { return m_bProtected; }
 505     void                    SetProtected(bool bSet) { m_bProtected = bSet; }
 506
 507     const OUString&         GetSequenceName() const {return m_sSequenceName;}
 508     void                    SetSequenceName(const OUString& rSet) {m_sSequenceName = rSet;}
 509
 510     SwCaptionDisplay        GetCaptionDisplay() const { return m_eCaptionDisplay;}
 511     void                    SetCaptionDisplay(SwCaptionDisplay eSet) {m_eCaptionDisplay = eSet;}
 512
 513     bool                    IsTOXBaseInReadonly() const;
 514
 515     const SfxItemSet*       GetAttrSet() const;
 516     void                    SetAttrSet( const SfxItemSet& );
 517
 518     LanguageType    GetLanguage() const {return m_eLanguage;}
 519     void            SetLanguage(LanguageType nLang)  {m_eLanguage = nLang;}
 520
 521     const OUString&         GetSortAlgorithm()const {return m_sSortAlgorithm;}
 522     void            SetSortAlgorithm(const OUString& rSet) {m_sSortAlgorithm = rSet;}
 523     // #i21237#
 524     void AdjustTabStops( SwDoc & rDoc )
 525     {
 526         m_aForm.AdjustTabStops( rDoc );
 527     }
 528
 529     SwTOXBase& operator=(const SwTOXBase& rSource);
 530     void RegisterToTOXType( SwTOXType& rMark );
 531 };
 532
 533 //SwTOXMark
 534
 535 inline const OUString& SwTOXMark::GetAlternativeText() const
 536     {   return m_aAltText;    }
 537
 538 inline const OUString& SwTOXMark::GetBookmarkName() const
 539     {   return m_aBookmarkName;    }
 540
 541 inline const OUString& SwTOXMark::GetEntryTypeName() const
 542     {   return m_aEntryTypeName;    }
 543
 544 inline const SwTOXType* SwTOXMark::GetTOXType() const
 545     { return static_cast<const SwTOXType*>(GetRegisteredIn()); }
 546
 547 inline bool SwTOXMark::IsAlternativeText() const
 548     { return !m_aAltText.isEmpty(); }
 549
 550 inline void SwTOXMark::SetAlternativeText(const OUString& rAlt)
 551 {
 552     m_aAltText = rAlt;
 553 }
 554
 555 inline void SwTOXMark::SetBookmarkName(const OUString& bName)
 556 {
 557     m_aBookmarkName = bName;
 558 }
 559
 560 inline void SwTOXMark::SetEntryTypeName(const OUString& sName)
 561 {
 562     m_aEntryTypeName = sName;
 563 }
 564 inline void SwTOXMark::SetLevel( sal_uInt16 nLvl )
 565 {
 566     SAL_WARN_IF( GetTOXType() && GetTOXType()->GetType() == TOX_INDEX, "sw", "Wrong type");
 567     m_nLevel = nLvl;
 568 }
 569
 570 inline void SwTOXMark::SetPrimaryKey( const OUString& rKey )
 571 {
 572     SAL_WARN_IF( GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 573     m_aPrimaryKey = rKey;
 574 }
 575
 576 inline void SwTOXMark::SetSecondaryKey( const OUString& rKey )
 577 {
 578     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 579     m_aSecondaryKey = rKey;
 580 }
 581
 582 inline void SwTOXMark::SetTextReading( const OUString& rText )
 583 {
 584     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 585     m_aTextReading = rText;
 586 }
 587
 588 inline void SwTOXMark::SetPrimaryKeyReading( const OUString& rKey )
 589 {
 590     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 591     m_aPrimaryKeyReading = rKey;
 592 }
 593
 594 inline void SwTOXMark::SetCitationKeyReading( const OUString& rKey )
 595 {
 596     SAL_WARN_IF(GetTOXType()->GetType() != TOX_CITATION, "sw", "Wrong type");
 597     m_aCitationKeyReading = rKey;
 598 }
 599
 600 inline void SwTOXMark::SetSecondaryKeyReading( const OUString& rKey )
 601 {
 602     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 603     m_aSecondaryKeyReading = rKey;
 604 }
 605
 606 inline sal_uInt16 SwTOXMark::GetLevel() const
 607 {
 608     SAL_WARN_IF( GetTOXType() && GetTOXType()->GetType() == TOX_INDEX, "sw", "Wrong type");
 609     return m_nLevel;
 610 }
 611
 612 inline OUString const & SwTOXMark::GetPrimaryKey() const
 613 {
 614     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 615     return m_aPrimaryKey;
 616 }
 617
 618 inline OUString const & SwTOXMark::GetSecondaryKey() const
 619 {
 620     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 621     return m_aSecondaryKey;
 622 }
 623
 624 inline OUString const & SwTOXMark::GetTextReading() const
 625 {
 626     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 627     return m_aTextReading;
 628 }
 629
 630 inline OUString const & SwTOXMark::GetPrimaryKeyReading() const
 631 {
 632     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 633     return m_aPrimaryKeyReading;
 634 }
 635
 636 inline OUString const & SwTOXMark::GetSecondaryKeyReading() const
 637 {
 638     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 639     return m_aSecondaryKeyReading;
 640 }
 641
 642 //SwForm
 643
 644 inline void SwForm::SetTemplate(sal_uInt16 nLevel, const OUString& rTemplate)
 645 {
 646     SAL_WARN_IF(nLevel >= GetFormMax(), "sw", "Index >= GetFormMax()");
 647     m_aTemplate[nLevel] = rTemplate;
 648 }
 649
 650 inline OUString const & SwForm::GetTemplate(sal_uInt16 nLevel) const
 651 {
 652     SAL_WARN_IF(nLevel >= GetFormMax(), "sw", "Index >= GetFormMax()");
 653     return m_aTemplate[nLevel];
 654 }
 655
 656 inline TOXTypes SwForm::GetTOXType() const
 657 {
 658     return m_eType;
 659 }
 660
 661 inline sal_uInt16 SwForm::GetFormMax() const
 662 {
 663     return m_nFormMaxLevel;
 664 }
 665
 666 //SwTOXType
 667
 668 inline const OUString& SwTOXType::GetTypeName() const
 669     {   return m_aName;   }
 670
 671 inline TOXTypes SwTOXType::GetType() const
 672     {   return m_eType;   }
 673
 674 // SwTOXBase
 675
 676 inline const SwTOXType* SwTOXBase::GetTOXType() const
 677     { return static_cast<const SwTOXType*>(GetRegisteredIn()); }
 678
 679 inline SwTOXElement SwTOXBase::GetCreateType() const
 680     { return m_nCreateType; }
 681
 682 inline const OUString& SwTOXBase::GetTitle() const
 683     { return m_aTitle; }
 684
 685 inline const OUString& SwTOXBase::GetBookmarkName() const
 686     { return m_aBookmarkName; }
 687
 688 inline const OUString& SwTOXBase::GetEntryTypeName() const
 689     { return m_aEntryTypeName; }
 690
 691 inline OUString SwTOXBase::GetTypeName() const
 692     { return GetTOXType()->GetTypeName();  }
 693
 694 inline const SwForm& SwTOXBase::GetTOXForm() const
 695     { return m_aForm; }
 696
 697 inline void SwTOXBase::SetCreate(SwTOXElement nCreate)
 698     { m_nCreateType = nCreate; }
 699
 700 inline void SwTOXBase::SetTOXForm(const SwForm& rForm)
 701     {  m_aForm = rForm; }
 702
 703 inline TOXTypes SwTOXBase::GetType() const
 704     { return GetTOXType()->GetType(); }
 705
 706 inline void SwTOXBase::SetLevel(sal_uInt16 nLev)
 707 {
 708     SAL_WARN_IF(GetTOXType()->GetType() == TOX_INDEX, "sw", "Wrong type");
 709     m_aData.nLevel = nLev;
 710 }
 711
 712 inline sal_uInt16 SwTOXBase::GetLevel() const
 713 {
 714     SAL_WARN_IF(GetTOXType()->GetType() == TOX_INDEX, "sw", "Wrong type");
 715     return m_aData.nLevel;
 716 }
 717
 718 inline SwTOIOptions SwTOXBase::GetOptions() const
 719 {
 720     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 721     return m_aData.nOptions;
 722 }
 723
 724 inline void SwTOXBase::SetOptions(SwTOIOptions nOpt)
 725 {
 726     SAL_WARN_IF(GetTOXType()->GetType() != TOX_INDEX, "sw", "Wrong type");
 727     m_aData.nOptions = nOpt;
 728 }
 729
 730 #endif // INCLUDED_SW_INC_TOX_HXX
 731
 732 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */