formula/source/ui/dlg/funcpage.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: funcpage.cxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_formula.hxx"
  33
  34
  35
  36 //----------------------------------------------------------------------------
  37
  38 #include <sfx2/dispatch.hxx>
  39 #include <sfx2/docfile.hxx>
  40 #include <svtools/zforlist.hxx>
  41 #include <svtools/stritem.hxx>
  42 #include "formula/IFunctionDescription.hxx"
  43
  44 #include "funcpage.hxx"
  45 #include "formdlgs.hrc"
  46 #include "ForResId.hrc"
  47 #include "ModuleHelper.hxx"
  48 //============================================================================
  49 namespace formula
  50 {
  51
  52 FormulaListBox::FormulaListBox( Window* pParent, WinBits nWinStyle):
  53     ListBox(pParent,nWinStyle)
  54 {}
  55
  56 FormulaListBox::FormulaListBox( Window* pParent, const ResId& rResId ):
  57     ListBox(pParent,rResId)
  58 {}
  59
  60 void FormulaListBox::KeyInput( const KeyEvent& rKEvt )
  61 {
  62     KeyEvent aKEvt=rKEvt;
  63     //ListBox::KeyInput(rKEvt);
  64
  65     if(aKEvt.GetCharCode()==' ')
  66         DoubleClick();
  67 }
  68
  69 long FormulaListBox::PreNotify( NotifyEvent& rNEvt )
  70 {
  71     NotifyEvent aNotifyEvt=rNEvt;
  72
  73     long nResult=ListBox::PreNotify(rNEvt);
  74
  75     USHORT nSwitch=aNotifyEvt.GetType();
  76     if(nSwitch==EVENT_KEYINPUT)
  77     {
  78         KeyInput(*aNotifyEvt.GetKeyEvent());
  79     }
  80     return nResult;
  81 }
  82
  83
  84
  85 //============================================================================
  86
  87 inline USHORT Lb2Cat( USHORT nLbPos )
  88 {
  89     // Kategorie 0 == LRU, sonst Categories == LbPos-1
  90     if ( nLbPos > 0 )
  91         nLbPos -= 1;
  92
  93     return nLbPos;
  94 }
  95
  96 //============================================================================
  97
  98 FuncPage::FuncPage(Window* pParent,const IFunctionManager* _pFunctionManager):
  99     TabPage(pParent,ModuleRes(RID_FORMULATAB_FUNCTION)),
 100     //
 101     aFtCategory         ( this, ModuleRes( FT_CATEGORY ) ),
 102     aLbCategory         ( this, ModuleRes( LB_CATEGORY ) ),
 103     aFtFunction         ( this, ModuleRes( FT_FUNCTION ) ),
 104     aLbFunction         ( this, ModuleRes( LB_FUNCTION ) ),
 105     m_pFunctionManager(_pFunctionManager)
 106 {
 107     FreeResource();
 108     m_aSmartHelpId = aLbFunction.GetSmartHelpId();
 109     aLbFunction.SetSmartUniqueId(m_aSmartHelpId);
 110
 111     InitLRUList();
 112
 113     const sal_uInt32 nCategoryCount = m_pFunctionManager->getCount();
 114     for(sal_uInt32 j= 0; j < nCategoryCount; ++j)
 115     {
 116         const IFunctionCategory* pCategory = m_pFunctionManager->getCategory(j);
 117         aLbCategory.SetEntryData(aLbCategory.InsertEntry(pCategory->getName()),(void*)pCategory);
 118     }
 119
 120     aLbCategory.SelectEntryPos(1);
 121     UpdateFunctionList();
 122     aLbCategory.SetSelectHdl( LINK( this, FuncPage, SelHdl ) );
 123     aLbFunction.SetSelectHdl( LINK( this, FuncPage, SelHdl ) );
 124     aLbFunction.SetDoubleClickHdl( LINK( this, FuncPage, DblClkHdl ) );
 125 }
 126 // -----------------------------------------------------------------------------
 127 void FuncPage::impl_addFunctions(const IFunctionCategory* _pCategory)
 128 {
 129     const sal_uInt32 nCount = _pCategory->getCount();
 130     for(sal_uInt32 i = 0 ; i < nCount; ++i)
 131     {
 132         TFunctionDesc pDesc(_pCategory->getFunction(i));
 133         aLbFunction.SetEntryData(
 134             aLbFunction.InsertEntry(pDesc->getFunctionName() ),(void*)pDesc );
 135     } // for(sal_uInt32 i = 0 ; i < nCount; ++i)
 136 }
 137
 138 void FuncPage::UpdateFunctionList()
 139 {
 140     USHORT      nSelPos   = aLbCategory.GetSelectEntryPos();
 141     const IFunctionCategory* pCategory = static_cast<const IFunctionCategory*>(aLbCategory.GetEntryData(nSelPos));
 142     USHORT      nCategory = ( LISTBOX_ENTRY_NOTFOUND != nSelPos )
 143                             ? Lb2Cat( nSelPos ) : 0;
 144
 145     (void)nCategory;
 146
 147     aLbFunction.Clear();
 148     aLbFunction.SetUpdateMode( FALSE );
 149     //------------------------------------------------------
 150
 151     if ( nSelPos > 0 )
 152     {
 153         if ( pCategory == NULL )
 154         {
 155             const sal_uInt32 nCount = m_pFunctionManager->getCount();
 156             for(sal_uInt32 i = 0 ; i < nCount; ++i)
 157             {
 158                 impl_addFunctions(m_pFunctionManager->getCategory(i));
 159             }
 160         }
 161         else
 162         {
 163             impl_addFunctions(pCategory);
 164         }
 165     }
 166     else // LRU-Liste
 167     {
 168         ::std::vector< TFunctionDesc >::iterator aIter = aLRUList.begin();
 169         ::std::vector< TFunctionDesc >::iterator aEnd = aLRUList.end();
 170
 171         for ( ; aIter != aEnd; ++aIter )
 172         {
 173             const IFunctionDescription* pDesc = *aIter;
 174             if (pDesc)  // may be null if a function is no longer available
 175             {
 176                 aLbFunction.SetEntryData(
 177                     aLbFunction.InsertEntry( pDesc->getFunctionName() ), (void*)pDesc );
 178             }
 179         }
 180     }
 181
 182     //------------------------------------------------------
 183     aLbFunction.SetUpdateMode( TRUE );
 184     aLbFunction.SelectEntryPos(0);
 185
 186     if(IsVisible())     SelHdl(&aLbFunction);
 187 }
 188
 189 IMPL_LINK( FuncPage, SelHdl, ListBox*, pLb )
 190 {
 191     if(pLb==&aLbFunction)
 192     {
 193         const IFunctionDescription* pDesc = GetFuncDesc( GetFunction() );
 194         if ( pDesc )
 195         {
 196             const long nHelpId = pDesc->getHelpId();
 197             if ( nHelpId )
 198                 aLbFunction.SetSmartHelpId(SmartId(nHelpId));
 199         }
 200         aSelectionLink.Call(this);
 201     }
 202     else
 203     {
 204         aLbFunction.SetSmartHelpId(m_aSmartHelpId);
 205         UpdateFunctionList();
 206     }
 207     return 0;
 208 }
 209
 210 IMPL_LINK( FuncPage, DblClkHdl, ListBox*, EMPTYARG )
 211 {
 212     aDoubleClickLink.Call(this);
 213     return 0;
 214 }
 215
 216 void FuncPage::SetCategory(USHORT nCat)
 217 {
 218     aLbCategory.SelectEntryPos(nCat);
 219     UpdateFunctionList();
 220 }
 221 USHORT FuncPage::GetFuncPos(const IFunctionDescription* _pDesc)
 222 {
 223     return aLbFunction.GetEntryPos(_pDesc);
 224 }
 225 void FuncPage::SetFunction(USHORT nFunc)
 226 {
 227     aLbFunction.SelectEntryPos(nFunc);
 228 }
 229
 230 void FuncPage::SetFocus()
 231 {
 232     aLbFunction.GrabFocus();
 233 }
 234
 235 USHORT FuncPage::GetCategory()
 236 {
 237     return aLbCategory.GetSelectEntryPos();
 238 }
 239
 240 USHORT FuncPage::GetFunction()
 241 {
 242     return aLbFunction.GetSelectEntryPos();
 243 }
 244
 245 USHORT FuncPage::GetFunctionEntryCount()
 246 {
 247     return aLbFunction.GetSelectEntryCount();
 248 }
 249
 250 String FuncPage::GetSelFunctionName() const
 251 {
 252     return aLbFunction.GetSelectEntry();
 253 }
 254 const IFunctionDescription*     FuncPage::GetFuncDesc( USHORT nPos ) const
 255 {
 256     // nicht schoen, aber hoffentlich selten
 257     return (const IFunctionDescription*) aLbFunction.GetEntryData(nPos);
 258 }
 259
 260 void FuncPage::InitLRUList()
 261 {
 262     ::std::vector< const IFunctionDescription*> aRUFunctions;
 263     m_pFunctionManager->fillLastRecentlyUsedFunctions(aLRUList);
 264 }
 265
 266
 267 } // formula
 268