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