xref: /aoo42x/main/sc/source/ui/inc/spellparam.hxx (revision 38d50f7b)
1*38d50f7bSAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*38d50f7bSAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*38d50f7bSAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*38d50f7bSAndrew Rist  * distributed with this work for additional information
6*38d50f7bSAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*38d50f7bSAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*38d50f7bSAndrew Rist  * "License"); you may not use this file except in compliance
9*38d50f7bSAndrew Rist  * with the License.  You may obtain a copy of the License at
10*38d50f7bSAndrew Rist  *
11*38d50f7bSAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*38d50f7bSAndrew Rist  *
13*38d50f7bSAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*38d50f7bSAndrew Rist  * software distributed under the License is distributed on an
15*38d50f7bSAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*38d50f7bSAndrew Rist  * KIND, either express or implied.  See the License for the
17*38d50f7bSAndrew Rist  * specific language governing permissions and limitations
18*38d50f7bSAndrew Rist  * under the License.
19*38d50f7bSAndrew Rist  *
20*38d50f7bSAndrew Rist  *************************************************************/
21*38d50f7bSAndrew Rist 
22*38d50f7bSAndrew Rist 
23cdf0e10cSrcweir #ifndef SC_SPELLPARAM_HXX
24cdf0e10cSrcweir #define SC_SPELLPARAM_HXX
25cdf0e10cSrcweir 
26cdf0e10cSrcweir #include <vcl/font.hxx>
27cdf0e10cSrcweir 
28cdf0e10cSrcweir // ============================================================================
29cdf0e10cSrcweir 
30cdf0e10cSrcweir /** Specifiers for sheet conversion (functions iterating over the sheet and modifying cells). */
31cdf0e10cSrcweir enum ScConversionType
32cdf0e10cSrcweir {
33cdf0e10cSrcweir     SC_CONVERSION_SPELLCHECK,       /// Spell checker.
34cdf0e10cSrcweir     SC_CONVERSION_HANGULHANJA,      /// Hangul-Hanja converter.
35cdf0e10cSrcweir     SC_CONVERSION_CHINESE_TRANSL    /// Chinese simplified/traditional converter.
36cdf0e10cSrcweir };
37cdf0e10cSrcweir 
38cdf0e10cSrcweir // ---------------------------------------------------------------------------
39cdf0e10cSrcweir 
40cdf0e10cSrcweir /** Parameters for conversion. */
41cdf0e10cSrcweir class ScConversionParam
42cdf0e10cSrcweir {
43cdf0e10cSrcweir public:
44cdf0e10cSrcweir     /** Constructs an empty parameter struct with the passed conversion type. */
45cdf0e10cSrcweir     explicit            ScConversionParam( ScConversionType eConvType );
46cdf0e10cSrcweir 
47cdf0e10cSrcweir     /** Constructs parameter struct for text conversion without changing the language. */
48cdf0e10cSrcweir     explicit            ScConversionParam(
49cdf0e10cSrcweir                             ScConversionType eConvType,
50cdf0e10cSrcweir                             LanguageType eLang,
51cdf0e10cSrcweir                             sal_Int32 nOptions,
52cdf0e10cSrcweir                             bool bIsInteractive );
53cdf0e10cSrcweir 
54cdf0e10cSrcweir     /** Constructs parameter struct for text conversion with language change. */
55cdf0e10cSrcweir     explicit            ScConversionParam(
56cdf0e10cSrcweir                             ScConversionType eConvType,
57cdf0e10cSrcweir                             LanguageType eSourceLang,
58cdf0e10cSrcweir                             LanguageType eTargetLang,
59cdf0e10cSrcweir                             const Font& rTargetFont,
60cdf0e10cSrcweir                             sal_Int32 nOptions,
61cdf0e10cSrcweir                             bool bIsInteractive );
62cdf0e10cSrcweir 
GetType() const63cdf0e10cSrcweir     inline ScConversionType GetType() const     { return meConvType; }
GetSourceLang() const64cdf0e10cSrcweir     inline LanguageType GetSourceLang() const   { return meSourceLang; }
GetTargetLang() const65cdf0e10cSrcweir     inline LanguageType GetTargetLang() const   { return meTargetLang; }
GetTargetFont() const66cdf0e10cSrcweir     inline const Font*  GetTargetFont() const   { return mbUseTargetFont ? &maTargetFont : 0; }
GetOptions() const67cdf0e10cSrcweir     inline sal_Int32    GetOptions() const      { return mnOptions; }
IsInteractive() const68cdf0e10cSrcweir     inline bool         IsInteractive() const   { return mbIsInteractive; }
69cdf0e10cSrcweir 
70cdf0e10cSrcweir private:
71cdf0e10cSrcweir     ScConversionType    meConvType;         /// Type of the conversion.
72cdf0e10cSrcweir     LanguageType        meSourceLang;       /// Source language for conversion.
73cdf0e10cSrcweir     LanguageType        meTargetLang;       /// Target language for conversion.
74cdf0e10cSrcweir     Font                maTargetFont;       /// Target font to be used if language has to be changed.
75cdf0e10cSrcweir     sal_Int32           mnOptions;          /// Conversion options.
76cdf0e10cSrcweir     bool                mbUseTargetFont;    /// True = Use maTargetFont to change font during conversion.
77cdf0e10cSrcweir     bool                mbIsInteractive;    /// True = Text conversion has (specific) dialog that may be raised.
78cdf0e10cSrcweir };
79cdf0e10cSrcweir 
80cdf0e10cSrcweir // ============================================================================
81cdf0e10cSrcweir 
82cdf0e10cSrcweir #endif
83cdf0e10cSrcweir 
84