tox.hxx File Reference

#include <vector>
#include <optional>
#include <cppuhelper/weakref.hxx>
#include <editeng/svxenum.hxx>
#include <i18nlangtag/lang.h>
#include <o3tl/typed_flags_set.hxx>
#include <sal/log.hxx>
#include <svl/listener.hxx>
#include <svl/poolitem.hxx>
#include "calbck.hxx"
#include "hints.hxx"
#include "swtypes.hxx"
#include "toxe.hxx"

Include dependency graph for tox.hxx:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	sw::CollectTextMarksHint
struct	sw::FindContentFrameHint
struct	sw::CollectTextTOXMarksForLayoutHint
class	SwTOXMark
class	SwTOXType
struct	SwFormToken
struct	SwFormTokenEqualToFormTokenType
class	SwFormTokensHelper
	Helper class that converts vectors of tokens to strings and vice versa. More...
class	SwForm
struct	o3tl::typed_flags< SwTOXElement >
struct	o3tl::typed_flags< SwTOIOptions >
struct	o3tl::typed_flags< SwTOOElements >
class	SwTOXBase

Namespaces
	com::sun::star
	com::sun::star::text
	sw
	Dialog to specify the properties of date form field.
	o3tl

Macros
#define	FORM_TITLE   0
#define	FORM_ALPHA_DELIMITER   1
#define	FORM_PRIMARY_KEY   2
#define	FORM_SECONDARY_KEY   3
#define	FORM_ENTRY   4
#define	TOX_STYLE_DELIMITER   u'\x0001'

Typedefs
typedef std::vector< SwTOXMark * >	SwTOXMarks
typedef std::vector< SwFormToken >	SwFormTokens
	Vector of tokens. More...

Enumerations
enum	FormTokenType {   TOKEN_ENTRY_NO,   TOKEN_ENTRY_TEXT,   TOKEN_ENTRY,   TOKEN_TAB_STOP,   TOKEN_TEXT,   TOKEN_PAGE_NUMS,   TOKEN_CHAPTER_INFO,   TOKEN_LINK_START,   TOKEN_LINK_END,   TOKEN_AUTHORITY,   TOKEN_END }
enum	SwTOXElement : sal_uInt16 {   SwTOXElement::NONE = 0x0000,   SwTOXElement::Mark = 0x0001,   SwTOXElement::OutlineLevel = 0x0002,   SwTOXElement::Template = 0x0004,   SwTOXElement::Ole = 0x0008,   SwTOXElement::Table = 0x0010,   SwTOXElement::Graphic = 0x0020,   SwTOXElement::Frame = 0x0040,   SwTOXElement::Sequence = 0x0080,   SwTOXElement::TableLeader = 0x0100,   SwTOXElement::TableInToc = 0x0200,   SwTOXElement::Bookmark = 0x0400,   SwTOXElement::Newline = 0x0800,   SwTOXElement::ParagraphOutlineLevel = 0x1000,   SwTOXElement::IndexEntryType = 0x2000 }
enum	SwTOIOptions : sal_uInt16 {   SwTOIOptions::NONE = 0x00,   SwTOIOptions::SameEntry = 0x01,   SwTOIOptions::FF = 0x02,   SwTOIOptions::CaseSensitive = 0x04,   SwTOIOptions::KeyAsEntry = 0x08,   SwTOIOptions::AlphaDelimiter = 0x10,   SwTOIOptions::Dash = 0x20,   SwTOIOptions::InitialCaps = 0x40 }
enum	SwCaptionDisplay {   CAPTION_COMPLETE,   CAPTION_NUMBER,   CAPTION_TEXT }
enum	SwTOOElements : sal_uInt16 {   SwTOOElements::NONE = 0x00,   SwTOOElements::Math = 0x01,   SwTOOElements::Chart = 0x02,   SwTOOElements::Calc = 0x08,   SwTOOElements::DrawImpress = 0x10,   SwTOOElements::Other = 0x80 }

Functions
auto	sw::PrepareJumpToTOXMark (SwDoc const &rDoc, OUString const &rName) -> std::optional< std::pair< SwTOXMark, sal_Int32 >>

Variables
const sal_Unicode	C_NUM_REPL
const sal_Unicode	C_END_PAGE_NUM

