sc/source/ui/formdlg/dwfunctr.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 <comphelper/string.hxx>
  21 #include <editeng/editview.hxx>
  22 #include <sfx2/viewsh.hxx>
  23 #include <formula/funcvarargs.h>
  24
  25 #include <global.hxx>
  26 #include <scmod.hxx>
  27 #include <inputhdl.hxx>
  28 #include <tabvwsh.hxx>
  29 #include <funcdesc.hxx>
  30
  31 #include <dwfunctr.hxx>
  32
  33 /*************************************************************************
  34 #*  Member:     ScFunctionWin
  35 #*------------------------------------------------------------------------
  36 #*
  37 #*  Class:      ScFunctionWin
  38 #*
  39 #*  Function:   Constructor of ScFunctionWin Class
  40 #*
  41 #*  Input:      Sfx - links, window, resource
  42 #*
  43 #*  Output:     ---
  44 #*
  45 #************************************************************************/
  46
  47 ScFunctionWin::ScFunctionWin(vcl::Window* pParent, const css::uno::Reference<css::frame::XFrame> &rFrame)
  48     : PanelLayout(pParent, "FunctionPanel", "modules/scalc/ui/functionpanel.ui", rFrame)
  49     , xCatBox(m_xBuilder->weld_combo_box("category"))
  50     , xFuncList(m_xBuilder->weld_tree_view("funclist"))
  51     , xInsertButton(m_xBuilder->weld_button("insert"))
  52     , xFiFuncDesc(m_xBuilder->weld_label("funcdesc"))
  53     , xConfigListener(new comphelper::ConfigurationListener("/org.openoffice.Office.Calc/Formula/Syntax"))
  54     , xConfigChange(std::make_unique<EnglishFunctionNameChange>(xConfigListener, this))
  55     , pFuncDesc(nullptr)
  56 {
  57     xFuncList->set_size_request(-1, xFuncList->get_height_rows(10));
  58
  59     InitLRUList();
  60
  61     nArgs=0;
  62     xFiFuncDesc->set_size_request(-1, 5 * xFiFuncDesc->get_text_height());
  63
  64     xCatBox->connect_changed(LINK( this, ScFunctionWin, SelComboHdl));
  65     xFuncList->connect_changed(LINK( this, ScFunctionWin, SelTreeHdl));
  66
  67     xFuncList->connect_row_activated(LINK( this, ScFunctionWin, SetRowActivatedHdl));
  68     xInsertButton->connect_clicked(LINK( this, ScFunctionWin, SetSelectionClickHdl));
  69
  70     xCatBox->set_active(0);
  71
  72     SelComboHdl(*xCatBox);
  73
  74     m_pInitialFocusWidget = xCatBox.get();
  75 }
  76
  77 /*************************************************************************
  78 #*  Member:     ScFunctionWin
  79 #*------------------------------------------------------------------------
  80 #*
  81 #*  Class:      ScFunctionWin
  82 #*
  83 #*  Function:   Destructor of ScFunctionWin Class
  84 #*
  85 #*  Input:      ---
  86 #*
  87 #*  Output:     ---
  88 #*
  89 #************************************************************************/
  90
  91 ScFunctionWin::~ScFunctionWin()
  92 {
  93     disposeOnce();
  94 }
  95
  96 void ScFunctionWin::dispose()
  97 {
  98     if (xConfigChange)
  99     {
 100         xConfigChange.reset();
 101         xConfigListener->dispose();
 102         xConfigListener.clear();
 103     }
 104     xCatBox.reset();
 105     xFuncList.reset();
 106     xInsertButton.reset();
 107     xFiFuncDesc.reset();
 108     PanelLayout::dispose();
 109 }
 110
 111 /*************************************************************************
 112 #*  Member:     UpdateFunctionList
 113 #*------------------------------------------------------------------------
 114 #*
 115 #*  Class:      ScFunctionWin
 116 #*
 117 #*  Function:   Updates the list of functions depending on the set category
 118 #*
 119 #*  Input:      ---
 120 #*
 121 #*  Output:     ---
 122 #*
 123 #************************************************************************/
 124
 125 void ScFunctionWin::InitLRUList()
 126 {
 127     ScFunctionMgr* pFuncMgr = ScGlobal::GetStarCalcFunctionMgr();
 128     pFuncMgr->fillLastRecentlyUsedFunctions(aLRUList);
 129
 130     sal_Int32 nSelPos  = xCatBox->get_active();
 131
 132     if (nSelPos == 0)
 133         UpdateFunctionList();
 134 }
 135
 136 /*************************************************************************
 137 #*  Member:     UpdateFunctionList
 138 #*------------------------------------------------------------------------
 139 #*
 140 #*  Class:      ScFunctionWin
 141 #*
 142 #*  Function:   Updates the list of last used functions.
 143 #*
 144 #*  Input:      ---
 145 #*
 146 #*  Output:     ---
 147 #*
 148 #************************************************************************/
 149
 150 void ScFunctionWin::UpdateLRUList()
 151 {
 152     if (pFuncDesc && pFuncDesc->nFIndex!=0)
 153     {
 154         ScModule* pScMod = SC_MOD();
 155         pScMod->InsertEntryToLRUList(pFuncDesc->nFIndex);
 156     }
 157 }
 158
 159 /*************************************************************************
 160 #*  Member:     SetDescription
 161 #*------------------------------------------------------------------------
 162 #*
 163 #*  Class:      ScFunctionWin
 164 #*
 165 #*  Function:
 166 #*
 167 #*  Input:      ---
 168 #*
 169 #*  Output:     ---
 170 #*
 171 #************************************************************************/
 172
 173 void ScFunctionWin::SetDescription()
 174 {
 175     xFiFuncDesc->set_label(EMPTY_OUSTRING);
 176     const ScFuncDesc* pDesc =
 177              reinterpret_cast<const ScFuncDesc*>(xFuncList->get_selected_id().toInt64());
 178     if (pDesc)
 179     {
 180         pDesc->initArgumentInfo();      // full argument info is needed
 181
 182         OUStringBuffer aBuf(xFuncList->get_selected_text());
 183         aBuf.append(":\n\n");
 184         aBuf.append(pDesc->GetParamList());
 185         aBuf.append("\n\n");
 186         aBuf.append(*pDesc->mxFuncDesc);
 187
 188         xFiFuncDesc->set_label(aBuf.makeStringAndClear());
 189     }
 190 }
 191
 192 /*************************************************************************
 193 #*  Member:     UpdateFunctionList
 194 #*------------------------------------------------------------------------
 195 #*
 196 #*  Class:      ScFunctionWin
 197 #*
 198 #*  Function:   Updates the list of functions depending on the set category
 199 #*
 200 #*  Input:      ---
 201 #*
 202 #*  Output:     ---
 203 #*
 204 #************************************************************************/
 205
 206 void ScFunctionWin::UpdateFunctionList()
 207 {
 208     sal_Int32  nSelPos   = xCatBox->get_active();
 209     sal_Int32  nCategory = ( -1 != nSelPos )
 210                             ? (nSelPos-1) : 0;
 211
 212     xFuncList->clear();
 213     xFuncList->freeze();
 214
 215     if ( nSelPos > 0 )
 216     {
 217         ScFunctionMgr* pFuncMgr = ScGlobal::GetStarCalcFunctionMgr();
 218
 219         const ScFuncDesc* pDesc = pFuncMgr->First( nCategory );
 220         while ( pDesc )
 221         {
 222             xFuncList->append(OUString::number(reinterpret_cast<sal_Int64>(pDesc)), *(pDesc->mxFuncName));
 223             pDesc = pFuncMgr->Next();
 224         }
 225     }
 226     else // LRU list
 227     {
 228         for (const formula::IFunctionDescription* pDesc : aLRUList)
 229         {
 230             if (pDesc)
 231             {
 232                 xFuncList->append(OUString::number(reinterpret_cast<sal_Int64>(pDesc)), pDesc->getFunctionName());
 233             }
 234         }
 235     }
 236
 237     xFuncList->thaw();
 238
 239     if (xFuncList->n_children() > 0)
 240     {
 241         xFuncList->set_sensitive(true);
 242         xFuncList->select(0);
 243     }
 244     else
 245     {
 246         xFuncList->set_sensitive(false);
 247     }
 248 }
 249
 250 /*************************************************************************
 251 #*  Member:     DoEnter
 252 #*------------------------------------------------------------------------
 253 #*
 254 #*  Class:      ScFunctionWin
 255 #*
 256 #*  Function:   Save input into document. Is called after clicking the
 257 #*              Apply button or a double-click on the function list.
 258 #*
 259 #*  Input:      ---
 260 #*
 261 #*  Output:     ---
 262 #*
 263 #************************************************************************/
 264
 265 void ScFunctionWin::DoEnter()
 266 {
 267     OUStringBuffer aArgStr;
 268     OUString aString=xFuncList->get_selected_text();
 269     SfxViewShell* pCurSh = SfxViewShell::Current();
 270     nArgs=0;
 271
 272     if(!aString.isEmpty())
 273     {
 274         OUString aFirstArgStr;
 275         ScModule* pScMod = SC_MOD();
 276         ScTabViewShell* pViewSh = dynamic_cast<ScTabViewShell*>( pCurSh );
 277         ScInputHandler* pHdl = pScMod->GetInputHdl( pViewSh );
 278         if(!pScMod->IsEditMode())
 279         {
 280             pScMod->SetInputMode(SC_INPUT_TABLE);
 281             // the above call can result in us being disposed
 282             if (OutputDevice::isDisposed())
 283                 return;
 284             aString = "=" + xFuncList->get_selected_text();
 285             if (pHdl)
 286                 pHdl->ClearText();
 287         }
 288         const ScFuncDesc* pDesc =
 289              reinterpret_cast<const ScFuncDesc*>(xFuncList->get_selected_id().toInt64());
 290         if (pDesc)
 291         {
 292             pFuncDesc=pDesc;
 293             UpdateLRUList();
 294             nArgs = pDesc->nArgCount;
 295             if(nArgs>0)
 296             {
 297                 // NOTE: Theoretically the first parameter could have the
 298                 // suppress flag as well, but practically it doesn't.
 299                 aFirstArgStr = pDesc->maDefArgNames[0];
 300                 aFirstArgStr = comphelper::string::strip(aFirstArgStr, ' ');
 301                 aFirstArgStr = aFirstArgStr.replaceAll(" ", "_");
 302                 aArgStr = aFirstArgStr;
 303                 if ( nArgs != VAR_ARGS && nArgs != PAIRED_VAR_ARGS )
 304                 {   // no VarArgs or Fix plus VarArgs, but not VarArgs only
 305                     sal_uInt16 nFix;
 306                     if (nArgs >= PAIRED_VAR_ARGS)
 307                         nFix = nArgs - PAIRED_VAR_ARGS + 2;
 308                     else if (nArgs >= VAR_ARGS)
 309                         nFix = nArgs - VAR_ARGS + 1;
 310                     else
 311                         nFix = nArgs;
 312                     for ( sal_uInt16 nArg = 1;
 313                             nArg < nFix && !pDesc->pDefArgFlags[nArg].bOptional; nArg++ )
 314                     {
 315                         aArgStr.append("; ");
 316                         OUString sTmp = pDesc->maDefArgNames[nArg];
 317                         sTmp = comphelper::string::strip(sTmp, ' ');
 318                         sTmp = sTmp.replaceAll(" ", "_");
 319                         aArgStr.append(sTmp);
 320                     }
 321                 }
 322             }
 323         }
 324         if (pHdl)
 325         {
 326             if (pHdl->GetEditString().isEmpty())
 327             {
 328                 aString = "=" + xFuncList->get_selected_text();
 329             }
 330             EditView *pEdView=pHdl->GetActiveView();
 331             if(pEdView!=nullptr) // @ needed because of crash during setting a name
 332             {
 333                 if(nArgs>0)
 334                 {
 335                     pHdl->InsertFunction(aString);
 336                     pEdView->InsertText(aArgStr.makeStringAndClear(),true);
 337                     ESelection  aESel=pEdView->GetSelection();
 338                     aESel.nEndPos = aESel.nStartPos + aFirstArgStr.getLength();
 339                     pEdView->SetSelection(aESel);
 340                     pHdl->DataChanged();
 341                 }
 342                 else
 343                 {
 344                     aString += "()";
 345                     pEdView->InsertText(aString);
 346                     pHdl->DataChanged();
 347                 }
 348             }
 349         }
 350         InitLRUList();
 351     }
 352     if ( pCurSh )
 353     {
 354         vcl::Window* pShellWnd = pCurSh->GetWindow();
 355
 356         if ( pShellWnd )
 357             pShellWnd->GrabFocus();
 358     }
 359
 360 }
 361
 362 /*************************************************************************
 363 #*  Handle:     SelHdl
 364 #*------------------------------------------------------------------------
 365 #*
 366 #*  Class:      ScFunctionWin
 367 #*
 368 #*  Function:   A change of the category will update the list of functions.
 369 #*
 370 #*  Input:      ---
 371 #*
 372 #*  Output:     ---
 373 #*
 374 #************************************************************************/
 375
 376 IMPL_LINK_NOARG(ScFunctionWin, SelComboHdl, weld::ComboBox&, void)
 377 {
 378     UpdateFunctionList();
 379     SetDescription();
 380 }
 381
 382 IMPL_LINK_NOARG(ScFunctionWin, SelTreeHdl, weld::TreeView&, void)
 383 {
 384     SetDescription();
 385 }
 386
 387 /*************************************************************************
 388 #*  Handle:     SelHdl
 389 #*------------------------------------------------------------------------
 390 #*
 391 #*  Class:      ScFunctionWin
 392 #*
 393 #*  Function:   A change of the category will update the list of functions.
 394 #*
 395 #*  Input:      ---
 396 #*
 397 #*  Output:     ---
 398 #*
 399 #************************************************************************/
 400
 401 IMPL_LINK_NOARG( ScFunctionWin, SetSelectionClickHdl, weld::Button&, void )
 402 {
 403     DoEnter();          // saves the input
 404 }
 405
 406 IMPL_LINK_NOARG( ScFunctionWin, SetRowActivatedHdl, weld::TreeView&, bool )
 407 {
 408     DoEnter();          // saves the input
 409     return true;
 410 }
 411
 412 void EnglishFunctionNameChange::setProperty(const css::uno::Any &rProperty)
 413 {
 414     ConfigurationListenerProperty::setProperty(rProperty);
 415     m_xFunctionWin->InitLRUList();
 416     m_xFunctionWin->UpdateFunctionList();
 417 }
 418
 419 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */