sfx2/source/appl/module.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: module.cxx,v $
  10  * $Revision: 1.20 $
  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_sfx2.hxx"
  33
  34 #ifndef GCC
  35 #endif
  36
  37 #include <stdio.h>
  38 #include <tools/rcid.h>
  39
  40 #include <cstdarg>
  41 #include <sfx2/module.hxx>
  42 #include <sfx2/app.hxx>
  43 #include "arrdecl.hxx"
  44 #include "sfxresid.hxx"
  45 #include <sfx2/msgpool.hxx>
  46 #include <sfx2/tbxctrl.hxx>
  47 #include "stbitem.hxx"
  48 #include <sfx2/mnuitem.hxx>
  49 #include <sfx2/childwin.hxx>
  50 #include <sfx2/mnumgr.hxx>
  51 #include <sfx2/docfac.hxx>
  52 #include <sfx2/objface.hxx>
  53 #include <sfx2/viewfrm.hxx>
  54
  55 #define SfxModule
  56 #include "sfxslots.hxx"
  57
  58 static SfxModuleArr_Impl* pModules=0;
  59
  60 class SfxModule_Impl
  61 {
  62 public:
  63
  64     SfxSlotPool*                                pSlotPool;
  65     SfxTbxCtrlFactArr_Impl*     pTbxCtrlFac;
  66     SfxStbCtrlFactArr_Impl*     pStbCtrlFac;
  67     SfxMenuCtrlFactArr_Impl*    pMenuCtrlFac;
  68     SfxChildWinFactArr_Impl*    pFactArr;
  69     ImageList*                  pImgListSmall;
  70     ImageList*                  pImgListBig;
  71     ImageList*                                  pImgListHiSmall;
  72     ImageList*                                  pImgListHiBig;
  73
  74                                 SfxModule_Impl();
  75                                 ~SfxModule_Impl();
  76     ImageList*                  GetImageList( ResMgr*, BOOL, BOOL bHiContrast = FALSE );
  77 };
  78
  79 SfxModule_Impl::SfxModule_Impl()
  80  : pSlotPool(0)
  81 {
  82 }
  83
  84 SfxModule_Impl::~SfxModule_Impl()
  85 {
  86     delete pSlotPool;
  87     delete pTbxCtrlFac;
  88     delete pStbCtrlFac;
  89     delete pMenuCtrlFac;
  90     delete pFactArr;
  91     delete pImgListSmall;
  92     delete pImgListBig;
  93     delete pImgListHiSmall;
  94     delete pImgListHiBig;
  95 }
  96
  97 ImageList* SfxModule_Impl::GetImageList( ResMgr* pResMgr, BOOL bBig, BOOL bHiContrast )
  98 {
  99     ImageList*& rpList = bBig ? ( bHiContrast ? pImgListHiBig: pImgListBig ) :
 100                                 ( bHiContrast ? pImgListHiSmall : pImgListSmall );
 101     if ( !rpList )
 102     {
 103         ResId aResId( bBig ? ( bHiContrast ? RID_DEFAULTIMAGELIST_LCH : RID_DEFAULTIMAGELIST_LC ) :
 104                              ( bHiContrast ? RID_DEFAULTIMAGELIST_SCH : RID_DEFAULTIMAGELIST_SC ), *pResMgr );
 105         aResId.SetRT( RSC_IMAGELIST );
 106
 107         DBG_ASSERT( pResMgr->IsAvailable(aResId), "No default ImageList!" );
 108
 109         if ( pResMgr->IsAvailable(aResId) )
 110             rpList = new ImageList( aResId );
 111         else
 112             rpList = new ImageList();
 113     }
 114
 115     return rpList; }
 116
 117 TYPEINIT1(SfxModule, SfxShell);
 118
 119 //=========================================================================
 120
 121 SFX_IMPL_INTERFACE(SfxModule,SfxShell,SfxResId(0))
 122 {
 123 }
 124
 125 //====================================================================
 126
 127 ResMgr* SfxModule::GetResMgr()
 128 {
 129     return pResMgr;
 130 }
 131
 132 //====================================================================
 133 /*
 134 SfxModule::SfxModule( ResMgr* pMgrP, BOOL bDummyP,
 135                       SfxObjectFactory* pFactoryP )
 136     : pResMgr( pMgrP ), bDummy( bDummyP ), pImpl(0L)
 137 {
 138     Construct_Impl();
 139     if ( pFactoryP )
 140         pFactoryP->SetModule_Impl( this );
 141 }
 142 */
 143 SfxModule::SfxModule( ResMgr* pMgrP, BOOL bDummyP,
 144                       SfxObjectFactory* pFactoryP, ... )
 145     : pResMgr( pMgrP ), bDummy( bDummyP ), pImpl(0L)
 146 {
 147     Construct_Impl();
 148     va_list pVarArgs;
 149     va_start( pVarArgs, pFactoryP );
 150     for ( SfxObjectFactory *pArg = pFactoryP; pArg;
 151          pArg = va_arg( pVarArgs, SfxObjectFactory* ) )
 152         pArg->SetModule_Impl( this );
 153     va_end(pVarArgs);
 154 }
 155
 156 void SfxModule::Construct_Impl()
 157 {
 158     if( !bDummy )
 159     {
 160         SfxApplication *pApp = SFX_APP();
 161         SfxModuleArr_Impl& rArr = GetModules_Impl();
 162         SfxModule* pPtr = (SfxModule*)this;
 163         rArr.C40_INSERT( SfxModule, pPtr, rArr.Count() );
 164         pImpl = new SfxModule_Impl;
 165         pImpl->pSlotPool = new SfxSlotPool( &pApp->GetAppSlotPool_Impl(), pResMgr );
 166
 167         pImpl->pTbxCtrlFac=0;
 168         pImpl->pStbCtrlFac=0;
 169         pImpl->pMenuCtrlFac=0;
 170         pImpl->pFactArr=0;
 171         pImpl->pImgListSmall=0;
 172         pImpl->pImgListBig=0;
 173         pImpl->pImgListHiSmall=0;
 174         pImpl->pImgListHiBig=0;
 175
 176         SetPool( &pApp->GetPool() );
 177     }
 178 }
 179
 180 //====================================================================
 181
 182 SfxModule::~SfxModule()
 183 {
 184     if( !bDummy )
 185     {
 186         if ( SFX_APP()->Get_Impl() )
 187         {
 188             // Das Modul wird noch vor dem DeInitialize zerst"ort, also auis dem Array entfernen
 189             SfxModuleArr_Impl& rArr = GetModules_Impl();
 190             for( USHORT nPos = rArr.Count(); nPos--; )
 191             {
 192                 if( rArr[ nPos ] == this )
 193                 {
 194                     rArr.Remove( 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, "Kein echtes Modul!" );
 218
 219     if (!pImpl->pFactArr)
 220         pImpl->pFactArr = new SfxChildWinFactArr_Impl;
 221
 222 //#ifdef DBG_UTIL
 223     for (USHORT nFactory=0; nFactory<pImpl->pFactArr->Count(); ++nFactory)
 224     {
 225         if (pFact->nId ==  (*pImpl->pFactArr)[nFactory]->nId)
 226         {
 227             pImpl->pFactArr->Remove( nFactory );
 228             DBG_ERROR("ChildWindow mehrfach registriert!");
 229             return;
 230         }
 231     }
 232 //#endif
 233
 234     pImpl->pFactArr->C40_INSERT(
 235         SfxChildWinFactory, pFact, pImpl->pFactArr->Count() );
 236 }
 237
 238 //-------------------------------------------------------------------------
 239
 240 void SfxModule::RegisterChildWindowContext( USHORT nId,
 241         SfxChildWinContextFactory *pFact)
 242 {
 243     DBG_ASSERT( pImpl, "Kein echtes Modul!" );
 244
 245     USHORT nCount = pImpl->pFactArr->Count();
 246     for (USHORT nFactory=0; nFactory<nCount; ++nFactory)
 247     {
 248         SfxChildWinFactory *pF = (*pImpl->pFactArr)[nFactory];
 249         if ( nId == pF->nId )
 250         {
 251             if ( !pF->pArr )
 252                 pF->pArr = new SfxChildWinContextArr_Impl;
 253             pF->pArr->C40_INSERT( SfxChildWinContextFactory, pFact, pF->pArr->Count() );
 254             return;
 255         }
 256     }
 257
 258     DBG_ERROR( "Kein ChildWindow fuer diesen Context!" );
 259 }
 260
 261 //-------------------------------------------------------------------------
 262
 263 void SfxModule::RegisterToolBoxControl( SfxTbxCtrlFactory *pFact )
 264 {
 265     if (!pImpl->pTbxCtrlFac)
 266         pImpl->pTbxCtrlFac = new SfxTbxCtrlFactArr_Impl;
 267
 268 #ifdef DBG_UTIL
 269     for ( USHORT n=0; n<pImpl->pTbxCtrlFac->Count(); n++ )
 270     {
 271         SfxTbxCtrlFactory *pF = (*pImpl->pTbxCtrlFac)[n];
 272         if ( pF->nTypeId && pF->nTypeId == pFact->nTypeId &&
 273             (pF->nSlotId == pFact->nSlotId || pF->nSlotId == 0) )
 274         {
 275             DBG_WARNING("TbxController-Registrierung ist nicht eindeutig!");
 276         }
 277     }
 278 #endif
 279
 280     pImpl->pTbxCtrlFac->C40_INSERT( SfxTbxCtrlFactory, pFact, pImpl->pTbxCtrlFac->Count() );
 281 }
 282
 283 //-------------------------------------------------------------------------
 284
 285 void SfxModule::RegisterStatusBarControl( SfxStbCtrlFactory *pFact )
 286 {
 287     if (!pImpl->pStbCtrlFac)
 288         pImpl->pStbCtrlFac = new SfxStbCtrlFactArr_Impl;
 289
 290 #ifdef DBG_UTIL
 291     for ( USHORT n=0; n<pImpl->pStbCtrlFac->Count(); n++ )
 292     {
 293         SfxStbCtrlFactory *pF = (*pImpl->pStbCtrlFac)[n];
 294         if ( pF->nTypeId && pF->nTypeId == pFact->nTypeId &&
 295             (pF->nSlotId == pFact->nSlotId || pF->nSlotId == 0) )
 296         {
 297             DBG_WARNING("StbController-Registrierung ist nicht eindeutig!");
 298         }
 299     }
 300 #endif
 301
 302     pImpl->pStbCtrlFac->C40_INSERT( SfxStbCtrlFactory, pFact, pImpl->pStbCtrlFac->Count() );
 303 }
 304
 305 //-------------------------------------------------------------------------
 306
 307 void SfxModule::RegisterMenuControl( SfxMenuCtrlFactory *pFact )
 308 {
 309     if (!pImpl->pMenuCtrlFac)
 310         pImpl->pMenuCtrlFac = new SfxMenuCtrlFactArr_Impl;
 311
 312 #ifdef DBG_UTIL
 313     for ( USHORT n=0; n<pImpl->pMenuCtrlFac->Count(); n++ )
 314     {
 315         SfxMenuCtrlFactory *pF = (*pImpl->pMenuCtrlFac)[n];
 316         if ( pF->nTypeId && pF->nTypeId == pFact->nTypeId &&
 317             (pF->nSlotId == pFact->nSlotId || pF->nSlotId == 0) )
 318         {
 319             DBG_WARNING("MenuController-Registrierung ist nicht eindeutig!");
 320         }
 321     }
 322 #endif
 323
 324     pImpl->pMenuCtrlFac->C40_INSERT( SfxMenuCtrlFactory, pFact, pImpl->pMenuCtrlFac->Count() );
 325 }
 326
 327 //-------------------------------------------------------------------------
 328
 329 SfxTbxCtrlFactArr_Impl*  SfxModule::GetTbxCtrlFactories_Impl() const
 330 {
 331     return pImpl->pTbxCtrlFac;
 332 }
 333
 334 //-------------------------------------------------------------------------
 335
 336 SfxStbCtrlFactArr_Impl*  SfxModule::GetStbCtrlFactories_Impl() const
 337 {
 338     return pImpl->pStbCtrlFac;
 339 }
 340
 341 //-------------------------------------------------------------------------
 342
 343 SfxMenuCtrlFactArr_Impl* SfxModule::GetMenuCtrlFactories_Impl() const
 344 {
 345     return pImpl->pMenuCtrlFac;
 346 }
 347
 348 //-------------------------------------------------------------------------
 349
 350 SfxChildWinFactArr_Impl* SfxModule::GetChildWinFactories_Impl() const
 351 {
 352     return pImpl->pFactArr;
 353 }
 354
 355 ImageList* SfxModule::GetImageList_Impl( BOOL bBig )
 356 {
 357     return pImpl->GetImageList( pResMgr, bBig, FALSE );
 358 }
 359
 360 ImageList* SfxModule::GetImageList_Impl( BOOL bBig, BOOL bHiContrast )
 361 {
 362     return pImpl->GetImageList( pResMgr, bBig, bHiContrast );
 363 }
 364
 365 SfxTabPage*     SfxModule::CreateTabPage( USHORT, Window*, const SfxItemSet& )
 366 {
 367     return NULL;
 368 }
 369
 370 SfxModuleArr_Impl& SfxModule::GetModules_Impl()
 371 {
 372     if( !pModules )
 373         pModules = new SfxModuleArr_Impl;
 374     return *pModules;
 375 };
 376
 377 void SfxModule::DestroyModules_Impl()
 378 {
 379     if ( pModules )
 380     {
 381         SfxModuleArr_Impl& rModules = *pModules;
 382         for( USHORT nPos = rModules.Count(); nPos--; )
 383     {
 384         SfxModule* pMod = rModules.GetObject(nPos);
 385         delete pMod;
 386     }
 387     }
 388 }
 389
 390 void SfxModule::Invalidate( USHORT nId )
 391 {
 392     for( SfxViewFrame* pFrame = SfxViewFrame::GetFirst(); pFrame; pFrame = SfxViewFrame::GetNext( *pFrame ) )
 393         if ( pFrame->GetObjectShell()->GetModule() == this )
 394             Invalidate_Impl( pFrame->GetBindings(), nId );
 395 }
 396
 397 BOOL SfxModule::IsActive() const
 398 {
 399     SfxViewFrame* pFrame = SfxViewFrame::Current();
 400     if ( pFrame && pFrame->GetObjectShell()->GetFactory().GetModule() == this )
 401         return TRUE;
 402     return FALSE;
 403 }
 404
 405 SfxModule* SfxModule::GetActiveModule( SfxViewFrame* pFrame )
 406 {
 407     if ( !pFrame )
 408         pFrame = SfxViewFrame::Current();
 409     SfxObjectShell* pSh = 0;
 410     if( pFrame )
 411         pSh = pFrame->GetObjectShell();
 412     return pSh ? pSh->GetModule() : 0;
 413 }