Line data    Source code

       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             : 
      20             : #ifndef SVX_SPELL_PORTIONS_HXX
      21             : #define SVX_SPELL_PORTIONS_HXX
      22             : 
      23             : #include <i18npool/lang.h>
      24             : #include <rtl/ustring.hxx>
      25             : #include <com/sun/star/uno/Reference.h>
      26             : #include <com/sun/star/linguistic2/SingleProofreadingError.hpp>
      27             : #include <com/sun/star/linguistic2/XProofreader.hpp>
      28             : #include <vector>
      29             : 
      30             : namespace com{ namespace sun{ namespace star{ namespace linguistic2{
      31             :     class XSpellAlternatives;
      32             : }}}}
      33             : 
      34             : namespace svx{
      35             : /** contains a portion of text that has the same language attributes applied
      36             :     and belongs to the same script type.
      37             :  */
      38           0 : struct SpellPortion
      39             : {
      40             :     /** contains the text of the portion.
      41             :      */
      42             :     rtl::OUString   sText;
      43             :     /** Marks the portion as field, footnote symbol or any other special content that
      44             :      should be protected against unintentional deletion.
      45             :      */
      46             :     bool bIsField;
      47             :     /** Marks the portion hidden content that should not be touched by spell checking
      48             :         and not be removed like redlines. The creator of the portions has to take care
      49             :         for them.
      50             :      */
      51             :     bool bIsHidden;
      52             :     /** contains the language applied to the text. It has to match the script type.
      53             :      */
      54             :     LanguageType    eLanguage;
      55             :     /** for wrong words this reference is filled with the error informations otherwise
      56             :         it's an empty reference
      57             :      */
      58             :     ::com::sun::star::uno::Reference< ::com::sun::star::linguistic2::XSpellAlternatives> xAlternatives;
      59             :     /** determines whether the error type is a grammar error
      60             :     */
      61             :     bool bIsGrammarError;
      62             :     /** contains the grammar error information
      63             :     */
      64             :     com::sun::star::linguistic2::SingleProofreadingError aGrammarError;
      65             :     /** provides access to the grammar checker interface
      66             :      */
      67             :     ::com::sun::star::uno::Reference< ::com::sun::star::linguistic2::XProofreader > xGrammarChecker;
      68             :     /** marks portion as to-be-ignored. This is a return parameter.
      69             :      */
      70             :     /** contains the proposed dialog title if the proof reading component provides one.
      71             :      */
      72             :     rtl::OUString   sDialogTitle;
      73             : 
      74             :     bool bIgnoreThisError;
      75           0 :     SpellPortion() :
      76             :         bIsField(false),
      77             :         bIsHidden(false),
      78             :         eLanguage(LANGUAGE_DONTKNOW),
      79             :         bIsGrammarError(false),
      80           0 :         bIgnoreThisError(false)
      81             :         {
      82           0 :             aGrammarError.nErrorStart = aGrammarError.nErrorLength = aGrammarError.nErrorType = 0;
      83           0 :         }
      84             : };
      85             : typedef std::vector<SpellPortion> SpellPortions;
      86             : }//namespace svx
      87             : #endif
      88             : 
      89             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */