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