sw/inc/IDocumentSettingAccess.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
  20 #pragma once
  21
  22 #include <sal/types.h>
  23 #include "fldupde.hxx"
  24 #include <i18nlangtag/lang.h>
  25 #include <memory>
  26
  27 class SvxForbiddenCharactersTable;
  28 namespace com::sun::star::i18n
  29 {
  30 struct ForbiddenCharacters;
  31 }
  32 enum class CharCompressType;
  33
  34 enum class DocumentSettingId
  35 {
  36     // COMPATIBILITY FLAGS START
  37     PARA_SPACE_MAX,
  38     PARA_SPACE_MAX_AT_PAGES,
  39
  40     TAB_COMPAT,
  41
  42     ADD_FLY_OFFSETS,
  43     ADD_VERTICAL_FLY_OFFSETS,
  44
  45     OLD_NUMBERING,
  46
  47     ADD_EXT_LEADING,
  48     USE_VIRTUAL_DEVICE,
  49     USE_HIRES_VIRTUAL_DEVICE,
  50     OLD_LINE_SPACING,
  51     ADD_PARA_SPACING_TO_TABLE_CELLS,
  52     ADD_PARA_LINE_SPACING_TO_TABLE_CELLS,
  53     USE_FORMER_OBJECT_POS,
  54     USE_FORMER_TEXT_WRAPPING,
  55     CONSIDER_WRAP_ON_OBJECT_POSITION,
  56
  57     IGNORE_FIRST_LINE_INDENT_IN_NUMBERING,
  58     DO_NOT_JUSTIFY_LINES_WITH_MANUAL_BREAK,
  59     TREAT_SINGLE_COLUMN_BREAK_AS_PAGE_BREAK,
  60     DO_NOT_RESET_PARA_ATTRS_FOR_NUM_FONT,
  61
  62     DO_NOT_CAPTURE_DRAW_OBJS_ON_PAGE,
  63     TABLE_ROW_KEEP,
  64     IGNORE_TABS_AND_BLANKS_FOR_LINE_CALCULATION,
  65     CLIP_AS_CHARACTER_ANCHORED_WRITER_FLY_FRAME,
  66
  67     // tdf#104349 tdf#104668
  68     MS_WORD_COMP_TRAILING_BLANKS,
  69     // tdf#128197 MS Word in some modes can have line height based on shape height, not on font
  70     MS_WORD_COMP_MIN_LINE_HEIGHT_BY_FLY,
  71     UNIX_FORCE_ZERO_EXT_LEADING,
  72     TABS_RELATIVE_TO_INDENT,
  73     PROTECT_FORM,
  74     // #i89181#
  75     TAB_AT_LEFT_INDENT_FOR_PARA_IN_LIST,
  76     INVERT_BORDER_SPACING,
  77     COLLAPSE_EMPTY_CELL_PARA,
  78     SMALL_CAPS_PERCENTAGE_66,
  79     TAB_OVERFLOW,
  80     UNBREAKABLE_NUMBERINGS,
  81     CLIPPED_PICTURES,
  82     BACKGROUND_PARA_OVER_DRAWINGS,
  83     TAB_OVER_MARGIN,
  84     TAB_OVER_SPACING,
  85     // MS Word still wraps text around objects with less space than LO would.
  86     SURROUND_TEXT_WRAP_SMALL,
  87     PROP_LINE_SPACING_SHRINKS_FIRST_LINE,
  88     SUBTRACT_FLYS,
  89     // tdf#112443 disable off-page content positioning
  90     DISABLE_OFF_PAGE_POSITIONING,
  91     EMPTY_DB_FIELD_HIDES_PARA,
  92     // tdf#129448: Auto first-line indent should not be effected by line space
  93     AUTO_FIRST_LINE_INDENT_DISREGARD_LINE_SPACE,
  94     HYPHENATE_URLS, ///< tdf#152952
  95     DO_NOT_BREAK_WRAPPED_TABLES,
  96     ALLOW_TEXT_AFTER_FLOATING_TABLE_BREAK,
  97     // COMPATIBILITY FLAGS END
  98     BROWSE_MODE,
  99     HTML_MODE,
 100     GLOBAL_DOCUMENT,
 101     GLOBAL_DOCUMENT_SAVE_LINKS,
 102     LABEL_DOCUMENT,
 103     PURGE_OLE,
 104     KERN_ASIAN_PUNCTUATION,
 105     MATH_BASELINE_ALIGNMENT,
 106     STYLES_NODEFAULT,
 107     FLOATTABLE_NOMARGINS,
 108     EMBED_FONTS,
 109     EMBED_USED_FONTS,
 110     EMBED_LATIN_SCRIPT_FONTS,
 111     EMBED_ASIAN_SCRIPT_FONTS,
 112     EMBED_COMPLEX_SCRIPT_FONTS,
 113     EMBED_SYSTEM_FONTS,
 114     APPLY_PARAGRAPH_MARK_FORMAT_TO_NUMBERING,
 115     CONTINUOUS_ENDNOTES,
 116     PROTECT_BOOKMARKS,
 117     PROTECT_FIELDS,
 118     HEADER_SPACING_BELOW_LAST_PARA,
 119     FRAME_AUTOWIDTH_WITH_MORE_PARA,
 120     GUTTER_AT_TOP,
 121     // footnoteContainer default position is the page end instead of the column end
 122     // only if "evenly distributed" is set, and "collected at the end" is not set
 123     FOOTNOTE_IN_COLUMN_TO_PAGEEND,
 124     // Should we display follow by symbol for numbered paragraph if numbering exists, but "None"?
 125     NO_NUMBERING_SHOW_FOLLOWBY,
 126     // drop cap punctuation: smaller dashes, bullet, asterisks, quotation marks etc.
 127     // by extending the rounding box of the glyph to the baseline
 128     DROP_CAP_PUNCTUATION,
 129 };
 130
 131 /** Provides access to settings of a document
 132  */
 133 class IDocumentSettingAccess
 134 {
 135 public:
 136     /** Return the specified document setting.
 137
 138        @param id
 139        [in] the identifier of the document setting to be returned.
 140        See above for a list of valid document setting identifiers.
 141
 142        @returns
 143        the value of the requested document setting.
 144     */
 145     virtual bool get(/*[in]*/ DocumentSettingId id) const = 0;
 146
 147     /** Set the specified document setting.
 148
 149         @param id
 150         [in] the identifier of the document setting to be set.
 151         See above for a list of valid document setting identifiers.
 152
 153         @param value
 154         [in] the new value of the specified document setting.
 155     */
 156     virtual void set(/*[in]*/ DocumentSettingId id, /*[in]*/ bool value) = 0;
 157
 158     /** Return the forbidden characters.
 159
 160        @param nLang
 161        [in] the language for which the forbidden character list is returned.
 162
 163        @param bLocaleData
 164        [in] if set and there is no user defined forbidden character list for
 165             language lang, the default list for language lang will be returned.
 166
 167        @returns
 168        a list of forbidden characters.
 169     */
 170     virtual const css::i18n::ForbiddenCharacters*
 171     getForbiddenCharacters(/*[in]*/ LanguageType nLang, /*[in]*/ bool bLocaleData) const = 0;
 172
 173     /** Set the forbidden characters.
 174
 175        @param nLang
 176        [in] the language for which the forbidden character list should be set.
 177
 178        @param rForbiddenCharacters
 179        [in] the new list of forbidden characters for language lang.
 180     */
 181     virtual void
 182     setForbiddenCharacters(/*[in]*/ LanguageType nLang,
 183                            /*[in]*/ const css::i18n::ForbiddenCharacters& rForbiddenCharacters)
 184         = 0;
 185
 186     /** Get the forbidden character table and creates one if necessary.
 187
 188        @returns
 189        the forbidden characters table.
 190     */
 191     virtual std::shared_ptr<SvxForbiddenCharactersTable>& getForbiddenCharacterTable() = 0;
 192
 193     /** Get the forbidden character table.
 194
 195        @returns
 196        the forbidden characters table.
 197     */
 198     virtual const std::shared_ptr<SvxForbiddenCharactersTable>&
 199     getForbiddenCharacterTable() const = 0;
 200
 201     /** Get the current link update mode.
 202
 203        @param bGlobalSettings
 204        [in] if set, the link update mode is obtained from the module,
 205             if it is set to GLOBALSETTING
 206
 207        @returns
 208        the current link update mode.
 209     */
 210     virtual sal_uInt16 getLinkUpdateMode(/*[in]*/ bool bGlobalSettings) const = 0;
 211
 212     /** Set the current link update mode.
 213
 214        @param nMode
 215        [in] the new link update mode.
 216     */
 217     virtual void setLinkUpdateMode(/*[in]*/ sal_uInt16 nMode) = 0;
 218
 219     /** Get the current field update mode.
 220
 221        @param bGlobalSettings
 222        [in] if set, the field update mode is obtained from the module,
 223             if it is set to GLOBALSETTING
 224
 225        @returns
 226        the current field update mode.
 227     */
 228     virtual SwFieldUpdateFlags getFieldUpdateFlags(/*[in]*/ bool bGlobalSettings) const = 0;
 229
 230     /** Set the current field update mode.
 231
 232        @param nMode
 233        [in] the new field update mode.
 234     */
 235     virtual void setFieldUpdateFlags(/*[in]*/ SwFieldUpdateFlags nMode) = 0;
 236
 237     /** Get the character compression type for Asian characters.
 238
 239        @returns
 240        the current character compression mode.
 241     */
 242     virtual CharCompressType getCharacterCompressionType() const = 0;
 243
 244     /** Set the character compression type for Asian characters.
 245
 246        @param nMode
 247        [in] the new character compression type.
 248     */
 249     virtual void setCharacterCompressionType(/*[in]*/ CharCompressType nType) = 0;
 250
 251     /** Get the n32DummyCompatibilityOptions1
 252     */
 253     virtual sal_uInt32 Getn32DummyCompatibilityOptions1() const = 0;
 254
 255     /** Set the n32DummyCompatibilityOptions1
 256     */
 257     virtual void Setn32DummyCompatibilityOptions1(const sal_uInt32 CompatibilityOptions1) = 0;
 258
 259     /** Get the n32DummyCompatibilityOptions2
 260     */
 261     virtual sal_uInt32 Getn32DummyCompatibilityOptions2() const = 0;
 262
 263     /** Set the n32DummyCompatibilityOptions2
 264     */
 265     virtual void Setn32DummyCompatibilityOptions2(const sal_uInt32 CompatibilityOptions2) = 0;
 266
 267     virtual sal_Int32 getImagePreferredDPI() = 0;
 268     virtual void setImagePreferredDPI(sal_Int32 nValue) = 0;
 269
 270 protected:
 271     virtual ~IDocumentSettingAccess(){};
 272 };
 273
 274 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */