sc/source/ui/view/spelleng.cxx

   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 #include "spelleng.hxx"
  21 #include <com/sun/star/i18n/TextConversionOption.hpp>
  22
  23 #include "scitems.hxx"
  24 #include <editeng/eeitem.hxx>
  25
  26 #include <editeng/langitem.hxx>
  27 #include <editeng/editobj.hxx>
  28 #include <editeng/editview.hxx>
  29 #include <sfx2/viewfrm.hxx>
  30 #include <vcl/msgbox.hxx>
  31 #include <vcl/svapp.hxx>
  32 #include <vcl/settings.hxx>
  33
  34 #include "spelldialog.hxx"
  35 #include "tabvwsh.hxx"
  36 #include "docsh.hxx"
  37 #include "formulacell.hxx"
  38 #include "patattr.hxx"
  39 #include "waitoff.hxx"
  40 #include "globstr.hrc"
  41 #include "markdata.hxx"
  42
  43 #include <boost/scoped_ptr.hpp>
  44
  45 using namespace ::com::sun::star;
  46
  47 ScConversionEngineBase::ScConversionEngineBase(
  48         SfxItemPool* pEnginePoolP, ScViewData& rViewData,
  49         ScDocument* pUndoDoc, ScDocument* pRedoDoc ) :
  50     ScEditEngineDefaulter( pEnginePoolP ),
  51     mrViewData( rViewData ),
  52     mrDocShell( *rViewData.GetDocShell() ),
  53     mrDoc( rViewData.GetDocShell()->GetDocument() ),
  54     maSelState( rViewData ),
  55     mpUndoDoc( pUndoDoc ),
  56     mpRedoDoc( pRedoDoc ),
  57     meCurrLang( LANGUAGE_ENGLISH_US ),
  58     mbIsAnyModified( false ),
  59     mbInitialState( true ),
  60     mbWrappedInTable( false ),
  61     mbFinished( false )
  62 {
  63     maSelState.GetCellCursor().GetVars( mnStartCol, mnStartRow, mnStartTab );
  64     // start with cell A1 in cell/range/multi-selection, will seek to first selected
  65     if( maSelState.GetSelectionType() == SC_SELECTTYPE_SHEET )
  66     {
  67         mnStartCol = 0;
  68         mnStartRow = 0;
  69     }
  70     mnCurrCol = mnStartCol;
  71     mnCurrRow = mnStartRow;
  72 }
  73
  74 ScConversionEngineBase::~ScConversionEngineBase()
  75 {
  76 }
  77
  78 bool ScConversionEngineBase::FindNextConversionCell()
  79 {
  80     ScMarkData& rMark = mrViewData.GetMarkData();
  81     ScTabViewShell* pViewShell = mrViewData.GetViewShell();
  82     const ScPatternAttr* pPattern = NULL;
  83     const ScPatternAttr* pLastPattern = NULL;
  84
  85     boost::scoped_ptr<SfxItemSet> pEditDefaults(new SfxItemSet(GetEmptyItemSet()));
  86
  87     if( IsModified() )
  88     {
  89         mbIsAnyModified = true;
  90
  91         OUString aNewStr = GetText();
  92
  93         bool bMultiTab = (rMark.GetSelectCount() > 1);
  94         OUString aVisibleStr;
  95         if( bMultiTab )
  96             aVisibleStr = mrDoc.GetString(mnCurrCol, mnCurrRow, mnStartTab);
  97
  98         for( SCTAB nTab = 0, nTabCount = mrDoc.GetTableCount(); nTab < nTabCount; ++nTab )
  99         {
 100             //  always change the cell on the visible tab,
 101             //  on the other selected tabs only if they contain the same text
 102
 103             if ((nTab == mnStartTab) ||
 104                 (bMultiTab && rMark.GetTableSelect(nTab) && mrDoc.GetString(mnCurrCol, mnCurrRow, nTab) == aVisibleStr))
 105             {
 106                 ScAddress aPos( mnCurrCol, mnCurrRow, nTab );
 107                 CellType eCellType = mrDoc.GetCellType( aPos );
 108                 bool bEmptyCell = eCellType == CELLTYPE_NONE;
 109
 110                 if (mpUndoDoc && !bEmptyCell)
 111                     mrDoc.CopyCellToDocument(aPos, aPos, *mpUndoDoc);
 112
 113                 if (eCellType == CELLTYPE_EDIT)
 114                 {
 115                     boost::scoped_ptr<EditTextObject> pEditObj(CreateTextObject());
 116                     mrDoc.SetEditText(aPos, *pEditObj, GetEditTextObjectPool());
 117                 }
 118                 else
 119                     mrDoc.SetString(aPos, aNewStr);
 120
 121                 if (mpRedoDoc && !bEmptyCell)
 122                     mrDoc.CopyCellToDocument(aPos, aPos, *mpRedoDoc);
 123
 124                 mrDocShell.PostPaintCell(aPos);
 125             }
 126         }
 127     }
 128
 129     SCCOL nNewCol = mnCurrCol;
 130     SCROW nNewRow = mnCurrRow;
 131
 132     if( mbInitialState )
 133     {
 134         /*  On very first call, decrement row to let GetNextSpellingCell() find
 135             the first cell of current range. */
 136         mbInitialState = false;
 137         --nNewRow;
 138     }
 139
 140     bool bSheetSel = maSelState.GetSelectionType() == SC_SELECTTYPE_SHEET;
 141     bool bLoop = true;
 142     bool bFound = false;
 143     while( bLoop && !bFound )
 144     {
 145         bLoop = mrDoc.GetNextSpellingCell( nNewCol, nNewRow, mnStartTab, bSheetSel, rMark );
 146         if( bLoop )
 147         {
 148             FillFromCell( mnCurrCol, mnCurrRow, mnStartTab );
 149
 150             if( mbWrappedInTable && ((nNewCol > mnStartCol) || ((nNewCol == mnStartCol) && (nNewRow >= mnStartRow))) )
 151             {
 152                 ShowFinishDialog();
 153                 bLoop = false;
 154                 mbFinished = true;
 155             }
 156             else if( nNewCol > MAXCOL )
 157             {
 158                 // no more cells in the sheet - try to restart at top of sheet
 159
 160                 if( bSheetSel || ((mnStartCol == 0) && (mnStartRow == 0)) )
 161                 {
 162                     // conversion started at cell A1 or in selection, do not query to restart at top
 163                     ShowFinishDialog();
 164                     bLoop = false;
 165                     mbFinished = true;
 166                 }
 167                 else if( ShowTableWrapDialog() )
 168                 {
 169                     // conversion started anywhere but in cell A1, user wants to restart
 170                     nNewRow = MAXROW + 2;
 171                     mbWrappedInTable = true;
 172                 }
 173                 else
 174                 {
 175                     bLoop = false;
 176                     mbFinished = true;
 177                 }
 178             }
 179             else
 180             {
 181                 pPattern = mrDoc.GetPattern( nNewCol, nNewRow, mnStartTab );
 182                 if( pPattern && (pPattern != pLastPattern) )
 183                 {
 184                     pPattern->FillEditItemSet( pEditDefaults.get() );
 185                     SetDefaults( *pEditDefaults );
 186                     pLastPattern = pPattern;
 187                 }
 188
 189                 // language changed?
 190                 const SfxPoolItem* pItem = mrDoc.GetAttr( nNewCol, nNewRow, mnStartTab, ATTR_FONT_LANGUAGE );
 191                 if( const SvxLanguageItem* pLangItem = PTR_CAST( SvxLanguageItem, pItem ) )
 192                 {
 193                     LanguageType eLang = static_cast< LanguageType >( pLangItem->GetValue() );
 194                     if( eLang == LANGUAGE_SYSTEM )
 195                         eLang = Application::GetSettings().GetLanguageTag().getLanguageType();   // never use SYSTEM for spelling
 196                     if( eLang != meCurrLang )
 197                     {
 198                         meCurrLang = eLang;
 199                         SetDefaultLanguage( eLang );
 200                     }
 201                 }
 202
 203                 FillFromCell( nNewCol, nNewRow, mnStartTab );
 204
 205                 bFound = bLoop && NeedsConversion();
 206             }
 207         }
 208     }
 209
 210     if( bFound )
 211     {
 212         pViewShell->AlignToCursor( nNewCol, nNewRow, SC_FOLLOW_JUMP );
 213         pViewShell->SetCursor( nNewCol, nNewRow, true );
 214         mrViewData.GetView()->MakeEditView( this, nNewCol, nNewRow );
 215         EditView* pEditView = mrViewData.GetSpellingView();
 216         // maSelState.GetEditSelection() returns (0,0) if not in edit mode -> ok
 217         pEditView->SetSelection( maSelState.GetEditSelection() );
 218
 219         ClearModifyFlag();
 220         mnCurrCol = nNewCol;
 221         mnCurrRow = nNewRow;
 222     }
 223
 224     return bFound;
 225 }
 226
 227 void ScConversionEngineBase::RestoreCursorPos()
 228 {
 229     const ScAddress& rPos = maSelState.GetCellCursor();
 230     mrViewData.GetViewShell()->SetCursor( rPos.Col(), rPos.Row() );
 231 }
 232
 233 bool ScConversionEngineBase::ShowTableWrapDialog()
 234 {
 235     // default: no dialog, always restart at top
 236     return true;
 237 }
 238
 239 void ScConversionEngineBase::ShowFinishDialog()
 240 {
 241     // default: no dialog
 242 }
 243
 244 // private --------------------------------------------------------------------
 245
 246 void ScConversionEngineBase::FillFromCell( SCCOL nCol, SCROW nRow, SCTAB nTab )
 247 {
 248     ScAddress aPos(nCol, nRow, nTab);
 249
 250     switch (mrDoc.GetCellType(aPos))
 251     {
 252         case CELLTYPE_STRING:
 253         {
 254             OUString aText = mrDoc.GetString(aPos);
 255             SetText( aText );
 256         }
 257         break;
 258         case CELLTYPE_EDIT:
 259         {
 260             const EditTextObject* pNewEditObj = mrDoc.GetEditText(aPos);
 261             if (pNewEditObj)
 262                 SetText(*pNewEditObj);
 263         }
 264         break;
 265         default:
 266             SetText(EMPTY_OUSTRING);
 267     }
 268 }
 269
 270 ScSpellingEngine::ScSpellingEngine(
 271         SfxItemPool* pEnginePoolP, ScViewData& rViewData,
 272         ScDocument* pUndoDoc, ScDocument* pRedoDoc,
 273         XSpellCheckerRef xSpeller ) :
 274     ScConversionEngineBase( pEnginePoolP, rViewData, pUndoDoc, pRedoDoc )
 275 {
 276     SetSpeller( xSpeller );
 277 }
 278
 279 void ScSpellingEngine::ConvertAll( EditView& rEditView )
 280 {
 281     EESpellState eState = EE_SPELL_OK;
 282     if( FindNextConversionCell() )
 283         eState = rEditView.StartSpeller( true );
 284
 285     OSL_ENSURE( eState != EE_SPELL_NOSPELLER, "ScSpellingEngine::Convert - no spell checker" );
 286     if( eState == EE_SPELL_NOLANGUAGE )
 287     {
 288         vcl::Window* pParent = GetDialogParent();
 289         ScWaitCursorOff aWaitOff( pParent );
 290         ScopedVclPtr<InfoBox>::Create( pParent, ScGlobal::GetRscString( STR_NOLANGERR ) )->Execute();
 291     }
 292 }
 293
 294 bool ScSpellingEngine::SpellNextDocument()
 295 {
 296     return FindNextConversionCell();
 297 }
 298
 299 bool ScSpellingEngine::NeedsConversion()
 300 {
 301     return HasSpellErrors() != EE_SPELL_OK;
 302 }
 303
 304 bool ScSpellingEngine::ShowTableWrapDialog()
 305 {
 306     vcl::Window* pParent = GetDialogParent();
 307     ScWaitCursorOff aWaitOff( pParent );
 308     ScopedVclPtrInstance<MessBox> aMsgBox( pParent, WinBits( WB_YES_NO | WB_DEF_YES ),
 309         ScGlobal::GetRscString( STR_MSSG_DOSUBTOTALS_0 ),
 310         ScGlobal::GetRscString( STR_SPELLING_BEGIN_TAB) );
 311     return aMsgBox->Execute() == RET_YES;
 312 }
 313
 314 void ScSpellingEngine::ShowFinishDialog()
 315 {
 316     vcl::Window* pParent = GetDialogParent();
 317     ScWaitCursorOff aWaitOff( pParent );
 318     ScopedVclPtr<InfoBox>::Create( pParent, ScGlobal::GetRscString( STR_SPELLING_STOP_OK ) )->Execute();
 319 }
 320
 321 vcl::Window* ScSpellingEngine::GetDialogParent()
 322 {
 323     sal_uInt16 nWinId = ScSpellDialogChildWindow::GetChildWindowId();
 324     SfxViewFrame* pViewFrm = mrViewData.GetViewShell()->GetViewFrame();
 325     if( pViewFrm->HasChildWindow( nWinId ) )
 326         if( SfxChildWindow* pChild = pViewFrm->GetChildWindow( nWinId ) )
 327             if( vcl::Window* pWin = pChild->GetWindow() )
 328                 if( pWin->IsVisible() )
 329                     return pWin;
 330
 331     // fall back to standard dialog parent
 332     return ScDocShell::GetActiveDialogParent();
 333 }
 334
 335 ScConversionParam::ScConversionParam( ScConversionType eConvType ) :
 336     meConvType( eConvType ),
 337     meSourceLang( LANGUAGE_NONE ),
 338     meTargetLang( LANGUAGE_NONE ),
 339     mnOptions( 0 ),
 340     mbUseTargetFont( false ),
 341     mbIsInteractive( false )
 342 {
 343 }
 344
 345 ScConversionParam::ScConversionParam( ScConversionType eConvType,
 346         LanguageType eLang, sal_Int32 nOptions, bool bIsInteractive ) :
 347     meConvType( eConvType ),
 348     meSourceLang( eLang ),
 349     meTargetLang( eLang ),
 350     mnOptions( nOptions ),
 351     mbUseTargetFont( false ),
 352     mbIsInteractive( bIsInteractive )
 353 {
 354     if (LANGUAGE_KOREAN == eLang)
 355         mnOptions = i18n::TextConversionOption::CHARACTER_BY_CHARACTER;
 356 }
 357
 358 ScConversionParam::ScConversionParam( ScConversionType eConvType,
 359         LanguageType eSourceLang, LanguageType eTargetLang, const vcl::Font& rTargetFont,
 360         sal_Int32 nOptions, bool bIsInteractive ) :
 361     meConvType( eConvType ),
 362     meSourceLang( eSourceLang ),
 363     meTargetLang( eTargetLang ),
 364     maTargetFont( rTargetFont ),
 365     mnOptions( nOptions ),
 366     mbUseTargetFont( true ),
 367     mbIsInteractive( bIsInteractive )
 368 {
 369     if (LANGUAGE_KOREAN == meSourceLang && LANGUAGE_KOREAN == meTargetLang)
 370         mnOptions = i18n::TextConversionOption::CHARACTER_BY_CHARACTER;
 371 }
 372
 373 ScTextConversionEngine::ScTextConversionEngine(
 374         SfxItemPool* pEnginePoolP, ScViewData& rViewData,
 375         const ScConversionParam& rConvParam,
 376         ScDocument* pUndoDoc, ScDocument* pRedoDoc ) :
 377     ScConversionEngineBase( pEnginePoolP, rViewData, pUndoDoc, pRedoDoc ),
 378     maConvParam( rConvParam )
 379 {
 380 }
 381
 382 void ScTextConversionEngine::ConvertAll( EditView& rEditView )
 383 {
 384     if( FindNextConversionCell() )
 385     {
 386         rEditView.StartTextConversion(
 387             maConvParam.GetSourceLang(), maConvParam.GetTargetLang(), maConvParam.GetTargetFont(),
 388             maConvParam.GetOptions(), maConvParam.IsInteractive(), true );
 389         // #i34769# restore initial cursor position
 390         RestoreCursorPos();
 391     }
 392 }
 393
 394 bool ScTextConversionEngine::ConvertNextDocument()
 395 {
 396     return FindNextConversionCell();
 397 }
 398
 399 bool ScTextConversionEngine::NeedsConversion()
 400 {
 401     return HasConvertibleTextPortion( maConvParam.GetSourceLang() );
 402 }
 403
 404 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */