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