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 <sfx2/module.hxx>
  21 #include <sfx2/app.hxx>
  22 #include <sfx2/msgpool.hxx>
  23 #include <sfx2/tbxctrl.hxx>
  24 #include <sfx2/stbitem.hxx>
  25 #include <sfx2/childwin.hxx>
  26 #include <sfx2/docfac.hxx>
  27 #include <sfx2/objface.hxx>
  28 #include <sfx2/viewfrm.hxx>
  29 #include <sfx2/tabdlg.hxx>
  30 #include <sfx2/sfxsids.hrc>
  31 #include <svl/intitem.hxx>
  32 #include <tools/diagnose_ex.h>
  33 #include <unotools/resmgr.hxx>
  34 #include <sal/log.hxx>
  35
  36 #define ShellClass_SfxModule
  37 #include <sfxslots.hxx>
  38 #include <childwinimpl.hxx>
  39 #include <ctrlfactoryimpl.hxx>
  40
  41 class SfxModule_Impl
  42 {
  43 public:
  44
  45     std::unique_ptr<SfxSlotPool>              pSlotPool;
  46     std::unique_ptr<SfxTbxCtrlFactArr_Impl>   pTbxCtrlFac;
  47     std::unique_ptr<SfxStbCtrlFactArr_Impl>   pStbCtrlFac;
  48     std::unique_ptr<SfxChildWinFactArr_Impl>  pFactArr;
  49     OString                     maResName;
  50
  51                                 SfxModule_Impl();
  52                                 ~SfxModule_Impl();
  53 };
  54
  55 SfxModule_Impl::SfxModule_Impl()
  56 {
  57 }
  58
  59 SfxModule_Impl::~SfxModule_Impl()
  60 {
  61     pSlotPool.reset();
  62     pTbxCtrlFac.reset();
  63     pStbCtrlFac.reset();
  64     pFactArr.reset();
  65 }
  66
  67 SFX_IMPL_SUPERCLASS_INTERFACE(SfxModule, SfxShell)
  68
  69 SfxModule::SfxModule(const OString& rResName, std::initializer_list<SfxObjectFactory*> pFactoryList)
  70     : pImpl(nullptr)
  71 {
  72     Construct_Impl(rResName);
  73     for (auto pFactory : pFactoryList)
  74     {
  75         if (pFactory)
  76             pFactory->SetModule_Impl( this );
  77     }
  78 }
  79
  80 void SfxModule::Construct_Impl(const OString& rResName)
  81 {
  82     SfxApplication *pApp = SfxApplication::GetOrCreate();
  83     pImpl = new SfxModule_Impl;
  84     pImpl->pSlotPool.reset( new SfxSlotPool(&pApp->GetAppSlotPool_Impl()) );
  85     pImpl->maResName = rResName;
  86
  87     SetPool( &pApp->GetPool() );
  88 }
  89
  90 SfxModule::~SfxModule()
  91 {
  92     //TODO how to silence useuniqueptr
  93     if (true)
  94     {
  95         delete pImpl;
  96     }
  97 }
  98
  99 std::locale SfxModule::GetResLocale() const
 100 {
 101     return Translate::Create(pImpl->maResName.getStr());
 102 }
 103
 104 SfxSlotPool* SfxModule::GetSlotPool() const
 105 {
 106     return pImpl->pSlotPool.get();
 107 }
 108
 109
 110 void SfxModule::RegisterChildWindow(std::unique_ptr<SfxChildWinFactory> pFact)
 111 {
 112     DBG_ASSERT( pImpl, "No real Module!" );
 113
 114     if (!pImpl->pFactArr)
 115         pImpl->pFactArr.reset( new SfxChildWinFactArr_Impl );
 116
 117     for (size_t nFactory=0; nFactory<pImpl->pFactArr->size(); ++nFactory)
 118     {
 119         if (pFact->nId ==  (*pImpl->pFactArr)[nFactory].nId)
 120         {
 121             pImpl->pFactArr->erase( pImpl->pFactArr->begin() + nFactory );
 122             SAL_WARN("sfx.appl", "ChildWindow registered multiple times!");
 123             return;
 124         }
 125     }
 126
 127     pImpl->pFactArr->push_back( std::move(pFact) );
 128 }
 129
 130
 131 void SfxModule::RegisterToolBoxControl( const SfxTbxCtrlFactory& rFact )
 132 {
 133     if (!pImpl->pTbxCtrlFac)
 134         pImpl->pTbxCtrlFac.reset( new SfxTbxCtrlFactArr_Impl );
 135
 136 #ifdef DBG_UTIL
 137     for ( size_t n=0; n<pImpl->pTbxCtrlFac->size(); n++ )
 138     {
 139         SfxTbxCtrlFactory *pF = &(*pImpl->pTbxCtrlFac)[n];
 140         if ( pF->nTypeId == rFact.nTypeId &&
 141             (pF->nSlotId == rFact.nSlotId || pF->nSlotId == 0) )
 142         {
 143             SAL_INFO("sfx.appl", "TbxController-Registering is not clearly defined!");
 144         }
 145     }
 146 #endif
 147
 148     pImpl->pTbxCtrlFac->push_back( rFact );
 149 }
 150
 151
 152 void SfxModule::RegisterStatusBarControl( const SfxStbCtrlFactory& rFact )
 153 {
 154     if (!pImpl->pStbCtrlFac)
 155         pImpl->pStbCtrlFac.reset( new SfxStbCtrlFactArr_Impl );
 156
 157 #ifdef DBG_UTIL
 158     for ( size_t n=0; n<pImpl->pStbCtrlFac->size(); n++ )
 159     {
 160         SfxStbCtrlFactory *pF = &(*pImpl->pStbCtrlFac)[n];
 161         if ( pF->nTypeId == rFact.nTypeId &&
 162             (pF->nSlotId == rFact.nSlotId || pF->nSlotId == 0) )
 163         {
 164             SAL_INFO("sfx.appl", "TbxController-Registering is not clearly defined!");
 165         }
 166     }
 167 #endif
 168
 169     pImpl->pStbCtrlFac->push_back( rFact );
 170 }
 171
 172
 173 SfxTbxCtrlFactArr_Impl*  SfxModule::GetTbxCtrlFactories_Impl() const
 174 {
 175     return pImpl->pTbxCtrlFac.get();
 176 }
 177
 178
 179 SfxStbCtrlFactArr_Impl*  SfxModule::GetStbCtrlFactories_Impl() const
 180 {
 181     return pImpl->pStbCtrlFac.get();
 182 }
 183
 184 SfxChildWinFactArr_Impl* SfxModule::GetChildWinFactories_Impl() const
 185 {
 186     return pImpl->pFactArr.get();
 187 }
 188
 189 std::unique_ptr<SfxTabPage> SfxModule::CreateTabPage(sal_uInt16, weld::Container*, weld::DialogController*, const SfxItemSet&)
 190 {
 191     return nullptr;
 192 }
 193
 194 void SfxModule::Invalidate( sal_uInt16 nId )
 195 {
 196     for( SfxViewFrame* pFrame = SfxViewFrame::GetFirst(); pFrame; pFrame = SfxViewFrame::GetNext( *pFrame ) )
 197         if ( pFrame->GetObjectShell()->GetModule() == this )
 198             Invalidate_Impl( pFrame->GetBindings(), nId );
 199 }
 200
 201 SfxModule* SfxModule::GetActiveModule( SfxViewFrame* pFrame )
 202 {
 203     if ( !pFrame )
 204         pFrame = SfxViewFrame::Current();
 205     SfxObjectShell* pSh = nullptr;
 206     if( pFrame )
 207         pSh = pFrame->GetObjectShell();
 208     return pSh ? pSh->GetModule() : nullptr;
 209 }
 210
 211 FieldUnit SfxModule::GetModuleFieldUnit( css::uno::Reference< css::frame::XFrame > const & i_frame )
 212 {
 213     ENSURE_OR_RETURN( i_frame.is(), "SfxModule::GetModuleFieldUnit: invalid frame!", FieldUnit::MM_100TH );
 214
 215     // find SfxViewFrame for the given XFrame
 216     SfxViewFrame* pViewFrame = SfxViewFrame::GetFirst();
 217     while ( pViewFrame != nullptr )
 218     {
 219         if ( pViewFrame->GetFrame().GetFrameInterface() == i_frame )
 220             break;
 221         pViewFrame = SfxViewFrame::GetNext( *pViewFrame );
 222     }
 223     ENSURE_OR_RETURN(
 224         pViewFrame != nullptr,
 225         "SfxModule::GetModuleFieldUnit: unable to find an SfxViewFrame for the given XFrame",
 226         FieldUnit::MM_100TH);
 227
 228     // find the module
 229     SfxModule const * pModule = GetActiveModule( pViewFrame );
 230     ENSURE_OR_RETURN(pModule != nullptr,
 231                      "SfxModule::GetModuleFieldUnit: no SfxModule for the given frame!",
 232                      FieldUnit::MM_100TH);
 233     return pModule->GetFieldUnit();
 234 }
 235
 236 FieldUnit SfxModule::GetCurrentFieldUnit()
 237 {
 238     FieldUnit eUnit = FieldUnit::INCH;
 239     SfxModule* pModule = GetActiveModule();
 240     if ( pModule )
 241     {
 242         const SfxPoolItem* pItem = pModule->GetItem( SID_ATTR_METRIC );
 243         if ( pItem )
 244             eUnit = static_cast<FieldUnit>(static_cast<const SfxUInt16Item*>(pItem)->GetValue());
 245     }
 246     else
 247         SAL_WARN( "sfx.appl", "GetModuleFieldUnit(): no module found" );
 248     return eUnit;
 249 }
 250
 251 FieldUnit SfxModule::GetFieldUnit() const
 252 {
 253     FieldUnit eUnit = FieldUnit::INCH;
 254     const SfxPoolItem* pItem = GetItem( SID_ATTR_METRIC );
 255     if ( pItem )
 256         eUnit = static_cast<FieldUnit>(static_cast<const SfxUInt16Item*>(pItem)->GetValue());
 257     return eUnit;
 258 }
 259
 260 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */