LibreOffice Module sw (master) 1
swtypes.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_SWTYPES_HXX
20#define INCLUDED_SW_INC_SWTYPES_HXX
21#include <rtl/ustring.hxx>
22
23#include <limits.h>
24#include <com/sun/star/uno/Reference.h>
25#include <com/sun/star/i18n/CollatorOptions.hpp>
26#include "swdllapi.h"
29#include <i18nlangtag/lang.h>
30#include <vcl/outdev.hxx>
31#include <unotools/resmgr.hxx>
32
33namespace com::sun::star {
34 namespace linguistic2{
35 class XLinguProperties;
36 class XSpellChecker1;
37 class XHyphenator;
38 class XThesaurus;
39 }
40}
41namespace utl{
42 class TransliterationWrapper;
43}
44
45class Size;
46class SwPathFinder;
47class Graphic;
48class OutputDevice;
49class CharClass;
50class CollatorWrapper;
51class LanguageTag;
52
54#define INVALID_TWIPS LONG_MAX
55#define TWIPS_MAX (LONG_MAX - 1)
56
57constexpr sal_Int32 COMPLETE_STRING = SAL_MAX_INT32;
58
59constexpr SwTwips cMinHdFtHeight = 56; // ~1mm
60
61#define MINFLY 23 // Minimal size for FlyFrames.
62#define MINLAY 23 // Minimal size for other Frames.
63
64// Default column distance of two text columns corresponds to 0.3 cm.
66
67// Minimal distance (distance to text) for border attribute
68// in order not to crock up aligned lines.
69// 28 Twips == 0,5mm
70constexpr SwTwips MIN_BORDER_DIST = 28; // ~0.5mm
71
72// Minimal document border: 20mm.
75
76// Margin left and above document.
77// Half of it is gap between the pages.
78//TODO: Replace with SwViewOption::defDocumentBorder
79constexpr SwTwips DOCUMENTBORDER = 284; // ~5mm
80
81// For inserting of captions (what and where to insert).
82// It's here because it is not big enough to justify its own hxx
83// and does not seem to fit somewhere else.
84enum class SwLabelType
85{
86 Table, // Caption for a table.
87 Object, // Caption for a graphic or OLE.
88 Fly, // Caption for a text frame.
89 Draw // Caption for a draw object.
90};
91
92constexpr sal_uInt8 MAXLEVEL = 10;
93
94// Values for indents at numbering and bullet lists.
95// (For more levels the values have to be multiplied with the levels+1;
96// levels 0 ..4!)
97
98constexpr short lBulletIndent = o3tl::toTwips(25, o3tl::Length::in100); // 0.25 inch
100constexpr sal_uInt16 lNumberIndent = o3tl::toTwips(25, o3tl::Length::in100); // 0.25 inch
102constexpr short lOutlineMinTextDistance = o3tl::toTwips(15, o3tl::Length::in100); // 0.15 inch = 0.38 cm
103
104// Count of SystemField-types of SwDoc.
105#define INIT_FLDTYPES 33
106
107// Count of predefined Seq-field types. It is always the last
108// fields before INIT_FLDTYPES.
109#define INIT_SEQ_FLDTYPES 5
110
111// defined in sw/source/uibase/app/swmodule.cxx
112SW_DLLPUBLIC OUString SwResId(TranslateId aId);
113OUString SwResId(TranslateNId aContextSingularPlural, int nCardinality);
114
115css::uno::Reference< css::linguistic2::XSpellChecker1 > GetSpellChecker();
116css::uno::Reference< css::linguistic2::XHyphenator > GetHyphenator();
117css::uno::Reference< css::linguistic2::XThesaurus > GetThesaurus();
118css::uno::Reference< css::linguistic2::XLinguProperties > GetLinguPropertySet();
119
120// Returns the twip size of this graphic.
122
123// Separator for jumps to different content types in document.
125// Sequences names for jumps are <name of sequence>!<no>
126const char cSequenceMarkSeparator = '!';
129
130#define DB_DELIM u'\x00ff' // Database <-> table separator.
131
132enum class SetAttrMode
133{
134 DEFAULT = 0x0000, // Default.
137 DONTEXPAND = 0x0001, // Don't expand text attribute any further.
138 DONTREPLACE = 0x0002, // Don't replace another text attribute.
139
140 NOTXTATRCHR = 0x0004, // Don't insert 0xFF at attributes with no end.
143 NOHINTADJUST = 0x0008, // No merging of ranges.
144 NOFORMATATTR = 0x0010, // Do not change into format attribute.
145 APICALL = 0x0020, // Called from API (all UI related
146 // functionality will be disabled).
148 FORCEHINTEXPAND = 0x0040,
150 IS_COPY = 0x0080,
152 NOHINTEXPAND = 0x0100,
153};
154namespace o3tl
155{
156 template<> struct typed_flags<SetAttrMode> : is_typed_flags<SetAttrMode, 0x1ff> {};
157}
158
159constexpr bool SW_ISPRINTABLE(sal_Unicode c) { return c >= ' ' && 127 != c; }
160
161#define CHAR_HARDBLANK u'\x00A0'
162#define CHAR_HARDHYPHEN u'\x2011'
163#define CHAR_SOFTHYPHEN u'\x00AD'
164#define CHAR_RLM u'\x200F'
165#define CHAR_LRM u'\x200E'
166#define CHAR_ZWSP u'\x200B'
167#define CHAR_WJ u'\x2060'
168#define CHAR_NNBSP u'\x202F' //NARROW NO-BREAK SPACE
169
170// Returns the APP - CharClass instance - used for all ToUpper/ToLower/...
174
175#if 0
176// I18N doesn't get this right, can't specify more than one to ignore
177#define SW_COLLATOR_IGNORES ( \
178 css::i18n::CollatorOptions::CollatorOptions_IGNORE_CASE | \
179 css::i18n::CollatorOptions::CollatorOptions_IGNORE_KANA | \
180 css::i18n::CollatorOptions::CollatorOptions_IGNORE_WIDTH )
181#else
182#define SW_COLLATOR_IGNORES ( \
183 css::i18n::CollatorOptions::CollatorOptions_IGNORE_CASE )
184#endif
185
188
189SW_DLLPUBLIC const ::utl::TransliterationWrapper& GetAppCmpStrIgnore();
190
191// Official shortcut for Prepare() regarding notification of Content by the Layout.
192// Content provides for calculation of minimal requirements at the next call of ::Format().
193enum class PrepareHint
194{
195 Clear, // Reformat completely.
196 WidowsOrphans, // Only check for widows and orphans and split in case of need.
197 FixSizeChanged, // FixSize has changed.
198 FollowFollows, // Follow is now possibly adjacent.
199 AdjustSizeWithoutFormatting, // Adjust size via grow/shrink without formatting.
200 FlyFrameSizeChanged, // A FlyFrame has changed its size.
201 FlyFrameAttributesChanged, // A FlyFrame has changed its attributes (e. g. wrap).
202 FlyFrameArrive, // A FlyFrame now overlaps range.
203 FlyFrameLeave, // A FlyFrame has left range.
204 FootnoteInvalidation, // Invalidation of footnotes.
205 FramePositionChanged, // Position of Frame has changed.
206 // (Check for Fly-break). In void* of Prepare()
207 // a sal_Bool& is passed. If this is sal_True,
208 // it indicates that a format has been executed.
209 ULSpaceChanged, // UL-Space has changed, TextFrames have to
210 // re-calculate line space.
211 MustFit, // Make frm fit (split) even if the attributes do
212 // not allow that (e.g. "keep together").
213 Widows, // A follow realizes that the orphan rule will be applied
214 // for it and sends a Widows to its predecessor
215 // (Master/Follow).
216 QuoVadis, // If a footnote has to be split between two paragraphs
217 // the last on the page has to receive a QUOVADIS in
218 // order to format the text into it.
219 BossChanged, // If a Frame changes its column/page this additional
220 // Prepare is sent to POS_CHGD in MoveFwd/Bwd
221 // (join Footnote-numbers etc.)
222 // Direction is communicated via pVoid:
223 // MoveFwd: pVoid == 0
224 // MoveBwd: pVoid == pOldPage
225 Register, // Invalidate frames with registers.
226 FootnoteInvalidationGone, // A Follow loses its footnote, possibly its first line can move up.
227 FootnoteMove, // A footnote changes its page. Its contents receives at first a
228 // height of zero in order to avoid too much noise. At formatting
229 // it checks whether it fits and if necessary changes its page again.
230 ErgoSum, // Needed because of movement in FootnoteFrames. Check QuoVadis/ErgoSum.
231};
232
234{
235 PageBreak,
236 Header,
237 Footer,
239 Outline
240};
241
242#endif
243
244/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void Clear(EHistoryType eHistory)
constexpr auto toTwips(N number, Length from)
Header
Footer
long Long
#define SW_DLLPUBLIC
Definition: swdllapi.h:28
SetAttrMode
Definition: swtypes.hxx:133
@ IS_COPY
The inserted item is a copy – intended for use in ndtxt.cxx.
@ NOHINTADJUST
attention: NOHINTADJUST prevents MergePortions! when using this need to pay attention to ignore start...
SW_DLLPUBLIC Size GetGraphicSizeTwip(const Graphic &, vcl::RenderContext *pOutDev)
Definition: swtypes.cxx:28
constexpr sal_uInt16 lNumberIndent
Definition: swtypes.hxx:100
constexpr SwTwips DEF_GUTTER_WIDTH
Definition: swtypes.hxx:65
SW_DLLPUBLICconst ::utl::TransliterationWrapper & GetAppCmpStrIgnore()
Definition: init.cxx:786
tools::Long SwTwips
Definition: swtypes.hxx:51
SwLabelType
Definition: swtypes.hxx:85
constexpr short lNumberFirstLineOffset
Definition: swtypes.hxx:101
constexpr short lBulletIndent
Definition: swtypes.hxx:98
constexpr SwTwips cMinHdFtHeight
Definition: swtypes.hxx:59
constexpr short lOutlineMinTextDistance
Definition: swtypes.hxx:102
constexpr bool SW_ISPRINTABLE(sal_Unicode c)
Definition: swtypes.hxx:159
SW_DLLPUBLIC const LanguageTag & GetAppLanguageTag()
Definition: init.cxx:732
css::uno::Reference< css::linguistic2::XThesaurus > GetThesaurus()
Definition: swtypes.cxx:59
css::uno::Reference< css::linguistic2::XSpellChecker1 > GetSpellChecker()
Definition: swtypes.cxx:52
SW_DLLPUBLIC LanguageType GetAppLanguage()
Definition: init.cxx:725
constexpr SwTwips DOCUMENTBORDER
Definition: swtypes.hxx:79
css::uno::Reference< css::linguistic2::XLinguProperties > GetLinguPropertySet()
Definition: swtypes.cxx:61
CollatorWrapper & GetAppCaseCollator()
Definition: init.cxx:749
sal_Unicode const toxMarkSeparator
separator for toxmarks: #<no>%19<text>%19<type><typename>|toxmark
Definition: swtypes.hxx:128
constexpr sal_Int32 COMPLETE_STRING
Definition: swtypes.hxx:57
const char cSequenceMarkSeparator
Definition: swtypes.hxx:126
PrepareHint
Definition: swtypes.hxx:194
@ FramePositionChanged
@ FootnoteInvalidation
@ FlyFrameAttributesChanged
@ FootnoteInvalidationGone
@ AdjustSizeWithoutFormatting
const sal_Unicode cMarkSeparator
Definition: swtypes.hxx:124
SW_DLLPUBLIC CharClass & GetAppCharClass()
Definition: init.cxx:705
constexpr short lBulletFirstLineOffset
Definition: swtypes.hxx:99
constexpr SwTwips MIN_BORDER_DIST
Definition: swtypes.hxx:70
constexpr SwTwips lMinBorder
Definition: swtypes.hxx:74
constexpr sal_uInt8 MAXLEVEL
Definition: swtypes.hxx:92
SW_DLLPUBLIC CollatorWrapper & GetAppCollator()
Definition: init.cxx:737
constexpr tools::Long lMinBorderInMm(20)
css::uno::Reference< css::linguistic2::XHyphenator > GetHyphenator()
Definition: swtypes.cxx:57
FrameControlType
Definition: swtypes.hxx:234
SW_DLLPUBLIC OUString SwResId(TranslateId aId)
Definition: swmodule.cxx:164
unsigned char sal_uInt8
#define SAL_MAX_INT32
sal_uInt16 sal_Unicode