LCOV - code coverage report
Current view: top level - sw/inc - IDocumentSettingAccess.hxx (source / functions) Hit Total Coverage
Test: commit e02a6cb2c3e2b23b203b422e4e0680877f232636 Lines: 0 2 0.0 %
Date: 2014-04-14 Functions: 0 3 0.0 %
Legend: Lines: hit not hit

          Line data    Source code
       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 <tools/solar.h>
      24             : #include <rtl/ref.hxx>
      25             : #include <chcmprse.hxx>
      26             : #include <fldupde.hxx>
      27             : 
      28             : class SvxForbiddenCharactersTable;
      29             : namespace com { namespace sun { namespace star { namespace i18n { struct ForbiddenCharacters; } } } }
      30             : 
      31             :  /** Provides access to settings of a document
      32             :  */
      33           0 :  class IDocumentSettingAccess
      34             :  {
      35             :  public:
      36             :      enum DocumentSettingId
      37             :      {
      38             :          // COMPATIBILITY FLAGS START
      39             :          PARA_SPACE_MAX,
      40             :          PARA_SPACE_MAX_AT_PAGES,
      41             : 
      42             :          TAB_COMPAT,
      43             : 
      44             :          ADD_FLY_OFFSETS,
      45             : 
      46             :          OLD_NUMBERING,
      47             : 
      48             :          ADD_EXT_LEADING,
      49             :          USE_VIRTUAL_DEVICE,
      50             :          USE_HIRES_VIRTUAL_DEVICE,
      51             :          OLD_LINE_SPACING,
      52             :          ADD_PARA_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             :          DO_NOT_RESET_PARA_ATTRS_FOR_NUM_FONT,
      60             :          OUTLINE_LEVEL_YIELDS_OUTLINE_RULE,
      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             :          UNIX_FORCE_ZERO_EXT_LEADING,
      68             :          TABS_RELATIVE_TO_INDENT,
      69             :          PROTECT_FORM,
      70             :          // #i89181#
      71             :          TAB_AT_LEFT_INDENT_FOR_PARA_IN_LIST,
      72             :          INVERT_BORDER_SPACING,
      73             :          COLLAPSE_EMPTY_CELL_PARA,
      74             :          SMALL_CAPS_PERCENTAGE_66,
      75             :          TAB_OVERFLOW,
      76             :          UNBREAKABLE_NUMBERINGS,
      77             :          CLIPPED_PICTURES,
      78             :          BACKGROUND_PARA_OVER_DRAWINGS,
      79             :          TAB_OVER_MARGIN,
      80             :          // MS Word still wraps text around objects with less space than LO would.
      81             :          SURROUND_TEXT_WRAP_SMALL,
      82             :          // COMPATIBILITY FLAGS END
      83             : 
      84             :          BROWSE_MODE,
      85             :          HTML_MODE,
      86             :          GLOBAL_DOCUMENT,
      87             :          GLOBAL_DOCUMENT_SAVE_LINKS,
      88             :          LABEL_DOCUMENT,
      89             :          PURGE_OLE,
      90             :          KERN_ASIAN_PUNCTUATION,
      91             :          MATH_BASELINE_ALIGNMENT,
      92             :          STYLES_NODEFAULT,
      93             :          FLOATTABLE_NOMARGINS,
      94             :          EMBED_FONTS,
      95             :          EMBED_SYSTEM_FONTS
      96             :      };
      97             : 
      98             :  public:
      99             :     /** Return the specified document setting.
     100             : 
     101             :        @param id
     102             :        [in] the identifier of the document setting to be returned.
     103             :        See above for a list of valid document setting identifiers.
     104             : 
     105             :        @returns
     106             :        the value of the requested document setting.
     107             :     */
     108             :     virtual bool get(/*[in]*/ DocumentSettingId id) const = 0;
     109             : 
     110             :     /** Set the specified document setting.
     111             : 
     112             :         @param id
     113             :         [in] the identifier of the document setting to be set.
     114             :         See above for a list of valid document setting identifiers.
     115             : 
     116             :         @param value
     117             :         [in] the new value of the specified document setting.
     118             :     */
     119             :     virtual void set(/*[in]*/ DocumentSettingId id, /*[in]*/ bool value) = 0;
     120             : 
     121             :     /** Return the forbidden characters.
     122             : 
     123             :        @param nLang
     124             :        [in] the language for which the forbidden character list is returned.
     125             : 
     126             :        @param bLocaleData
     127             :        [in] if set and there is no user defined forbidden character list for
     128             :             language lang, the default list for language lang will be returned.
     129             : 
     130             :        @returns
     131             :        a list of forbidden characters.
     132             :     */
     133             :     virtual const com::sun::star::i18n::ForbiddenCharacters*
     134             :         getForbiddenCharacters(/*[in]*/ sal_uInt16 nLang, /*[in]*/ bool bLocaleData ) const = 0;
     135             : 
     136             :     /** Set the forbidden characters.
     137             : 
     138             :        @param nLang
     139             :        [in] the language for which the forbidden character list should be set.
     140             : 
     141             :        @param rForbiddenCharacters
     142             :        [in] the new list of forbidden characters for language lang.
     143             :     */
     144             :     virtual void setForbiddenCharacters(/*[in]*/ sal_uInt16 nLang,
     145             :                                         /*[in]*/ const com::sun::star::i18n::ForbiddenCharacters& rForbiddenCharacters ) = 0;
     146             : 
     147             :     /** Get the forbidden character table and creates one if necessary.
     148             : 
     149             :        @returns
     150             :        the forbidden characters table.
     151             :     */
     152             :     virtual rtl::Reference<SvxForbiddenCharactersTable>& getForbiddenCharacterTable() = 0;
     153             : 
     154             :     /** Get the forbidden character table.
     155             : 
     156             :        @returns
     157             :        the forbidden characters table.
     158             :     */
     159             :     virtual const rtl::Reference<SvxForbiddenCharactersTable>& getForbiddenCharacterTable() const = 0;
     160             : 
     161             :     /** Get the current link update mode.
     162             : 
     163             :        @param bGlobalSettings
     164             :        [in] if set, the link update mode is obtained from the module,
     165             :             if it is set to GLOBALSETTING
     166             : 
     167             :        @returns
     168             :        the current link update mode.
     169             :     */
     170             :     virtual sal_uInt16 getLinkUpdateMode( /*[in]*/bool bGlobalSettings ) const = 0;
     171             : 
     172             :     /** Set the current link update mode.
     173             : 
     174             :        @param nMode
     175             :        [in] the new link update mode.
     176             :     */
     177             :     virtual void setLinkUpdateMode( /*[in]*/ sal_uInt16 nMode ) = 0;
     178             : 
     179             :     /** Get the current field update mode.
     180             : 
     181             :        @param bGlobalSettings
     182             :        [in] if set, the field update mode is obtained from the module,
     183             :             if it is set to GLOBALSETTING
     184             : 
     185             :        @returns
     186             :        the current field update mode.
     187             :     */
     188             :     virtual SwFldUpdateFlags getFieldUpdateFlags( /*[in]*/bool bGlobalSettings ) const = 0;
     189             : 
     190             :     /** Set the current field update mode.
     191             : 
     192             :        @param nMode
     193             :        [in] the new field update mode.
     194             :     */
     195             :     virtual void setFieldUpdateFlags( /*[in]*/ SwFldUpdateFlags nMode )  = 0;
     196             : 
     197             :     /** Get the character compression type for Asian characters.
     198             : 
     199             :        @returns
     200             :        the current character compression mode.
     201             :     */
     202             :     virtual SwCharCompressType getCharacterCompressionType() const = 0;
     203             : 
     204             :     /** Set the character compression type for Asian characters.
     205             : 
     206             :        @param nMode
     207             :        [in] the new character compression type.
     208             :     */
     209             :     virtual void setCharacterCompressionType( /*[in]*/SwCharCompressType nType ) = 0;
     210             : 
     211             : protected:
     212           0 :     virtual ~IDocumentSettingAccess() {};
     213             :  };
     214             : 
     215             : #endif // INCLUDED_SW_INC_IDOCUMENTSETTINGACCESS_HXX
     216             : 
     217             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

Generated by: LCOV version 1.10