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 <unotools/weakref.hxx>
#include <com/sun/star/text/XDocumentIndexMark.hpp>
#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
namespace	sw
	Dialog to specify the properties of date form field.
namespace	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 class	SwTOXElement : sal_uInt16 {   NONE = 0x0000 ,   Mark = 0x0001 ,   OutlineLevel = 0x0002 ,   Template = 0x0004 ,   Ole = 0x0008 ,   Table = 0x0010 ,   Graphic = 0x0020 ,   Frame = 0x0040 ,   Sequence = 0x0080 ,   TableLeader = 0x0100 ,   TableInToc = 0x0200 ,   Bookmark = 0x0400 ,   Newline = 0x0800 ,   ParagraphOutlineLevel = 0x1000 }
enum class	SwTOIOptions : sal_uInt16 {   NONE = 0x00 ,   SameEntry = 0x01 ,   FF = 0x02 ,   CaseSensitive = 0x04 ,   KeyAsEntry = 0x08 ,   AlphaDelimiter = 0x10 ,   Dash = 0x20 ,   InitialCaps = 0x40 }
enum	SwCaptionDisplay {   CAPTION_COMPLETE ,   CAPTION_NUMBER ,   CAPTION_TEXT }
enum class	SwTOOElements : sal_uInt16 {   NONE = 0x00 ,   Math = 0x01 ,   Chart = 0x02 ,   Calc = 0x08 ,   DrawImpress = 0x10 ,   Other = 0x80 }

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

Variables
const sal_Unicode	C_NUM_REPL
const sal_Unicode	C_END_PAGE_NUM

Macro Definition Documentation

FORM_ALPHA_DELIMITER

#define FORM_ALPHA_DELIMITER   1

Definition at line 207 of file tox.hxx.

FORM_ENTRY

#define FORM_ENTRY   4

Definition at line 210 of file tox.hxx.

FORM_PRIMARY_KEY

#define FORM_PRIMARY_KEY   2

Definition at line 208 of file tox.hxx.

FORM_SECONDARY_KEY

#define FORM_SECONDARY_KEY   3

Definition at line 209 of file tox.hxx.

FORM_TITLE

#define FORM_TITLE   0

Definition at line 206 of file tox.hxx.

TOX_STYLE_DELIMITER

#define TOX_STYLE_DELIMITER   u'\x0001'

Definition at line 422 of file tox.hxx.

Typedef Documentation

SwFormTokens

typedef std::vector<SwFormToken> SwFormTokens

Vector of tokens.

Definition at line 286 of file tox.hxx.

SwTOXMarks

typedef std::vector<SwTOXMark*> SwTOXMarks

Definition at line 48 of file tox.hxx.

Enumeration Type Documentation

FormTokenType

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 228 of file tox.hxx.

SwCaptionDisplay

enum SwCaptionDisplay

Enumerator
CAPTION_COMPLETE
CAPTION_NUMBER
CAPTION_TEXT

Definition at line 402 of file tox.hxx.

SwTOIOptions

enum class SwTOIOptions : sal_uInt16

strong

Enumerator
NONE
SameEntry
FF
CaseSensitive
KeyAsEntry
AlphaDelimiter
Dash
InitialCaps

Definition at line 386 of file tox.hxx.

SwTOOElements

enum class SwTOOElements : sal_uInt16

strong

Enumerator
NONE
Math
Chart
Calc
DrawImpress
Other

Definition at line 409 of file tox.hxx.

SwTOXElement

enum class SwTOXElement : sal_uInt16

strong

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

Definition at line 365 of file tox.hxx.

Variable Documentation

C_END_PAGE_NUM

const sal_Unicode C_END_PAGE_NUM

extern

Definition at line 48 of file tox.cxx.

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

C_NUM_REPL

const sal_Unicode C_NUM_REPL

extern

Definition at line 47 of file tox.cxx.

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