blob: 92bca22d365d21833dcca733dd961e0d817c5113 [file] [log] [blame]
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef SC_SPELLPARAM_HXX
#define SC_SPELLPARAM_HXX
#include <vcl/font.hxx>
// ============================================================================
/** Specifiers for sheet conversion (functions iterating over the sheet and modifying cells). */
enum ScConversionType
{
SC_CONVERSION_SPELLCHECK, /// Spell checker.
SC_CONVERSION_HANGULHANJA, /// Hangul-Hanja converter.
SC_CONVERSION_CHINESE_TRANSL /// Chinese simplified/traditional converter.
};
// ---------------------------------------------------------------------------
/** Parameters for conversion. */
class ScConversionParam
{
public:
/** Constructs an empty parameter struct with the passed conversion type. */
explicit ScConversionParam( ScConversionType eConvType );
/** Constructs parameter struct for text conversion without changing the language. */
explicit ScConversionParam(
ScConversionType eConvType,
LanguageType eLang,
sal_Int32 nOptions,
bool bIsInteractive );
/** Constructs parameter struct for text conversion with language change. */
explicit ScConversionParam(
ScConversionType eConvType,
LanguageType eSourceLang,
LanguageType eTargetLang,
const Font& rTargetFont,
sal_Int32 nOptions,
bool bIsInteractive );
inline ScConversionType GetType() const { return meConvType; }
inline LanguageType GetSourceLang() const { return meSourceLang; }
inline LanguageType GetTargetLang() const { return meTargetLang; }
inline const Font* GetTargetFont() const { return mbUseTargetFont ? &maTargetFont : 0; }
inline sal_Int32 GetOptions() const { return mnOptions; }
inline bool IsInteractive() const { return mbIsInteractive; }
private:
ScConversionType meConvType; /// Type of the conversion.
LanguageType meSourceLang; /// Source language for conversion.
LanguageType meTargetLang; /// Target language for conversion.
Font maTargetFont; /// Target font to be used if language has to be changed.
sal_Int32 mnOptions; /// Conversion options.
bool mbUseTargetFont; /// True = Use maTargetFont to change font during conversion.
bool mbIsInteractive; /// True = Text conversion has (specific) dialog that may be raised.
};
// ============================================================================
#endif