sc/source/ui/dbgui/sfiltdlg.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 <sfx2/dispatch.hxx>
  21 #include <vcl/idle.hxx>
  22
  23 #include "uiitems.hxx"
  24 #include "rangenam.hxx"
  25 #include "dbdata.hxx"
  26 #include "reffact.hxx"
  27 #include "viewdata.hxx"
  28 #include "document.hxx"
  29 #include "docsh.hxx"
  30 #include "scresid.hxx"
  31
  32 #include "foptmgr.hxx"
  33
  34 #include "globstr.hrc"
  35 #include "filter.hrc"
  36
  37 #include "filtdlg.hxx"
  38 #include <vcl/msgbox.hxx>
  39
  40 // DEFINE --------------------------------------------------------------------
  41
  42 #define ERRORBOX(rid) ScopedVclPtrInstance<MessageDialog>::Create(this, ScGlobal::GetRscString(rid))->Execute()
  43
  44 //  class ScSpecialFilterDialog
  45
  46 ScSpecialFilterDlg::ScSpecialFilterDlg( SfxBindings* pB, SfxChildWindow* pCW, vcl::Window* pParent,
  47                                         const SfxItemSet&   rArgSet )
  48
  49     :   ScAnyRefDlg ( pB, pCW, pParent, "AdvancedFilterDialog", "modules/scalc/ui/advancedfilterdialog.ui" ),
  50
  51         aStrUndefined   ( SC_RESSTR(SCSTR_UNDEFINED) ),
  52         pOptionsMgr     ( NULL ),
  53         nWhichQuery     ( rArgSet.GetPool()->GetWhich( SID_QUERY ) ),
  54         theQueryData    ( static_cast<const ScQueryItem&>(
  55                            rArgSet.Get( nWhichQuery )).GetQueryData() ),
  56         pOutItem        ( NULL ),
  57         pViewData       ( NULL ),
  58         pDoc            ( NULL ),
  59         pRefInputEdit   ( NULL ),
  60         bRefInputMode   ( false ),
  61         pIdle          ( NULL )
  62 {
  63         get(pLbFilterArea,"lbfilterarea");
  64         get(pEdFilterArea,"edfilterarea");
  65         pEdFilterArea->SetReferences(this, get<VclFrame>("filterframe")->get_label_widget());
  66         get(pRbFilterArea,"rbfilterarea");
  67         pRbFilterArea->SetReferences(this, pEdFilterArea);
  68         get(pBtnCase,"case");
  69         get(pBtnRegExp,"regexp");
  70         get(pBtnHeader,"header");
  71         get(pBtnUnique,"unique");
  72         get(pBtnCopyResult,"copyresult");
  73         get(pLbCopyArea,"lbcopyarea");
  74         get(pEdCopyArea,"edcopyarea");
  75         pEdCopyArea->SetReferences(this, pBtnCopyResult);
  76         get(pRbCopyArea,"rbcopyarea");
  77         pRbCopyArea->SetReferences(this, pEdCopyArea);
  78         get(pBtnDestPers,"destpers");
  79         get(pFtDbAreaLabel,"dbarealabel");
  80         get(pFtDbArea,"dbarea");
  81         get(pBtnOk,"ok");
  82         get(pBtnCancel,"cancel");
  83         get(pExpander,"more");
  84
  85     Init( rArgSet );
  86     pEdFilterArea->GrabFocus();
  87
  88     // Hack: RefInput-Kontrolle
  89     pIdle = new Idle;
  90     // FIXME: this is an abomination
  91     pIdle->SetPriority( SchedulerPriority::LOWEST );
  92     pIdle->SetIdleHdl( LINK( this, ScSpecialFilterDlg, TimeOutHdl ) );
  93     pIdle->Start();
  94
  95     pLbCopyArea->SetAccessibleName(pBtnCopyResult->GetText());
  96     pEdCopyArea->SetAccessibleName(pBtnCopyResult->GetText());
  97 }
  98
  99 ScSpecialFilterDlg::~ScSpecialFilterDlg()
 100 {
 101     disposeOnce();
 102 }
 103
 104 void ScSpecialFilterDlg::dispose()
 105 {
 106     sal_uInt16 nEntries = pLbFilterArea->GetEntryCount();
 107     sal_uInt16 i;
 108
 109     for ( i=1; i<nEntries; i++ )
 110         delete static_cast<OUString*>(pLbFilterArea->GetEntryData( i ));
 111
 112     delete pOptionsMgr;
 113
 114     if ( pOutItem )
 115         delete pOutItem;
 116
 117     // Hack: RefInput-Kontrolle
 118     pIdle->Stop();
 119     delete pIdle;
 120
 121     pLbFilterArea.clear();
 122     pEdFilterArea.clear();
 123     pRbFilterArea.clear();
 124     pExpander.clear();
 125     pBtnCase.clear();
 126     pBtnRegExp.clear();
 127     pBtnHeader.clear();
 128     pBtnUnique.clear();
 129     pBtnCopyResult.clear();
 130     pLbCopyArea.clear();
 131     pEdCopyArea.clear();
 132     pRbCopyArea.clear();
 133     pBtnDestPers.clear();
 134     pFtDbAreaLabel.clear();
 135     pFtDbArea.clear();
 136     pBtnOk.clear();
 137     pBtnCancel.clear();
 138     pRefInputEdit.clear();
 139     ScAnyRefDlg::dispose();
 140 }
 141
 142 void ScSpecialFilterDlg::Init( const SfxItemSet& rArgSet )
 143 {
 144     const ScQueryItem& rQueryItem = static_cast<const ScQueryItem&>(
 145                                     rArgSet.Get( nWhichQuery ));
 146
 147     pBtnOk->SetClickHdl          ( LINK( this, ScSpecialFilterDlg, EndDlgHdl ) );
 148     pBtnCancel->SetClickHdl      ( LINK( this, ScSpecialFilterDlg, EndDlgHdl ) );
 149     pLbFilterArea->SetSelectHdl  ( LINK( this, ScSpecialFilterDlg, FilterAreaSelHdl ) );
 150     pEdFilterArea->SetModifyHdl  ( LINK( this, ScSpecialFilterDlg, FilterAreaModHdl ) );
 151
 152     pViewData   = rQueryItem.GetViewData();
 153     pDoc        = pViewData ? pViewData->GetDocument()  : NULL;
 154
 155     pEdFilterArea->SetText( EMPTY_OUSTRING );      // may be overwritten below
 156
 157     if ( pViewData && pDoc )
 158     {
 159         if(pDoc->GetChangeTrack()!=NULL) pBtnCopyResult->Disable();
 160
 161         ScRangeName* pRangeNames = pDoc->GetRangeName();
 162         pLbFilterArea->Clear();
 163         pLbFilterArea->InsertEntry( aStrUndefined, 0 );
 164
 165         if (!pRangeNames->empty())
 166         {
 167             ScRangeName::const_iterator itr = pRangeNames->begin(), itrEnd = pRangeNames->end();
 168             sal_uInt16 nInsert = 0;
 169             for (; itr != itrEnd; ++itr)
 170             {
 171                 if (!itr->second->HasType(RT_CRITERIA))
 172                     continue;
 173
 174                 nInsert = pLbFilterArea->InsertEntry(itr->second->GetName());
 175                 OUString aSymbol;
 176                 itr->second->GetSymbol(aSymbol);
 177                 pLbFilterArea->SetEntryData(nInsert, new OUString(aSymbol));
 178             }
 179         }
 180
 181         //  is there a stored source range?
 182
 183         ScRange aAdvSource;
 184         if (rQueryItem.GetAdvancedQuerySource(aAdvSource))
 185         {
 186             OUString aRefStr(aAdvSource.Format(SCR_ABS_3D, pDoc, pDoc->GetAddressConvention()));
 187             pEdFilterArea->SetRefString( aRefStr );
 188         }
 189     }
 190
 191     pLbFilterArea->SelectEntryPos( 0 );
 192
 193     // Optionen initialisieren lassen:
 194
 195     pOptionsMgr  = new ScFilterOptionsMgr(
 196                             pViewData,
 197                             theQueryData,
 198                             pBtnCase,
 199                             pBtnRegExp,
 200                             pBtnHeader,
 201                             pBtnUnique,
 202                             pBtnCopyResult,
 203                             pBtnDestPers,
 204                             pLbCopyArea,
 205                             pEdCopyArea,
 206                             pRbCopyArea,
 207                             pFtDbAreaLabel,
 208                             pFtDbArea,
 209                             aStrUndefined );
 210
 211     //  Spezialfilter braucht immer Spaltenkoepfe
 212     pBtnHeader->Check(true);
 213     pBtnHeader->Disable();
 214
 215     // Modal-Modus einschalten
 216 //  SetDispatcherLock( true );
 217     //@BugID 54702 Enablen/Disablen nur noch in Basisklasse
 218     //SFX_APPWINDOW->Disable(false);        //! allgemeine Methode im ScAnyRefDlg
 219 }
 220
 221 bool ScSpecialFilterDlg::Close()
 222 {
 223     if (pViewData)
 224         pViewData->GetDocShell()->CancelAutoDBRange();
 225
 226     return DoClose( ScSpecialFilterDlgWrapper::GetChildWindowId() );
 227 }
 228
 229 // Uebergabe eines mit der Maus selektierten Tabellenbereiches, der dann als
 230 // neue Selektion im Referenz-Edit angezeigt wird.
 231
 232 void ScSpecialFilterDlg::SetReference( const ScRange& rRef, ScDocument* pDocP )
 233 {
 234     if ( bRefInputMode && pRefInputEdit )       // Nur moeglich, wenn im Referenz-Editmodus
 235     {
 236         if ( rRef.aStart != rRef.aEnd )
 237             RefInputStart( pRefInputEdit );
 238
 239         OUString aRefStr;
 240         const formula::FormulaGrammar::AddressConvention eConv = pDocP->GetAddressConvention();
 241
 242         if ( pRefInputEdit == pEdCopyArea)
 243             aRefStr = rRef.aStart.Format(SCA_ABS_3D, pDocP, eConv);
 244         else if ( pRefInputEdit == pEdFilterArea)
 245             aRefStr = rRef.Format(SCR_ABS_3D, pDocP, eConv);
 246
 247         pRefInputEdit->SetRefString( aRefStr );
 248     }
 249 }
 250
 251 void ScSpecialFilterDlg::SetActive()
 252 {
 253     if ( bRefInputMode )
 254     {
 255         if ( pRefInputEdit == pEdCopyArea )
 256         {
 257             pEdCopyArea->GrabFocus();
 258             if ( pEdCopyArea->GetModifyHdl().IsSet() )
 259                 ((Link<>&)pEdCopyArea->GetModifyHdl()).Call( pEdCopyArea );
 260         }
 261         else if ( pRefInputEdit == pEdFilterArea )
 262         {
 263             pEdFilterArea->GrabFocus();
 264             FilterAreaModHdl( pEdFilterArea );
 265         }
 266     }
 267     else
 268         GrabFocus();
 269
 270     RefInputDone();
 271 }
 272
 273 ScQueryItem* ScSpecialFilterDlg::GetOutputItem( const ScQueryParam& rParam,
 274                                                 const ScRange& rSource )
 275 {
 276     if ( pOutItem ) DELETEZ( pOutItem );
 277     pOutItem = new ScQueryItem( nWhichQuery, &rParam );
 278     pOutItem->SetAdvancedQuerySource( &rSource );
 279
 280     return pOutItem;
 281 }
 282
 283 bool ScSpecialFilterDlg::IsRefInputMode() const
 284 {
 285     return bRefInputMode;
 286 }
 287
 288 // Handler:
 289
 290 IMPL_LINK( ScSpecialFilterDlg, EndDlgHdl, Button*, pBtn )
 291 {
 292     OSL_ENSURE( pDoc && pViewData, "Document or ViewData not found. :-/" );
 293
 294     if ( (pBtn == pBtnOk) && pDoc && pViewData )
 295     {
 296         OUString          theCopyStr( pEdCopyArea->GetText() );
 297         OUString          theAreaStr( pEdFilterArea->GetText() );
 298         ScQueryParam    theOutParam( theQueryData );
 299         ScAddress       theAdrCopy;
 300         bool            bEditInputOk    = true;
 301         bool            bQueryOk        = false;
 302         ScRange         theFilterArea;
 303         const formula::FormulaGrammar::AddressConvention eConv = pDoc->GetAddressConvention();
 304
 305         if ( pBtnCopyResult->IsChecked() )
 306         {
 307             sal_Int32 nColonPos = theCopyStr.indexOf( ':' );
 308
 309             if ( -1 != nColonPos )
 310                 theCopyStr = theCopyStr.copy( 0, nColonPos );
 311
 312             sal_uInt16 nResult = theAdrCopy.Parse( theCopyStr, pDoc, eConv );
 313
 314             if ( SCA_VALID != (nResult & SCA_VALID) )
 315             {
 316                 if (!pExpander->get_expanded())
 317                     pExpander->set_expanded(true);
 318
 319                 ERRORBOX( STR_INVALID_TABREF );
 320                 pEdCopyArea->GrabFocus();
 321                 bEditInputOk = false;
 322             }
 323         }
 324
 325         if ( bEditInputOk )
 326         {
 327             sal_uInt16 nResult = ScRange().Parse( theAreaStr, pDoc, eConv );
 328
 329             if ( SCA_VALID != (nResult & SCA_VALID) )
 330             {
 331                 ERRORBOX( STR_INVALID_TABREF );
 332                 pEdFilterArea->GrabFocus();
 333                 bEditInputOk = false;
 334             }
 335         }
 336
 337         if ( bEditInputOk )
 338         {
 339             /*
 340              * Alle Edit-Felder enthalten gueltige Bereiche.
 341              * Nun wird versucht aus dem Filterbereich
 342              * ein ScQueryParam zu erzeugen:
 343              */
 344
 345             sal_uInt16  nResult = theFilterArea.Parse( theAreaStr, pDoc, eConv );
 346
 347             if ( SCA_VALID == (nResult & SCA_VALID) )
 348             {
 349                 ScAddress& rStart = theFilterArea.aStart;
 350                 ScAddress& rEnd   = theFilterArea.aEnd;
 351
 352                 if ( pBtnCopyResult->IsChecked() )
 353                 {
 354                     theOutParam.bInplace    = false;
 355                     theOutParam.nDestTab    = theAdrCopy.Tab();
 356                     theOutParam.nDestCol    = theAdrCopy.Col();
 357                     theOutParam.nDestRow    = theAdrCopy.Row();
 358                 }
 359                 else
 360                 {
 361                     theOutParam.bInplace    = true;
 362                     theOutParam.nDestTab    = 0;
 363                     theOutParam.nDestCol    = 0;
 364                     theOutParam.nDestRow    = 0;
 365                 }
 366
 367                 theOutParam.bHasHeader = pBtnHeader->IsChecked();
 368                 theOutParam.bByRow     = true;
 369                 theOutParam.bCaseSens  = pBtnCase->IsChecked();
 370                 theOutParam.bRegExp    = pBtnRegExp->IsChecked();
 371                 theOutParam.bDuplicate = !pBtnUnique->IsChecked();
 372                 theOutParam.bDestPers  = pBtnDestPers->IsChecked();
 373
 374                 bQueryOk =
 375                     pDoc->CreateQueryParam( rStart.Col(),
 376                                             rStart.Row(),
 377                                             rEnd.Col(),
 378                                             rEnd.Row(),
 379                                             rStart.Tab(),
 380                                             theOutParam );
 381             }
 382         }
 383
 384         if ( bQueryOk )
 385         {
 386             SetDispatcherLock( false );
 387             SwitchToDocument();
 388             GetBindings().GetDispatcher()->Execute( FID_FILTER_OK,
 389                                       SfxCallMode::SLOT | SfxCallMode::RECORD,
 390                                       GetOutputItem( theOutParam, theFilterArea ), 0L, 0L );
 391             Close();
 392         }
 393         else
 394         {
 395             ERRORBOX( STR_INVALID_QUERYAREA );
 396             pEdFilterArea->GrabFocus();
 397         }
 398     }
 399     else if ( pBtn == pBtnCancel )
 400     {
 401         Close();
 402     }
 403     return 0;
 404 }
 405
 406 IMPL_LINK_TYPED( ScSpecialFilterDlg, TimeOutHdl, Idle*, _pIdle, void )
 407 {
 408     // alle 50ms nachschauen, ob RefInputMode noch stimmt
 409
 410     if( (_pIdle == pIdle) && IsActive() )
 411     {
 412         if( pEdCopyArea->HasFocus() || pRbCopyArea->HasFocus() )
 413         {
 414             pRefInputEdit = pEdCopyArea;
 415             bRefInputMode = true;
 416         }
 417         else if( pEdFilterArea->HasFocus() || pRbFilterArea->HasFocus() )
 418         {
 419             pRefInputEdit = pEdFilterArea;
 420             bRefInputMode = true;
 421         }
 422         else if( bRefInputMode )
 423         {
 424             pRefInputEdit = NULL;
 425             bRefInputMode = false;
 426         }
 427     }
 428
 429     pIdle->Start();
 430 }
 431
 432 IMPL_LINK( ScSpecialFilterDlg, FilterAreaSelHdl, ListBox*, pLb )
 433 {
 434     if ( pLb == pLbFilterArea )
 435     {
 436         OUString  aString;
 437         sal_uInt16  nSelPos = pLbFilterArea->GetSelectEntryPos();
 438
 439         if ( nSelPos > 0 )
 440             aString = *static_cast<OUString*>(pLbFilterArea->GetEntryData( nSelPos ));
 441
 442         pEdFilterArea->SetText( aString );
 443     }
 444
 445     return 0;
 446 }
 447
 448 IMPL_LINK( ScSpecialFilterDlg, FilterAreaModHdl, formula::RefEdit*, pEd )
 449 {
 450     if ( pEd == pEdFilterArea )
 451     {
 452         if ( pDoc && pViewData )
 453         {
 454             OUString  theCurAreaStr = pEd->GetText();
 455             sal_uInt16  nResult = ScRange().Parse( theCurAreaStr, pDoc );
 456
 457             if ( SCA_VALID == (nResult & SCA_VALID) )
 458             {
 459                 bool    bFound  = false;
 460                 sal_uInt16  i       = 0;
 461                 sal_uInt16  nCount  = pLbFilterArea->GetEntryCount();
 462
 463                 for ( i=1; i<nCount && !bFound; i++ )
 464                 {
 465                     OUString* pStr = static_cast<OUString*>(pLbFilterArea->GetEntryData( i ));
 466                     bFound = (theCurAreaStr == *pStr);
 467                 }
 468
 469                 if ( bFound )
 470                     pLbFilterArea->SelectEntryPos( --i );
 471                 else
 472                     pLbFilterArea->SelectEntryPos( 0 );
 473             }
 474         }
 475         else
 476             pLbFilterArea->SelectEntryPos( 0 );
 477     }
 478
 479     return 0;
 480 }
 481
 482 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */