sfx2/source/appl/module.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 <tools/rcid.h>
  21
  22 #include <cstdarg>
  23 #include <sfx2/module.hxx>
  24 #include <sfx2/app.hxx>
  25 #include <sfx2/sfxresid.hxx>
  26 #include <sfx2/msgpool.hxx>
  27 #include <sfx2/tbxctrl.hxx>
  28 #include <sfx2/stbitem.hxx>
  29 #include <sfx2/mnuitem.hxx>
  30 #include <sfx2/childwin.hxx>
  31 #include <sfx2/mnumgr.hxx>
  32 #include <sfx2/docfac.hxx>
  33 #include <sfx2/objface.hxx>
  34 #include <sfx2/viewfrm.hxx>
  35 #include <sfx2/tabdlg.hxx>
  36 #include <svl/intitem.hxx>
  37 #include <sfx2/taskpane.hxx>
  38 #include <tools/diagnose_ex.h>
  39 #include <rtl/strbuf.hxx>
  40 #include <sal/log.hxx>
  41
  42 #define SfxModule
  43 #include "sfxslots.hxx"
  44 #include "childwinimpl.hxx"
  45 #include <ctrlfactoryimpl.hxx>
  46
  47 class SfxModuleArr_Impl
  48 {
  49     typedef ::std::vector<SfxModule*> DataType;
  50     DataType maData;
  51 public:
  52
  53     typedef DataType::iterator iterator;
  54
  55     iterator begin()
  56     {
  57         return maData.begin();
  58     }
  59
  60     void erase( iterator it )
  61     {
  62         maData.erase(it);
  63     }
  64
  65     SfxModule* operator[] ( size_t i )
  66     {
  67         return maData[i];
  68     }
  69
  70     void push_back( SfxModule* p )
  71     {
  72         maData.push_back(p);
  73     }
  74
  75     size_t size() const
  76     {
  77         return maData.size();
  78     }
  79 };
  80
  81 static SfxModuleArr_Impl* pModules=0;
  82
  83 class SfxModule_Impl
  84 {
  85 public:
  86
  87     SfxSlotPool*                pSlotPool;
  88     SfxTbxCtrlFactArr_Impl*     pTbxCtrlFac;
  89     SfxStbCtrlFactArr_Impl*     pStbCtrlFac;
  90     SfxMenuCtrlFactArr_Impl*    pMenuCtrlFac;
  91     SfxChildWinFactArr_Impl*    pFactArr;
  92     ImageList*                  pImgListSmall;
  93     ImageList*                  pImgListBig;
  94
  95                                 SfxModule_Impl();
  96                                 ~SfxModule_Impl();
  97     ImageList*                  GetImageList( ResMgr* pResMgr, bool bBig );
  98 };
  99
 100 SfxModule_Impl::SfxModule_Impl()
 101  : pSlotPool(0), pTbxCtrlFac(0), pStbCtrlFac(0), pMenuCtrlFac(0), pFactArr(0), pImgListSmall(0), pImgListBig(0)
 102 {
 103 }
 104
 105 SfxModule_Impl::~SfxModule_Impl()
 106 {
 107     delete pSlotPool;
 108     delete pTbxCtrlFac;
 109     delete pStbCtrlFac;
 110     delete pMenuCtrlFac;
 111     delete pFactArr;
 112     delete pImgListSmall;
 113     delete pImgListBig;
 114 }
 115
 116 ImageList* SfxModule_Impl::GetImageList( ResMgr* pResMgr, bool bBig )
 117 {
 118     ImageList*& rpList = bBig ? pImgListBig : pImgListSmall;
 119     if ( !rpList )
 120     {
 121         ResId aResId( bBig ? ( RID_DEFAULTIMAGELIST_LC ) : ( RID_DEFAULTIMAGELIST_SC ), *pResMgr );
 122
 123         aResId.SetRT( RSC_IMAGELIST );
 124
 125         DBG_ASSERT( pResMgr->IsAvailable(aResId), "No default ImageList!" );
 126
 127         if ( pResMgr->IsAvailable(aResId) )
 128             rpList = new ImageList( aResId );
 129         else
 130             rpList = new ImageList();
 131     }
 132
 133     return rpList; }
 134
 135 TYPEINIT1(SfxModule, SfxShell);
 136
 137 SFX_IMPL_SUPERCLASS_INTERFACE(SfxModule, SfxShell)
 138
 139 ResMgr* SfxModule::GetResMgr()
 140 {
 141     return pResMgr;
 142 }
 143
 144 SfxModule::SfxModule( ResMgr* pMgrP, bool bDummyP,
 145                       SfxObjectFactory* pFactoryP, ... )
 146     : pResMgr( pMgrP ), bDummy( bDummyP ), pImpl(0L)
 147 {
 148     Construct_Impl();
 149     va_list pVarArgs;
 150     va_start( pVarArgs, pFactoryP );
 151     for ( SfxObjectFactory *pArg = pFactoryP; pArg;
 152          pArg = va_arg( pVarArgs, SfxObjectFactory* ) )
 153         pArg->SetModule_Impl( this );
 154     va_end(pVarArgs);
 155 }
 156
 157 void SfxModule::Construct_Impl()
 158 {
 159     if( !bDummy )
 160     {
 161         SfxApplication *pApp = SfxGetpApp();
 162         SfxModuleArr_Impl& rArr = GetModules_Impl();
 163         SfxModule* pPtr = this;
 164         rArr.push_back( pPtr );
 165         pImpl = new SfxModule_Impl;
 166         pImpl->pSlotPool = new SfxSlotPool(&pApp->GetAppSlotPool_Impl());
 167
 168         pImpl->pTbxCtrlFac=0;
 169         pImpl->pStbCtrlFac=0;
 170         pImpl->pMenuCtrlFac=0;
 171         pImpl->pFactArr=0;
 172         pImpl->pImgListSmall=0;
 173         pImpl->pImgListBig=0;
 174
 175         SetPool( &pApp->GetPool() );
 176     }
 177 }
 178
 179
 180
 181 SfxModule::~SfxModule()
 182 {
 183     if( !bDummy )
 184     {
 185         if ( SfxGetpApp()->Get_Impl() )
 186         {
 187             // The module will be destroyed before the Deinitialize,
 188             // so remove from the array
 189             SfxModuleArr_Impl& rArr = GetModules_Impl();
 190             for( sal_uInt16 nPos = rArr.size(); nPos--; )
 191             {
 192                 if( rArr[ nPos ] == this )
 193                 {
 194                     rArr.erase( rArr.begin() + nPos );
 195                     break;
 196                 }
 197             }
 198
 199             delete pImpl;
 200         }
 201
 202         delete pResMgr;
 203     }
 204 }
 205
 206
 207
 208 SfxSlotPool* SfxModule::GetSlotPool() const
 209 {
 210     return pImpl->pSlotPool;
 211 }
 212
 213
 214
 215 void SfxModule::RegisterChildWindow(SfxChildWinFactory *pFact)
 216 {
 217     DBG_ASSERT( pImpl, "No real Module!" );
 218
 219     if (!pImpl->pFactArr)
 220         pImpl->pFactArr = new SfxChildWinFactArr_Impl;
 221
 222     for (sal_uInt16 nFactory=0; nFactory<pImpl->pFactArr->size(); ++nFactory)
 223     {
 224         if (pFact->nId ==  (*pImpl->pFactArr)[nFactory].nId)
 225         {
 226             pImpl->pFactArr->erase( pImpl->pFactArr->begin() + nFactory );
 227             SAL_WARN("sfx.appl", "ChildWindow registered multiple times!");
 228             return;
 229         }
 230     }
 231
 232     pImpl->pFactArr->push_back( pFact );
 233 }
 234
 235
 236
 237 void SfxModule::RegisterToolBoxControl( SfxTbxCtrlFactory *pFact )
 238 {
 239     if (!pImpl->pTbxCtrlFac)
 240         pImpl->pTbxCtrlFac = new SfxTbxCtrlFactArr_Impl;
 241
 242 #ifdef DBG_UTIL
 243     for ( sal_uInt16 n=0; n<pImpl->pTbxCtrlFac->size(); n++ )
 244     {
 245         SfxTbxCtrlFactory *pF = &(*pImpl->pTbxCtrlFac)[n];
 246         if ( pF->nTypeId && pF->nTypeId == pFact->nTypeId &&
 247             (pF->nSlotId == pFact->nSlotId || pF->nSlotId == 0) )
 248         {
 249             DBG_WARNING("TbxController-Registering is not clearly defined!");
 250         }
 251     }
 252 #endif
 253
 254     pImpl->pTbxCtrlFac->push_back( pFact );
 255 }
 256
 257
 258
 259 void SfxModule::RegisterStatusBarControl( SfxStbCtrlFactory *pFact )
 260 {
 261     if (!pImpl->pStbCtrlFac)
 262         pImpl->pStbCtrlFac = new SfxStbCtrlFactArr_Impl;
 263
 264 #ifdef DBG_UTIL
 265     for ( sal_uInt16 n=0; n<pImpl->pStbCtrlFac->size(); n++ )
 266     {
 267         SfxStbCtrlFactory *pF = &(*pImpl->pStbCtrlFac)[n];
 268         if ( pF->nTypeId && pF->nTypeId == pFact->nTypeId &&
 269             (pF->nSlotId == pFact->nSlotId || pF->nSlotId == 0) )
 270         {
 271             DBG_WARNING("TbxController-Registering is not clearly defined!");
 272         }
 273     }
 274 #endif
 275
 276     pImpl->pStbCtrlFac->push_back( pFact );
 277 }
 278
 279
 280
 281 void SfxModule::RegisterMenuControl( SfxMenuCtrlFactory *pFact )
 282 {
 283     if (!pImpl->pMenuCtrlFac)
 284         pImpl->pMenuCtrlFac = new SfxMenuCtrlFactArr_Impl;
 285
 286 #ifdef DBG_UTIL
 287     for ( sal_uInt16 n=0; n<pImpl->pMenuCtrlFac->size(); n++ )
 288     {
 289         SfxMenuCtrlFactory *pF = &(*pImpl->pMenuCtrlFac)[n];
 290         if ( pF->nTypeId && pF->nTypeId == pFact->nTypeId &&
 291             (pF->nSlotId == pFact->nSlotId || pF->nSlotId == 0) )
 292         {
 293             DBG_WARNING("MenuController-Registering is not clearly defined!");
 294         }
 295     }
 296 #endif
 297
 298     pImpl->pMenuCtrlFac->push_back( pFact );
 299 }
 300
 301
 302
 303 SfxTbxCtrlFactArr_Impl*  SfxModule::GetTbxCtrlFactories_Impl() const
 304 {
 305     return pImpl->pTbxCtrlFac;
 306 }
 307
 308
 309
 310 SfxStbCtrlFactArr_Impl*  SfxModule::GetStbCtrlFactories_Impl() const
 311 {
 312     return pImpl->pStbCtrlFac;
 313 }
 314
 315
 316
 317 SfxMenuCtrlFactArr_Impl* SfxModule::GetMenuCtrlFactories_Impl() const
 318 {
 319     return pImpl->pMenuCtrlFac;
 320 }
 321
 322
 323
 324 SfxChildWinFactArr_Impl* SfxModule::GetChildWinFactories_Impl() const
 325 {
 326     return pImpl->pFactArr;
 327 }
 328
 329 ImageList* SfxModule::GetImageList_Impl( bool bBig )
 330 {
 331     return pImpl->GetImageList( pResMgr, bBig );
 332 }
 333
 334 VclPtr<SfxTabPage> SfxModule::CreateTabPage( sal_uInt16, vcl::Window*, const SfxItemSet& )
 335 {
 336     return VclPtr<SfxTabPage>();
 337 }
 338
 339 SfxModuleArr_Impl& SfxModule::GetModules_Impl()
 340 {
 341     if( !pModules )
 342         pModules = new SfxModuleArr_Impl;
 343     return *pModules;
 344 };
 345
 346 void SfxModule::DestroyModules_Impl()
 347 {
 348     if ( pModules )
 349     {
 350         SfxModuleArr_Impl& rModules = *pModules;
 351         for( sal_uInt16 nPos = rModules.size(); nPos--; )
 352         {
 353             SfxModule* pMod = rModules[nPos];
 354             delete pMod;
 355         }
 356         delete pModules, pModules = 0;
 357     }
 358 }
 359
 360 void SfxModule::Invalidate( sal_uInt16 nId )
 361 {
 362     for( SfxViewFrame* pFrame = SfxViewFrame::GetFirst(); pFrame; pFrame = SfxViewFrame::GetNext( *pFrame ) )
 363         if ( pFrame->GetObjectShell()->GetModule() == this )
 364             Invalidate_Impl( pFrame->GetBindings(), nId );
 365 }
 366
 367 bool SfxModule::IsChildWindowAvailable( const sal_uInt16 i_nId, const SfxViewFrame* i_pViewFrame ) const
 368 {
 369     if ( i_nId != SID_TASKPANE )
 370         // by default, assume it is
 371         return true;
 372
 373     const SfxViewFrame* pViewFrame = i_pViewFrame ? i_pViewFrame : GetFrame();
 374     ENSURE_OR_RETURN( pViewFrame, "SfxModule::IsChildWindowAvailable: no frame to ask for the module identifier!", false );
 375     return ::sfx2::ModuleTaskPane::ModuleHasToolPanels( pViewFrame->GetFrame().GetFrameInterface() );
 376 }
 377
 378 SfxModule* SfxModule::GetActiveModule( SfxViewFrame* pFrame )
 379 {
 380     if ( !pFrame )
 381         pFrame = SfxViewFrame::Current();
 382     SfxObjectShell* pSh = 0;
 383     if( pFrame )
 384         pSh = pFrame->GetObjectShell();
 385     return pSh ? pSh->GetModule() : 0;
 386 }
 387
 388 FieldUnit SfxModule::GetModuleFieldUnit( ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame > const & i_frame )
 389 {
 390     ENSURE_OR_RETURN( i_frame.is(), "SfxModule::GetModuleFieldUnit: invalid frame!", FUNIT_100TH_MM );
 391
 392     // find SfxViewFrame for the given XFrame
 393     SfxViewFrame* pViewFrame = SfxViewFrame::GetFirst();
 394     while ( pViewFrame != NULL )
 395     {
 396         if ( pViewFrame->GetFrame().GetFrameInterface() == i_frame )
 397             break;
 398         pViewFrame = SfxViewFrame::GetNext( *pViewFrame );
 399     }
 400     ENSURE_OR_RETURN( pViewFrame != NULL, "SfxModule::GetModuleFieldUnit: unable to find an SfxViewFrame for the given XFrame", FUNIT_100TH_MM );
 401
 402     // find the module
 403     SfxModule const * pModule = GetActiveModule( pViewFrame );
 404     ENSURE_OR_RETURN( pModule != NULL, "SfxModule::GetModuleFieldUnit: no SfxModule for the given frame!", FUNIT_100TH_MM );
 405     return pModule->GetFieldUnit();
 406 }
 407
 408 FieldUnit SfxModule::GetCurrentFieldUnit()
 409 {
 410     FieldUnit eUnit = FUNIT_INCH;
 411     SfxModule* pModule = GetActiveModule();
 412     if ( pModule )
 413     {
 414         const SfxPoolItem* pItem = pModule->GetItem( SID_ATTR_METRIC );
 415         if ( pItem )
 416             eUnit = (FieldUnit) static_cast<const SfxUInt16Item*>(pItem)->GetValue();
 417     }
 418     else
 419         SAL_WARN( "sfx.appl", "GetModuleFieldUnit(): no module found" );
 420     return eUnit;
 421 }
 422
 423 FieldUnit SfxModule::GetFieldUnit() const
 424 {
 425     FieldUnit eUnit = FUNIT_INCH;
 426     const SfxPoolItem* pItem = GetItem( SID_ATTR_METRIC );
 427     if ( pItem )
 428         eUnit = (FieldUnit) static_cast<const SfxUInt16Item*>(pItem)->GetValue();
 429     return eUnit;
 430 }
 431
 432 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */