xref: /aoo41x/main/sc/source/ui/inc/spellparam.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir #ifndef SC_SPELLPARAM_HXX
28*cdf0e10cSrcweir #define SC_SPELLPARAM_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir #include <vcl/font.hxx>
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir // ============================================================================
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir /** Specifiers for sheet conversion (functions iterating over the sheet and modifying cells). */
35*cdf0e10cSrcweir enum ScConversionType
36*cdf0e10cSrcweir {
37*cdf0e10cSrcweir     SC_CONVERSION_SPELLCHECK,       /// Spell checker.
38*cdf0e10cSrcweir     SC_CONVERSION_HANGULHANJA,      /// Hangul-Hanja converter.
39*cdf0e10cSrcweir     SC_CONVERSION_CHINESE_TRANSL    /// Chinese simplified/traditional converter.
40*cdf0e10cSrcweir };
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir // ---------------------------------------------------------------------------
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir /** Parameters for conversion. */
45*cdf0e10cSrcweir class ScConversionParam
46*cdf0e10cSrcweir {
47*cdf0e10cSrcweir public:
48*cdf0e10cSrcweir     /** Constructs an empty parameter struct with the passed conversion type. */
49*cdf0e10cSrcweir     explicit            ScConversionParam( ScConversionType eConvType );
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir     /** Constructs parameter struct for text conversion without changing the language. */
52*cdf0e10cSrcweir     explicit            ScConversionParam(
53*cdf0e10cSrcweir                             ScConversionType eConvType,
54*cdf0e10cSrcweir                             LanguageType eLang,
55*cdf0e10cSrcweir                             sal_Int32 nOptions,
56*cdf0e10cSrcweir                             bool bIsInteractive );
57*cdf0e10cSrcweir 
58*cdf0e10cSrcweir     /** Constructs parameter struct for text conversion with language change. */
59*cdf0e10cSrcweir     explicit            ScConversionParam(
60*cdf0e10cSrcweir                             ScConversionType eConvType,
61*cdf0e10cSrcweir                             LanguageType eSourceLang,
62*cdf0e10cSrcweir                             LanguageType eTargetLang,
63*cdf0e10cSrcweir                             const Font& rTargetFont,
64*cdf0e10cSrcweir                             sal_Int32 nOptions,
65*cdf0e10cSrcweir                             bool bIsInteractive );
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir     inline ScConversionType GetType() const     { return meConvType; }
68*cdf0e10cSrcweir     inline LanguageType GetSourceLang() const   { return meSourceLang; }
69*cdf0e10cSrcweir     inline LanguageType GetTargetLang() const   { return meTargetLang; }
70*cdf0e10cSrcweir     inline const Font*  GetTargetFont() const   { return mbUseTargetFont ? &maTargetFont : 0; }
71*cdf0e10cSrcweir     inline sal_Int32    GetOptions() const      { return mnOptions; }
72*cdf0e10cSrcweir     inline bool         IsInteractive() const   { return mbIsInteractive; }
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir private:
75*cdf0e10cSrcweir     ScConversionType    meConvType;         /// Type of the conversion.
76*cdf0e10cSrcweir     LanguageType        meSourceLang;       /// Source language for conversion.
77*cdf0e10cSrcweir     LanguageType        meTargetLang;       /// Target language for conversion.
78*cdf0e10cSrcweir     Font                maTargetFont;       /// Target font to be used if language has to be changed.
79*cdf0e10cSrcweir     sal_Int32           mnOptions;          /// Conversion options.
80*cdf0e10cSrcweir     bool                mbUseTargetFont;    /// True = Use maTargetFont to change font during conversion.
81*cdf0e10cSrcweir     bool                mbIsInteractive;    /// True = Text conversion has (specific) dialog that may be raised.
82*cdf0e10cSrcweir };
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir // ============================================================================
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir #endif
87*cdf0e10cSrcweir 
88