sc/source/ui/namedlg/namedlg.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 "global.hxx"
  21 #include "reffact.hxx"
  22 #include "document.hxx"
  23 #include "docfunc.hxx"
  24 #include "scresid.hxx"
  25 #include "globstr.hrc"
  26 #include "namedlg.hxx"
  27 #include "viewdata.hxx"
  28 #include "tabvwsh.hxx"
  29
  30 #include "globalnames.hxx"
  31 #include "tokenarray.hxx"
  32
  33 #include <sfx2/app.hxx>
  34
  35 #include <vcl/msgbox.hxx>
  36 #include <vcl/settings.hxx>
  37
  38 #include <map>
  39
  40 // defines -------------------------------------------------------------------
  41
  42 #define ABS_SREF          SCA_VALID \
  43     | SCA_COL_ABSOLUTE | SCA_ROW_ABSOLUTE | SCA_TAB_ABSOLUTE
  44 #define ABS_DREF          ABS_SREF \
  45     | SCA_COL2_ABSOLUTE | SCA_ROW2_ABSOLUTE | SCA_TAB2_ABSOLUTE
  46 #define ABS_DREF3D      ABS_DREF | SCA_TAB_3D
  47
  48 //logic
  49
  50 ScNameDlg::ScNameDlg( SfxBindings* pB, SfxChildWindow* pCW, vcl::Window* pParent,
  51         ScViewData*       ptrViewData,
  52         const ScAddress&  aCursorPos, boost::ptr_map<OUString, ScRangeName>* pRangeMap  )
  53     : ScAnyRefDlg(pB, pCW, pParent, "ManageNamesDialog", "modules/scalc/ui/managenamesdialog.ui")
  54
  55     , maGlobalNameStr(ScGlobal::GetRscString(STR_GLOBAL_SCOPE))
  56     , maErrInvalidNameStr(ScGlobal::GetRscString(STR_ERR_NAME_INVALID))
  57     , maErrNameInUse(ScGlobal::GetRscString(STR_ERR_NAME_EXISTS))
  58     , maStrMultiSelect(ScGlobal::GetRscString(STR_MULTI_SELECT))
  59
  60     , mpViewData(ptrViewData)
  61     , mpDoc(ptrViewData->GetDocument())
  62     , maCursorPos(aCursorPos)
  63     , mbNeedUpdate(true)
  64     , mbDataChanged(false)
  65     , mbCloseWithoutUndo(false)
  66 {
  67     get(m_pEdName, "name");
  68     get(m_pEdAssign, "range");
  69     m_pEdAssign->SetReferences(this, m_pEdName);
  70     get(m_pRbAssign, "assign");
  71     m_pRbAssign->SetReferences(this, m_pEdAssign);
  72     get(m_pLbScope, "scope");
  73     get(m_pBtnPrintArea, "printrange");
  74     get(m_pBtnColHeader, "colheader");
  75     get(m_pBtnCriteria, "filter");
  76     get(m_pBtnRowHeader, "rowheader");
  77     get(m_pBtnAdd, "add");
  78     get(m_pBtnDelete, "delete");
  79     get(m_pBtnOk, "ok");
  80     get(m_pBtnCancel, "cancel");
  81     get(m_pFtInfo, "info");
  82     maStrInfoDefault = m_pFtInfo->GetText();
  83     m_pFtInfo->SetText(OUString());
  84
  85     if (!pRangeMap)
  86     {
  87         std::map<OUString, ScRangeName*> aRangeMap;
  88         mpDoc->GetRangeNameMap(aRangeMap);
  89         std::map<OUString, ScRangeName*>::iterator itr = aRangeMap.begin(), itrEnd = aRangeMap.end();
  90         for (; itr != itrEnd; ++itr)
  91         {
  92             OUString aTemp(itr->first);
  93             maRangeMap.insert(aTemp, new ScRangeName(*itr->second));
  94         }
  95     }
  96     else
  97     {
  98         maRangeMap.swap(*pRangeMap);
  99     }
 100     Init();
 101 }
 102
 103 ScNameDlg::~ScNameDlg()
 104 {
 105     disposeOnce();
 106 }
 107
 108 void ScNameDlg::dispose()
 109 {
 110     m_pRangeManagerTable.disposeAndClear();
 111     m_pEdName.clear();
 112     m_pEdAssign.clear();
 113     m_pRbAssign.clear();
 114     m_pLbScope.clear();
 115     m_pBtnPrintArea.clear();
 116     m_pBtnColHeader.clear();
 117     m_pBtnCriteria.clear();
 118     m_pBtnRowHeader.clear();
 119     m_pBtnAdd.clear();
 120     m_pBtnDelete.clear();
 121     m_pBtnOk.clear();
 122     m_pBtnCancel.clear();
 123     m_pFtInfo.clear();
 124     ScAnyRefDlg::dispose();
 125 }
 126
 127 void ScNameDlg::Init()
 128 {
 129     ScRange aRange;
 130
 131     OSL_ENSURE( mpViewData && mpDoc, "ViewData oder Document nicht gefunden!" );
 132
 133     //init UI
 134     m_pFtInfo->SetStyle(WB_VCENTER);
 135
 136     SvSimpleTableContainer *pCtrl = get<SvSimpleTableContainer>("names");
 137     pCtrl->set_height_request(pCtrl->GetTextHeight()*12);
 138
 139     m_pRangeManagerTable = VclPtr<ScRangeManagerTable>::Create(*pCtrl, maRangeMap, maCursorPos);
 140     m_pRangeManagerTable->setInitListener(this);
 141     m_pRangeManagerTable->SetSelectHdl( LINK( this, ScNameDlg, SelectionChangedHdl_Impl ) );
 142     m_pRangeManagerTable->SetDeselectHdl( LINK( this, ScNameDlg, SelectionChangedHdl_Impl ) );
 143
 144     m_pBtnOk->SetClickHdl  ( LINK( this, ScNameDlg, OkBtnHdl ) );
 145     m_pBtnCancel->SetClickHdl  ( LINK( this, ScNameDlg, CancelBtnHdl ) );
 146     m_pBtnAdd->SetClickHdl     ( LINK( this, ScNameDlg, AddBtnHdl ) );
 147     m_pEdAssign->SetGetFocusHdl( LINK( this, ScNameDlg, AssignGetFocusHdl ) );
 148     m_pEdAssign->SetModifyHdl  ( LINK( this, ScNameDlg, EdModifyHdl ) );
 149     m_pEdName->SetModifyHdl ( LINK( this, ScNameDlg, EdModifyHdl ) );
 150     m_pLbScope->SetSelectHdl( LINK(this, ScNameDlg, ScopeChangedHdl) );
 151     m_pBtnDelete->SetClickHdl ( LINK( this, ScNameDlg, RemoveBtnHdl ) );
 152     m_pBtnPrintArea->SetToggleHdl( LINK(this, ScNameDlg, EdModifyHdl ) );
 153     m_pBtnCriteria->SetToggleHdl( LINK(this, ScNameDlg, EdModifyHdl ) );
 154     m_pBtnRowHeader->SetToggleHdl( LINK(this, ScNameDlg, EdModifyHdl ) );
 155     m_pBtnColHeader->SetToggleHdl( LINK(this, ScNameDlg, EdModifyHdl ) );
 156
 157     // Initialize scope list.
 158     m_pLbScope->InsertEntry(maGlobalNameStr);
 159     m_pLbScope->SelectEntryPos(0);
 160     SCTAB n = mpDoc->GetTableCount();
 161     for (SCTAB i = 0; i < n; ++i)
 162     {
 163         OUString aTabName;
 164         mpDoc->GetName(i, aTabName);
 165         m_pLbScope->InsertEntry(aTabName);
 166     }
 167
 168     CheckForEmptyTable();
 169 }
 170
 171 bool ScNameDlg::IsRefInputMode() const
 172 {
 173     return m_pEdAssign->IsEnabled();
 174 }
 175
 176 void ScNameDlg::RefInputDone( bool bForced)
 177 {
 178     ScAnyRefDlg::RefInputDone(bForced);
 179     EdModifyHdl(m_pEdAssign);
 180 }
 181
 182 void ScNameDlg::SetReference( const ScRange& rRef, ScDocument* pDocP )
 183 {
 184     if ( m_pEdAssign->IsEnabled() )
 185     {
 186         if ( rRef.aStart != rRef.aEnd )
 187             RefInputStart(m_pEdAssign);
 188         OUString aRefStr(rRef.Format(ABS_DREF3D, pDocP,
 189                 ScAddress::Details(pDocP->GetAddressConvention(), 0, 0)));
 190         m_pEdAssign->SetRefString( aRefStr );
 191     }
 192 }
 193
 194 bool ScNameDlg::Close()
 195 {
 196     if (mbDataChanged && !mbCloseWithoutUndo)
 197         mpViewData->GetDocFunc().ModifyAllRangeNames(maRangeMap);
 198     return DoClose( ScNameDlgWrapper::GetChildWindowId() );
 199 }
 200
 201 void ScNameDlg::tableInitialized()
 202 {
 203     if (m_pRangeManagerTable->GetSelectionCount())
 204         SelectionChanged();
 205 }
 206
 207 void ScNameDlg::CheckForEmptyTable()
 208 {
 209     if (!m_pRangeManagerTable->GetEntryCount())
 210     {
 211         m_pBtnDelete->Disable();
 212         m_pEdAssign->Disable();
 213         m_pRbAssign->Disable();
 214         m_pEdName->Disable();
 215         m_pLbScope->Disable();
 216
 217         m_pBtnCriteria->Disable();
 218         m_pBtnPrintArea->Disable();
 219         m_pBtnColHeader->Disable();
 220         m_pBtnRowHeader->Disable();
 221     }
 222     else
 223     {
 224         m_pBtnDelete->Enable();
 225         m_pEdAssign->Enable();
 226         m_pRbAssign->Enable();
 227         m_pEdName->Enable();
 228         m_pLbScope->Enable();
 229
 230         m_pBtnCriteria->Enable();
 231         m_pBtnPrintArea->Enable();
 232         m_pBtnColHeader->Enable();
 233         m_pBtnRowHeader->Enable();
 234     }
 235 }
 236
 237 void ScNameDlg::CancelPushed()
 238 {
 239     DoClose( ScNameDlgWrapper::GetChildWindowId() );
 240 }
 241
 242 void ScNameDlg::SetActive()
 243 {
 244     m_pEdAssign->GrabFocus();
 245     RefInputDone();
 246 }
 247
 248 void ScNameDlg::UpdateChecks(ScRangeData* pData)
 249 {
 250     // remove handlers, we only want the handlers to process
 251     // user input and not when we are syncing the controls  with our internal
 252     // model ( also UpdateChecks is called already from some other event
 253     // handlers, triggering handlers while already processing a handler can
 254     // ( and does in this case ) corrupt the internal data
 255
 256     m_pBtnCriteria->SetToggleHdl( Link<>() );
 257     m_pBtnPrintArea->SetToggleHdl( Link<>() );
 258     m_pBtnColHeader->SetToggleHdl( Link<>() );
 259     m_pBtnRowHeader->SetToggleHdl( Link<>() );
 260
 261     m_pBtnCriteria->Check( pData->HasType( RT_CRITERIA ) );
 262     m_pBtnPrintArea->Check( pData->HasType( RT_PRINTAREA ) );
 263     m_pBtnColHeader->Check( pData->HasType( RT_COLHEADER ) );
 264     m_pBtnRowHeader->Check( pData->HasType( RT_ROWHEADER ) );
 265
 266     // Restore handlers so user input is processed again
 267     Link<> aToggleHandler = LINK( this, ScNameDlg, EdModifyHdl );
 268     m_pBtnCriteria->SetToggleHdl( aToggleHandler );
 269     m_pBtnPrintArea->SetToggleHdl( aToggleHandler );
 270     m_pBtnColHeader->SetToggleHdl( aToggleHandler );
 271     m_pBtnRowHeader->SetToggleHdl( aToggleHandler );
 272 }
 273
 274 bool ScNameDlg::IsNameValid()
 275 {
 276     OUString aScope = m_pLbScope->GetSelectEntry();
 277     OUString aName = m_pEdName->GetText();
 278     aName = aName.trim();
 279
 280     if (aName.isEmpty())
 281         return false;
 282
 283     ScRangeName* pRangeName = GetRangeName( aScope );
 284
 285     if (!ScRangeData::IsNameValid( aName, mpDoc ))
 286     {
 287         m_pFtInfo->SetControlBackground(GetSettings().GetStyleSettings().GetHighlightColor());
 288         m_pFtInfo->SetText(maErrInvalidNameStr);
 289         return false;
 290     }
 291     else if (pRangeName && pRangeName->findByUpperName(ScGlobal::pCharClass->uppercase(aName)))
 292     {
 293         m_pFtInfo->SetControlBackground(GetSettings().GetStyleSettings().GetHighlightColor());
 294         m_pFtInfo->SetText(maErrNameInUse);
 295         return false;
 296     }
 297     m_pFtInfo->SetText( maStrInfoDefault );
 298     return true;
 299 }
 300
 301 bool ScNameDlg::IsFormulaValid()
 302 {
 303     ScCompiler aComp( mpDoc, maCursorPos);
 304     aComp.SetGrammar( mpDoc->GetGrammar() );
 305     ScTokenArray* pCode = aComp.CompileString(m_pEdAssign->GetText());
 306     if (pCode->GetCodeError())
 307     {
 308         m_pFtInfo->SetControlBackground(GetSettings().GetStyleSettings().GetHighlightColor());
 309         delete pCode;
 310         return false;
 311     }
 312     else
 313     {
 314         delete pCode;
 315         return true;
 316     }
 317 }
 318
 319 ScRangeName* ScNameDlg::GetRangeName(const OUString& rScope)
 320 {
 321     if (rScope == maGlobalNameStr)
 322         return maRangeMap.find(OUString(STR_GLOBAL_RANGE_NAME))->second;
 323     else
 324         return maRangeMap.find(rScope)->second;
 325 }
 326
 327 void ScNameDlg::ShowOptions(const ScRangeNameLine& rLine)
 328 {
 329     ScRangeName* pRangeName = GetRangeName(rLine.aScope);
 330     ScRangeData* pData = pRangeName->findByUpperName(ScGlobal::pCharClass->uppercase(rLine.aName));
 331     if (pData)
 332     {
 333         UpdateChecks(pData);
 334     }
 335 }
 336
 337 bool ScNameDlg::AddPushed()
 338 {
 339     mbCloseWithoutUndo = true;
 340     ScTabViewShell* pViewSh = ScTabViewShell::GetActiveViewShell();
 341     pViewSh->SwitchBetweenRefDialogs(this);
 342     return false;
 343 }
 344
 345 void ScNameDlg::SetEntry(const OUString& rName, const OUString& rScope)
 346 {
 347     if (!rName.isEmpty())
 348     {
 349         mbDataChanged = true;
 350         ScRangeNameLine aLine;
 351         aLine.aName = rName;
 352         aLine.aScope = rScope;
 353         m_pRangeManagerTable->SetEntry(aLine);
 354     }
 355 }
 356
 357 void ScNameDlg::RemovePushed()
 358 {
 359     std::vector<ScRangeNameLine> maEntries = m_pRangeManagerTable->GetSelectedEntries();
 360     m_pRangeManagerTable->DeleteSelectedEntries();
 361     for (std::vector<ScRangeNameLine>::iterator itr = maEntries.begin(); itr != maEntries.end(); ++itr)
 362     {
 363         ScRangeName* pRangeName = GetRangeName(itr->aScope);
 364         ScRangeData* pData = pRangeName->findByUpperName(ScGlobal::pCharClass->uppercase(itr->aName));
 365         OSL_ENSURE(pData, "table and model should be in sync");
 366         // be safe and check for possible problems
 367         if (pData)
 368             pRangeName->erase(*pData);
 369
 370         mbDataChanged = true;
 371     }
 372     CheckForEmptyTable();
 373 }
 374
 375 void ScNameDlg::NameModified()
 376 {
 377     ScRangeNameLine aLine;
 378     m_pRangeManagerTable->GetCurrentLine(aLine);
 379     OUString aOldName = aLine.aName;
 380     OUString aNewName = m_pEdName->GetText();
 381     aNewName = aNewName.trim();
 382     m_pFtInfo->SetControlBackground(GetSettings().GetStyleSettings().GetDialogColor());
 383     if (aNewName != aOldName)
 384     {
 385         if (!IsNameValid())
 386             return;
 387     }
 388     else
 389     {
 390         m_pFtInfo->SetText( maStrInfoDefault );
 391     }
 392
 393     if (!IsFormulaValid())
 394     {
 395         //TODO: implement an info text
 396         return;
 397     }
 398
 399     OUString aOldScope = aLine.aScope;
 400     //empty table
 401     if (aOldScope.isEmpty())
 402         return;
 403     OUString aExpr = m_pEdAssign->GetText();
 404     OUString aNewScope = m_pLbScope->GetSelectEntry();
 405
 406     ScRangeName* pOldRangeName = GetRangeName( aOldScope );
 407     ScRangeData* pData = pOldRangeName->findByUpperName( ScGlobal::pCharClass->uppercase(aOldName) );
 408     ScRangeName* pNewRangeName = GetRangeName( aNewScope );
 409     OSL_ENSURE(pData, "model and table should be in sync");
 410     // be safe and check for range data
 411     if (pData)
 412     {
 413         pOldRangeName->erase(*pData);
 414         mbNeedUpdate = false;
 415         m_pRangeManagerTable->DeleteSelectedEntries();
 416         RangeType nType = RT_NAME |
 417             (m_pBtnRowHeader->IsChecked() ? RT_ROWHEADER : RangeType(0))
 418             |(m_pBtnColHeader->IsChecked() ? RT_COLHEADER : RangeType(0))
 419             |(m_pBtnPrintArea->IsChecked() ? RT_PRINTAREA : RangeType(0))
 420             |(m_pBtnCriteria->IsChecked()  ? RT_CRITERIA  : RangeType(0));
 421
 422         ScRangeData* pNewEntry = new ScRangeData( mpDoc, aNewName, aExpr,
 423                 maCursorPos, nType);
 424         pNewRangeName->insert(pNewEntry);
 425         aLine.aName = aNewName;
 426         aLine.aExpression = aExpr;
 427         aLine.aScope = aNewScope;
 428         m_pRangeManagerTable->addEntry(aLine);
 429         mbNeedUpdate = true;
 430         mbDataChanged = true;
 431     }
 432 }
 433
 434 void ScNameDlg::SelectionChanged()
 435 {
 436     //don't update if we have just modified due to user input
 437     if (!mbNeedUpdate)
 438     {
 439         return;
 440     }
 441
 442     if (m_pRangeManagerTable->IsMultiSelection())
 443     {
 444         m_pEdName->SetText(maStrMultiSelect);
 445         m_pEdAssign->SetText(maStrMultiSelect);
 446
 447         m_pEdName->Disable();
 448         m_pEdAssign->Disable();
 449         m_pRbAssign->Disable();
 450         m_pLbScope->Disable();
 451         m_pBtnRowHeader->Disable();
 452         m_pBtnColHeader->Disable();
 453         m_pBtnPrintArea->Disable();
 454         m_pBtnCriteria->Disable();
 455     }
 456     else
 457     {
 458         ScRangeNameLine aLine;
 459         m_pRangeManagerTable->GetCurrentLine(aLine);
 460         m_pEdAssign->SetText(aLine.aExpression);
 461         m_pEdName->SetText(aLine.aName);
 462         m_pLbScope->SelectEntry(aLine.aScope);
 463         ShowOptions(aLine);
 464         m_pBtnDelete->Enable();
 465         m_pEdName->Enable();
 466         m_pEdAssign->Enable();
 467         m_pRbAssign->Enable();
 468         m_pLbScope->Enable();
 469         m_pBtnRowHeader->Enable();
 470         m_pBtnColHeader->Enable();
 471         m_pBtnPrintArea->Enable();
 472         m_pBtnCriteria->Enable();
 473     }
 474 }
 475
 476 void ScNameDlg::ScopeChanged()
 477 {
 478     NameModified();
 479 }
 480
 481 void ScNameDlg::GetRangeNames(boost::ptr_map<OUString, ScRangeName>& rRangeMap)
 482 {
 483     maRangeMap.swap(rRangeMap);
 484 }
 485
 486 IMPL_LINK_NOARG(ScNameDlg, OkBtnHdl)
 487 {
 488     Close();
 489     return 0;
 490 }
 491
 492 IMPL_LINK_NOARG(ScNameDlg, CancelBtnHdl)
 493 {
 494     CancelPushed();
 495     return 0;
 496 }
 497
 498 IMPL_LINK_NOARG(ScNameDlg, AddBtnHdl)
 499 {
 500     return long(AddPushed());
 501 }
 502
 503 IMPL_LINK_NOARG(ScNameDlg, RemoveBtnHdl)
 504 {
 505     RemovePushed();
 506     return 0;
 507 }
 508
 509 IMPL_LINK_NOARG(ScNameDlg, EdModifyHdl)
 510 {
 511     NameModified();
 512     return 0;
 513 }
 514
 515 IMPL_LINK_NOARG(ScNameDlg, AssignGetFocusHdl)
 516 {
 517     EdModifyHdl(m_pEdAssign);
 518     return 0;
 519 }
 520
 521 IMPL_LINK_NOARG(ScNameDlg, SelectionChangedHdl_Impl)
 522 {
 523     SelectionChanged();
 524     return 0;
 525 }
 526
 527 IMPL_LINK_NOARG(ScNameDlg, ScopeChangedHdl)
 528 {
 529     ScopeChanged();
 530     return 0;
 531 }
 532
 533 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */