sw/inc/splargs.hxx

   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 INCLUDED_SW_INC_SPLARGS_HXX
  20 #define INCLUDED_SW_INC_SPLARGS_HXX
  21
  22 #include <i18nlangtag/lang.h>
  23 #include <tools/gen.hxx>
  24
  25 #include <com/sun/star/linguistic2/XSpellAlternatives.hpp>
  26 #include <com/sun/star/linguistic2/XSpellChecker1.hpp>
  27
  28 #include <functional>
  29
  30 class SwTextFrame;
  31 class SwTextNode;
  32 class SwIndex;
  33 namespace vcl { class Font; }
  34 namespace com::sun::star::linguistic2 { class XHyphenatedWord; }
  35
  36 struct SwArgsBase     // used for text conversion (Hangul/Hanja, ...)
  37 {
  38     SwTextNode  *pStartNode;
  39     SwIndex    *pStartIdx;
  40     SwTextNode  *pEndNode;
  41     SwIndex    *pEndIdx;
  42
  43     SwArgsBase(
  44             SwTextNode* pStart, SwIndex& rStart,
  45             SwTextNode* pEnd, SwIndex& rEnd )
  46         : pStartNode( pStart ), pStartIdx( &rStart ),
  47           pEndNode( pEnd ), pEndIdx( &rEnd )
  48         {}
  49
  50     void SetStart(SwTextNode* pStart, SwIndex& rStart )
  51     {
  52         pStartNode = pStart;    pStartIdx = &rStart ;
  53     }
  54
  55     void SetEnd( SwTextNode* pEnd, SwIndex& rEnd  )
  56     {
  57         pEndNode = pEnd;        pEndIdx = &rEnd ;
  58     }
  59 };
  60
  61 // used for text conversion (Hangul/Hanja, Simplified/Traditional Chinese, ...)
  62 struct SwConversionArgs : SwArgsBase
  63 {
  64     OUString   aConvText;          // convertible text found
  65     LanguageType    nConvSrcLang;       // (source) language to look for
  66     LanguageType    nConvTextLang;      // language of aConvText (if the latter one was found)
  67
  68     // used for chinese translation
  69     LanguageType    nConvTargetLang;    // target language of text to be changed
  70     const vcl::Font *pTargetFont;        // target font of text to be changed
  71     // explicitly enables or disables application of the above two
  72     bool            bAllowImplicitChangesForNotConvertibleText;
  73
  74     SwConversionArgs( LanguageType nLang,
  75             SwTextNode* pStart, SwIndex& rStart,
  76             SwTextNode* pEnd, SwIndex& rEnd )
  77         : SwArgsBase( pStart, rStart, pEnd, rEnd ),
  78           nConvSrcLang( nLang ),
  79           nConvTextLang( LANGUAGE_NONE ),
  80           nConvTargetLang( LANGUAGE_NONE ),
  81           pTargetFont( nullptr ),
  82           bAllowImplicitChangesForNotConvertibleText( false )
  83         {}
  84 };
  85
  86 struct SwSpellArgs : SwArgsBase
  87 {
  88     css::uno::Reference< css::linguistic2::XSpellChecker1 >     xSpeller;
  89
  90     css::uno::Reference< css::linguistic2::XSpellAlternatives > xSpellAlt;
  91
  92     bool bIsGrammarCheck;
  93
  94     SwSpellArgs(css::uno::Reference<
  95             css::linguistic2::XSpellChecker1 > const &rxSplChk,
  96             SwTextNode* pStart, SwIndex& rStart,
  97             SwTextNode* pEnd, SwIndex& rEnd,
  98             bool bGrammar )
  99         :   SwArgsBase( pStart, rStart, pEnd, rEnd ),
 100             xSpeller( rxSplChk ),
 101             bIsGrammarCheck( bGrammar )
 102         {}
 103 };
 104
 105 // Parameter-class for Hyphenate.
 106 // docedt.cxx:  SwDoc::Hyphenate()
 107 // txtedt.cxx:  SwTextNode::Hyphenate()
 108 // txthyph.cxx: SwTextFrame::Hyphenate()
 109
 110 class SwInterHyphInfo
 111 {
 112     /// output: hyphenated word
 113     css::uno::Reference<css::linguistic2::XHyphenatedWord> m_xHyphWord;
 114     /// input: cursor point to locate the frame
 115     const Point m_aCursorPos;
 116 public:
 117     /// input: requested range to hyphenate
 118     sal_Int32 m_nStart;
 119     sal_Int32 m_nEnd;
 120     /// output: found word
 121     sal_Int32 m_nWordStart;
 122     sal_Int32 m_nWordLen;
 123
 124     SwInterHyphInfo( const Point &rCursorPos )
 125         : m_aCursorPos(rCursorPos)
 126         , m_nStart(0)
 127         , m_nEnd(SAL_MAX_INT32)
 128         , m_nWordStart(0), m_nWordLen(0)
 129     {
 130     }
 131     const Point *GetCursorPos() const
 132     {
 133         return m_aCursorPos.X() || m_aCursorPos.Y() ? &m_aCursorPos : nullptr;
 134     }
 135     void SetHyphWord(const css::uno::Reference< css::linguistic2::XHyphenatedWord >  &rxHW)
 136     {
 137         m_xHyphWord = rxHW;
 138     }
 139     const css::uno::Reference< css::linguistic2::XHyphenatedWord >& GetHyphWord() const
 140     {
 141         return m_xHyphWord;
 142     }
 143 };
 144
 145
 146 namespace sw {
 147
 148 typedef std::function<SwTextFrame*()> Creator;
 149
 150 SwTextFrame *
 151 SwHyphIterCacheLastTextFrame(SwTextNode const *, const Creator& rCreator);
 152
 153 }
 154
 155 #endif
 156
 157 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */