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