Macro Definition Documentation

#define FORM_ALPHA_DELIMITER   1

Definition at line 210 of file tox.hxx.

Referenced by SwTOXStylesTabPage::ActivatePage(), SwTOXBaseSection::InsertAlphaDelimiter(), and SwTOXBaseSection::UpdateContent().

#define FORM_ENTRY   4

Definition at line 213 of file tox.hxx.

Referenced by SwTOXIndex::GetLevel(), SwTOXIndex::GetText_Impl(), and SwTOXBaseSection::UpdateMarks().

#define FORM_PRIMARY_KEY   2

Definition at line 211 of file tox.hxx.

Referenced by SwTOXIndex::GetLevel(), SwTOXIndex::GetText_Impl(), SwTOXBaseSection::InsertSorted(), and SwTOXBaseSection::UpdateMarks().

#define FORM_SECONDARY_KEY   3

Definition at line 212 of file tox.hxx.

Referenced by SwTOXIndex::GetLevel(), SwTOXIndex::GetText_Impl(), SwTOXBaseSection::InsertSorted(), and SwTOXBaseSection::UpdateMarks().

#define FORM_TITLE   0

Definition at line 209 of file tox.hxx.

Referenced by SwTOXBaseSection::Update().

#define TOX_STYLE_DELIMITER   u'\x0001'

Definition at line 426 of file tox.hxx.

Referenced by SwAuthorityFieldType::AddField(), SwMultiTOXTabDialog::CreateOrUpdateExample(), SwXDocumentIndex::StyleAccess_Impl::getByIndex(), SwFormToken::GetString(), IMPL_LINK_NOARG(), lcl_BuildToken(), lcl_SearchNextToken(), lcl_toxMatchTSwitch(), SwAuthorityField::PutValue(), SwXDocumentIndex::StyleAccess_Impl::replaceByIndex(), AttributeOutputBase::StartTOX(), SwFieldMgr::UpdateCurField(), and SwTOXBaseSection::UpdateTemplate().

Typedef Documentation

typedef std::vector<SwFormToken> SwFormTokens

Vector of tokens.

Definition at line 289 of file tox.hxx.

typedef std::vector<SwTOXMark*> SwTOXMarks

Definition at line 46 of file tox.hxx.

Enumeration Type Documentation

enum FormTokenType

Enumerator
TOKEN_ENTRY_NO
TOKEN_ENTRY_TEXT
TOKEN_ENTRY
TOKEN_TAB_STOP
TOKEN_TEXT
TOKEN_PAGE_NUMS
TOKEN_CHAPTER_INFO
TOKEN_LINK_START
TOKEN_LINK_END
TOKEN_AUTHORITY
TOKEN_END

Definition at line 231 of file tox.hxx.

enum SwCaptionDisplay

Enumerator
CAPTION_COMPLETE
CAPTION_NUMBER
CAPTION_TEXT

Definition at line 406 of file tox.hxx.

enum SwTOIOptions : sal_uInt16

strong

Enumerator
NONE
SameEntry
FF
CaseSensitive
KeyAsEntry
AlphaDelimiter
Dash
InitialCaps

Definition at line 390 of file tox.hxx.

enum SwTOOElements : sal_uInt16

strong

Enumerator
NONE
Math
Chart
Calc
DrawImpress
Other

Definition at line 413 of file tox.hxx.

enum SwTOXElement : sal_uInt16

strong

Enumerator
NONE
Mark
OutlineLevel
Template
Ole
Table
Graphic
Frame
Sequence
TableLeader
TableInToc
Bookmark
Newline
ParagraphOutlineLevel
IndexEntryType

Definition at line 368 of file tox.hxx.

Variable Documentation

const sal_Unicode C_END_PAGE_NUM

Definition at line 47 of file tox.cxx.

Referenced by sw::ToxTextGenerator::ConstructPageNumberPlaceholder(), and SwTOXBaseSection::UpdatePageNum_().

const sal_Unicode C_NUM_REPL

Definition at line 46 of file tox.cxx.

Referenced by sw::ToxTextGenerator::ConstructPageNumberPlaceholder(), and SwTOXBaseSection::UpdatePageNum_().