fbfe3c7305
2007/06/05 06:46:46 pb 1.14.58.2: RESYNC: (1.14-1.15); FILE MERGED 2007/06/04 11:22:21 cd 1.14.58.1: #i78020# Support merging to menu and toolbar for add-ons
473 lines
17 KiB
C++
473 lines
17 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: menubarwrapper.cxx,v $
|
|
*
|
|
* $Revision: 1.16 $
|
|
*
|
|
* last change: $Author: ihi $ $Date: 2007-07-10 15:12:46 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
************************************************************************/
|
|
|
|
// MARKER(update_precomp.py): autogen include statement, do not remove
|
|
#include "precompiled_framework.hxx"
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// my own includes
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
#ifndef __FRAMEWORK_UIELEMENT_MENUBARWRAPPER_HXX_
|
|
#include <uielement/menubarwrapper.hxx>
|
|
#endif
|
|
#ifndef __FRAMEWORK_THREADHELP_RESETABLEGUARD_HXX_
|
|
#include <threadhelp/resetableguard.hxx>
|
|
#endif
|
|
#ifndef __FRAMEWORK_HELPER_ACTIONTRIGGERHELPER_HXX_
|
|
#include <helper/actiontriggerhelper.hxx>
|
|
#endif
|
|
#ifndef __FRAMEWORK_UIELEMENT_CONSTITEMCONTAINER_HXX_
|
|
#include <uielement/constitemcontainer.hxx>
|
|
#endif
|
|
#ifndef __FRAMEWORK_UIELEMENT_ROOTITEMCONTAINER_HXX_
|
|
#include <uielement/rootitemcontainer.hxx>
|
|
#endif
|
|
#include <services.h>
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// interface includes
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
|
|
#include <com/sun/star/lang/XServiceInfo.hpp>
|
|
#endif
|
|
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
|
|
#include <com/sun/star/beans/XPropertySet.hpp>
|
|
#endif
|
|
#ifndef _COM_SUN_STAR_AWT_XSYSTEMDEPENDENTMENUPEER_HPP_
|
|
#include <com/sun/star/awt/XSystemDependentMenuPeer.hpp>
|
|
#endif
|
|
#ifndef _COM_SUN_STAR_AWT_XMENUBAR_HPP_
|
|
#include <com/sun/star/awt/XMenuBar.hpp>
|
|
#endif
|
|
#ifndef _COM_SUN_STAR_CONTAINER_XINDEXCONTAINER_HPP_
|
|
#include <com/sun/star/container/XIndexContainer.hpp>
|
|
#endif
|
|
#ifndef _COM_SUN_STAR_CONTAINER_XNAMEACCESS_HPP_
|
|
#include <com/sun/star/container/XNameAccess.hpp>
|
|
#endif
|
|
#ifndef _COM_SUN_STAR_UI_UIELEMENTTYPE_HPP_
|
|
#include <com/sun/star/ui/UIElementType.hpp>
|
|
#endif
|
|
#include <com/sun/star/frame/XModuleManager.hpp>
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// other includes
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
#ifndef _COMPHELPER_PROCESSFACTORY_HXX_
|
|
#include <comphelper/processfactory.hxx>
|
|
#endif
|
|
#include <tools/solar.h>
|
|
#include <vcl/svapp.hxx>
|
|
#include <rtl/logfile.hxx>
|
|
|
|
using namespace rtl;
|
|
using namespace com::sun::star;
|
|
using namespace com::sun::star::uno;
|
|
using namespace com::sun::star::beans;
|
|
using namespace com::sun::star::frame;
|
|
using namespace com::sun::star::lang;
|
|
using namespace com::sun::star::container;
|
|
using namespace com::sun::star::awt;
|
|
using namespace com::sun::star::util;
|
|
using namespace ::com::sun::star::ui;
|
|
|
|
namespace framework
|
|
{
|
|
|
|
//*****************************************************************************************************************
|
|
// XInterface, XTypeProvider
|
|
//*****************************************************************************************************************
|
|
DEFINE_XINTERFACE_11 ( MenuBarWrapper ,
|
|
UIConfigElementWrapperBase ,
|
|
DIRECT_INTERFACE( ::com::sun::star::lang::XTypeProvider ),
|
|
DIRECT_INTERFACE( ::com::sun::star::ui::XUIElement ),
|
|
DIRECT_INTERFACE( ::com::sun::star::ui::XUIElementSettings ),
|
|
DIRECT_INTERFACE( ::com::sun::star::beans::XMultiPropertySet ),
|
|
DIRECT_INTERFACE( ::com::sun::star::beans::XFastPropertySet ),
|
|
DIRECT_INTERFACE( ::com::sun::star::beans::XPropertySet ),
|
|
DIRECT_INTERFACE( ::com::sun::star::lang::XInitialization ),
|
|
DIRECT_INTERFACE( ::com::sun::star::lang::XComponent ),
|
|
DIRECT_INTERFACE( ::com::sun::star::util::XUpdatable ),
|
|
DIRECT_INTERFACE( ::com::sun::star::ui::XUIConfigurationListener ),
|
|
DERIVED_INTERFACE( ::com::sun::star::container::XNameAccess, ::com::sun::star::container::XElementAccess )
|
|
)
|
|
|
|
DEFINE_XTYPEPROVIDER_11 ( MenuBarWrapper ,
|
|
::com::sun::star::lang::XTypeProvider ,
|
|
::com::sun::star::ui::XUIElement ,
|
|
::com::sun::star::ui::XUIElementSettings ,
|
|
::com::sun::star::beans::XMultiPropertySet ,
|
|
::com::sun::star::beans::XFastPropertySet ,
|
|
::com::sun::star::beans::XPropertySet ,
|
|
::com::sun::star::lang::XInitialization ,
|
|
::com::sun::star::lang::XComponent ,
|
|
::com::sun::star::util::XUpdatable ,
|
|
::com::sun::star::ui::XUIConfigurationListener ,
|
|
::com::sun::star::container::XNameAccess
|
|
)
|
|
|
|
// #110897#
|
|
MenuBarWrapper::MenuBarWrapper(
|
|
const com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& xServiceManager
|
|
)
|
|
: UIConfigElementWrapperBase( UIElementType::MENUBAR ),
|
|
m_bRefreshPopupControllerCache( sal_True ),
|
|
mxServiceFactory( xServiceManager )
|
|
{
|
|
}
|
|
|
|
MenuBarWrapper::~MenuBarWrapper()
|
|
{
|
|
}
|
|
|
|
// #110897#
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& MenuBarWrapper::getServiceFactory()
|
|
{
|
|
// #110897#
|
|
return mxServiceFactory;
|
|
}
|
|
|
|
void SAL_CALL MenuBarWrapper::dispose() throw (::com::sun::star::uno::RuntimeException)
|
|
{
|
|
Reference< XComponent > xThis( static_cast< OWeakObject* >(this), UNO_QUERY );
|
|
|
|
com::sun::star::lang::EventObject aEvent( xThis );
|
|
m_aListenerContainer.disposeAndClear( aEvent );
|
|
|
|
ResetableGuard aLock( m_aLock );
|
|
|
|
m_xMenuBarManager->dispose();
|
|
m_xMenuBarManager.clear();
|
|
m_xConfigSource.clear();
|
|
m_xConfigData.clear();
|
|
|
|
m_xMenuBar.clear();
|
|
m_bDisposed = sal_True;
|
|
}
|
|
|
|
// XInitialization
|
|
void SAL_CALL MenuBarWrapper::initialize( const Sequence< Any >& aArguments ) throw ( Exception, RuntimeException )
|
|
{
|
|
RTL_LOGFILE_CONTEXT( aLog, "framework (cd100003) ::MenuBarWrapper::initialize" );
|
|
|
|
ResetableGuard aLock( m_aLock );
|
|
|
|
if ( m_bDisposed )
|
|
throw DisposedException();
|
|
|
|
if ( !m_bInitialized )
|
|
{
|
|
rtl::OUString aModuleIdentifier;
|
|
UIConfigElementWrapperBase::initialize( aArguments );
|
|
|
|
Reference< XFrame > xFrame( m_xWeakFrame );
|
|
if ( xFrame.is() && m_xConfigSource.is() )
|
|
{
|
|
// Create VCL menubar which will be filled with settings data
|
|
MenuBar* pVCLMenuBar = 0;
|
|
VCLXMenuBar* pAwtMenuBar = 0;
|
|
{
|
|
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
|
|
pVCLMenuBar = new MenuBar();
|
|
}
|
|
|
|
Reference< XModuleManager > xModuleManager;
|
|
xModuleManager = Reference< XModuleManager >(
|
|
getServiceFactory()->createInstance(
|
|
SERVICENAME_MODULEMANAGER ), UNO_QUERY_THROW );
|
|
|
|
try
|
|
{
|
|
aModuleIdentifier = xModuleManager->identify( xFrame );
|
|
}
|
|
catch( Exception& )
|
|
{
|
|
}
|
|
|
|
try
|
|
{
|
|
m_xConfigData = m_xConfigSource->getSettings( m_aResourceURL, sal_False );
|
|
if ( m_xConfigData.is() )
|
|
{
|
|
// Fill menubar with container contents
|
|
Reference< XURLTransformer > xTrans( getServiceFactory()->createInstance(
|
|
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
|
|
"com.sun.star.util.URLTransformer" ))), UNO_QUERY );
|
|
USHORT nId = 1;
|
|
MenuBarManager::FillMenuWithConfiguration( nId, pVCLMenuBar, aModuleIdentifier, m_xConfigData, xTrans );
|
|
}
|
|
}
|
|
catch ( NoSuchElementException& )
|
|
{
|
|
}
|
|
|
|
sal_Bool bMenuOnly( sal_False );
|
|
for ( sal_Int32 n = 0; n < aArguments.getLength(); n++ )
|
|
{
|
|
PropertyValue aPropValue;
|
|
if ( aArguments[n] >>= aPropValue )
|
|
{
|
|
if ( aPropValue.Name.equalsAscii( "MenuOnly" ))
|
|
aPropValue.Value >>= bMenuOnly;
|
|
}
|
|
}
|
|
|
|
if ( !bMenuOnly )
|
|
{
|
|
// Initialize menubar manager with our vcl menu bar. There are some situations where we only want to get the menu without any
|
|
// interaction which is done by the menu bar manager. This must be requested by a special property called "MenuOnly". Be careful
|
|
// a menu bar created with this property is not fully supported. It must be attached to a real menu bar manager to have full
|
|
// support. This feature is currently used for "Inplace editing"!
|
|
Reference< XDispatchProvider > xDispatchProvider;
|
|
|
|
// #110897#
|
|
MenuBarManager* pMenuBarManager = new MenuBarManager( getServiceFactory(),
|
|
xFrame,
|
|
xDispatchProvider,
|
|
aModuleIdentifier,
|
|
pVCLMenuBar,
|
|
sal_False,
|
|
sal_True );
|
|
|
|
m_xMenuBarManager = Reference< XComponent >( static_cast< OWeakObject *>( pMenuBarManager ), UNO_QUERY );
|
|
}
|
|
|
|
// Initialize toolkit menu bar implementation to have awt::XMenuBar for data exchange.
|
|
// Don't use this toolkit menu bar or one of its functions. It is only used as a data container!
|
|
pAwtMenuBar = new VCLXMenuBar( pVCLMenuBar );
|
|
m_xMenuBar = Reference< XMenuBar >( static_cast< OWeakObject *>( pAwtMenuBar ), UNO_QUERY );
|
|
}
|
|
}
|
|
}
|
|
|
|
// XUIElementSettings
|
|
void SAL_CALL MenuBarWrapper::updateSettings() throw ( RuntimeException )
|
|
{
|
|
ResetableGuard aLock( m_aLock );
|
|
|
|
if ( m_bDisposed )
|
|
throw DisposedException();
|
|
|
|
if ( m_xMenuBarManager.is() )
|
|
{
|
|
if ( m_xConfigSource.is() && m_bPersistent )
|
|
{
|
|
try
|
|
{
|
|
MenuBarManager* pMenuBarManager = static_cast< MenuBarManager *>( m_xMenuBarManager.get() );
|
|
|
|
m_xConfigData = m_xConfigSource->getSettings( m_aResourceURL, sal_False );
|
|
if ( m_xConfigData.is() )
|
|
pMenuBarManager->SetItemContainer( m_xConfigData );
|
|
}
|
|
catch ( NoSuchElementException& )
|
|
{
|
|
}
|
|
}
|
|
else if ( !m_bPersistent )
|
|
{
|
|
// Transient menubar: do nothing
|
|
}
|
|
}
|
|
}
|
|
|
|
void SAL_CALL MenuBarWrapper::setSettings( const Reference< XIndexAccess >& xSettings ) throw ( RuntimeException )
|
|
{
|
|
ResetableGuard aLock( m_aLock );
|
|
|
|
if ( m_bDisposed )
|
|
throw DisposedException();
|
|
|
|
if ( xSettings.is() )
|
|
{
|
|
// Create a copy of the data if the container is not const
|
|
Reference< XIndexReplace > xReplace( xSettings, UNO_QUERY );
|
|
if ( xReplace.is() )
|
|
m_xConfigData = Reference< XIndexAccess >( static_cast< OWeakObject * >( new ConstItemContainer( xSettings ) ), UNO_QUERY );
|
|
else
|
|
m_xConfigData = xSettings;
|
|
|
|
if ( m_xConfigSource.is() && m_bPersistent )
|
|
{
|
|
OUString aResourceURL( m_aResourceURL );
|
|
Reference< XUIConfigurationManager > xUICfgMgr( m_xConfigSource );
|
|
|
|
aLock.unlock();
|
|
|
|
try
|
|
{
|
|
xUICfgMgr->replaceSettings( aResourceURL, m_xConfigData );
|
|
}
|
|
catch( NoSuchElementException& )
|
|
{
|
|
}
|
|
}
|
|
else if ( !m_bPersistent )
|
|
{
|
|
// Transient menubar => Fill menubar with new data
|
|
MenuBarManager* pMenuBarManager = static_cast< MenuBarManager *>( m_xMenuBarManager.get() );
|
|
|
|
if ( pMenuBarManager )
|
|
pMenuBarManager->SetItemContainer( m_xConfigData );
|
|
}
|
|
}
|
|
}
|
|
|
|
Reference< XIndexAccess > SAL_CALL MenuBarWrapper::getSettings( sal_Bool bWriteable ) throw ( RuntimeException )
|
|
{
|
|
ResetableGuard aLock( m_aLock );
|
|
|
|
if ( m_bDisposed )
|
|
throw DisposedException();
|
|
|
|
if ( bWriteable )
|
|
return Reference< XIndexAccess >( static_cast< OWeakObject * >( new RootItemContainer( m_xConfigData ) ), UNO_QUERY );
|
|
else
|
|
return m_xConfigData;
|
|
}
|
|
|
|
void MenuBarWrapper::fillPopupControllerCache()
|
|
{
|
|
if ( m_bRefreshPopupControllerCache )
|
|
{
|
|
MenuBarManager* pMenuBarManager = static_cast< MenuBarManager *>( m_xMenuBarManager.get() );
|
|
if ( pMenuBarManager )
|
|
pMenuBarManager->GetPopupController( m_aPopupControllerCache );
|
|
if ( m_aPopupControllerCache.size() > 0 )
|
|
m_bRefreshPopupControllerCache = sal_False;
|
|
}
|
|
}
|
|
|
|
// XElementAccess
|
|
Type SAL_CALL MenuBarWrapper::getElementType()
|
|
throw (::com::sun::star::uno::RuntimeException)
|
|
{
|
|
return ::getCppuType(( Reference< XDispatchProvider >*)0);
|
|
}
|
|
|
|
::sal_Bool SAL_CALL MenuBarWrapper::hasElements()
|
|
throw (::com::sun::star::uno::RuntimeException)
|
|
{
|
|
ResetableGuard aLock( m_aLock );
|
|
|
|
if ( m_bDisposed )
|
|
throw DisposedException();
|
|
|
|
fillPopupControllerCache();
|
|
return ( m_aPopupControllerCache.size() > 0 );
|
|
}
|
|
|
|
// XNameAccess
|
|
Any SAL_CALL MenuBarWrapper::getByName(
|
|
const ::rtl::OUString& aName )
|
|
throw ( container::NoSuchElementException,
|
|
lang::WrappedTargetException,
|
|
uno::RuntimeException)
|
|
{
|
|
ResetableGuard aLock( m_aLock );
|
|
|
|
if ( m_bDisposed )
|
|
throw DisposedException();
|
|
|
|
fillPopupControllerCache();
|
|
|
|
PopupControllerCache::const_iterator pIter = m_aPopupControllerCache.find( aName );
|
|
if ( pIter != m_aPopupControllerCache.end() )
|
|
{
|
|
Any a;
|
|
uno::Reference< frame::XDispatchProvider > xDispatchProvider;
|
|
xDispatchProvider = pIter->second.m_xDispatchProvider;
|
|
|
|
a = uno::makeAny( xDispatchProvider );
|
|
return a;
|
|
}
|
|
else
|
|
throw container::NoSuchElementException();
|
|
}
|
|
|
|
Sequence< ::rtl::OUString > SAL_CALL MenuBarWrapper::getElementNames()
|
|
throw (::com::sun::star::uno::RuntimeException)
|
|
{
|
|
ResetableGuard aLock( m_aLock );
|
|
|
|
if ( m_bDisposed )
|
|
throw DisposedException();
|
|
|
|
fillPopupControllerCache();
|
|
|
|
Sequence< rtl::OUString > aSeq( m_aPopupControllerCache.size() );
|
|
|
|
sal_Int32 i( 0 );
|
|
PopupControllerCache::const_iterator pIter = m_aPopupControllerCache.begin();
|
|
while ( pIter != m_aPopupControllerCache.end() )
|
|
{
|
|
aSeq[i++] = pIter->first;
|
|
++pIter;
|
|
}
|
|
|
|
return aSeq;
|
|
}
|
|
|
|
::sal_Bool SAL_CALL MenuBarWrapper::hasByName(
|
|
const ::rtl::OUString& aName )
|
|
throw (::com::sun::star::uno::RuntimeException)
|
|
{
|
|
ResetableGuard aLock( m_aLock );
|
|
|
|
if ( m_bDisposed )
|
|
throw DisposedException();
|
|
|
|
fillPopupControllerCache();
|
|
|
|
PopupControllerCache::const_iterator pIter = m_aPopupControllerCache.find( aName );
|
|
if ( pIter != m_aPopupControllerCache.end() )
|
|
return sal_True;
|
|
else
|
|
return sal_False;
|
|
}
|
|
|
|
// XUIElement
|
|
Reference< XInterface > SAL_CALL MenuBarWrapper::getRealInterface() throw ( RuntimeException )
|
|
{
|
|
if ( m_bDisposed )
|
|
throw DisposedException();
|
|
|
|
return Reference< XInterface >( m_xMenuBarManager, UNO_QUERY );
|
|
}
|
|
|
|
} // namespace framework
|