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             : #ifndef SC_SPELLPARAM_HXX
      20             : #define SC_SPELLPARAM_HXX
      21             : 
      22             : #include <vcl/font.hxx>
      23             : 
      24             : /** Specifiers for sheet conversion (functions iterating over the sheet and modifying cells). */
      25             : enum ScConversionType
      26             : {
      27             :     SC_CONVERSION_SPELLCHECK,       /// Spell checker.
      28             :     SC_CONVERSION_HANGULHANJA,      /// Hangul-Hanja converter.
      29             :     SC_CONVERSION_CHINESE_TRANSL    /// Chinese simplified/traditional converter.
      30             : };
      31             : 
      32             : /** Parameters for conversion. */
      33           0 : class ScConversionParam
      34             : {
      35             : public:
      36             :     /** Constructs an empty parameter struct with the passed conversion type. */
      37             :     explicit            ScConversionParam( ScConversionType eConvType );
      38             : 
      39             :     /** Constructs parameter struct for text conversion without changing the language. */
      40             :     explicit            ScConversionParam(
      41             :                             ScConversionType eConvType,
      42             :                             LanguageType eLang,
      43             :                             sal_Int32 nOptions,
      44             :                             bool bIsInteractive );
      45             : 
      46             :     /** Constructs parameter struct for text conversion with language change. */
      47             :     explicit            ScConversionParam(
      48             :                             ScConversionType eConvType,
      49             :                             LanguageType eSourceLang,
      50             :                             LanguageType eTargetLang,
      51             :                             const Font& rTargetFont,
      52             :                             sal_Int32 nOptions,
      53             :                             bool bIsInteractive );
      54             : 
      55           0 :     inline ScConversionType GetType() const     { return meConvType; }
      56           0 :     inline LanguageType GetSourceLang() const   { return meSourceLang; }
      57           0 :     inline LanguageType GetTargetLang() const   { return meTargetLang; }
      58           0 :     inline const Font*  GetTargetFont() const   { return mbUseTargetFont ? &maTargetFont : 0; }
      59           0 :     inline sal_Int32    GetOptions() const      { return mnOptions; }
      60           0 :     inline bool         IsInteractive() const   { return mbIsInteractive; }
      61             : 
      62             : private:
      63             :     ScConversionType    meConvType;         /// Type of the conversion.
      64             :     LanguageType        meSourceLang;       /// Source language for conversion.
      65             :     LanguageType        meTargetLang;       /// Target language for conversion.
      66             :     Font                maTargetFont;       /// Target font to be used if language has to be changed.
      67             :     sal_Int32           mnOptions;          /// Conversion options.
      68             :     bool                mbUseTargetFont;    /// True = Use maTargetFont to change font during conversion.
      69             :     bool                mbIsInteractive;    /// True = Text conversion has (specific) dialog that may be raised.
      70             : };
      71             : 
      72             : #endif
      73             : 
      74             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */