INTEGRATION: CWS docking1 (1.1.2); FILE ADDED

2004/06/23 16:14:26 cd 1.1.2.4: #i26252# Release reference earlier
2004/06/05 16:32:14 cd 1.1.2.3: #i26252# Added new argument for initialize, parent window (toolbar) is provided
2004/04/21 06:36:58 cd 1.1.2.2: #i26252# New methods to retrieve valuable information
2004/04/05 12:03:40 cd 1.1.2.1: #i26252# New base class for UNO based toolbar controller
This commit is contained in:
Oliver Bolte
2004-07-06 11:13:58 +00:00
parent 102b55c7b3
commit ef8f9cfb26

View File

@@ -0,0 +1,732 @@
/*************************************************************************
*
* $RCSfile: toolboxcontroller.cxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: obo $ $Date: 2004-07-06 12:13:58 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 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
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _SVTOOLS_TOOLBOXCONTROLLER_HXX
#include <toolboxcontroller.hxx>
#endif
#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HPP_
#include <com/sun/star/beans/PropertyValue.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
#include <com/sun/star/beans/XPropertySet.hpp>
#endif
#ifndef _COM_SUN_STAR_FRAME_XDISPATCHPROVIDER_HPP_
#include <com/sun/star/frame/XDispatchProvider.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_DISPOSEDEXCEPTION_HPP_
#include <com/sun/star/lang/DisposedException.hpp>
#endif
#ifndef _DRAFTS_COM_SUN_STAR_FRAME_XLAYOUTMANAGER_HPP_
#include <drafts/com/sun/star/frame/XLayoutManager.hpp>
#endif
#ifndef _VOS_MUTEX_HXX_
#include <vos/mutex.hxx>
#endif
#ifndef _SV_SVAPP_HXX
#include <vcl/svapp.hxx>
#endif
#ifndef _SVTOOLS_IMGDEF_HXX
#include <imgdef.hxx>
#endif
#ifndef INCLUDED_SVTOOLS_MISCOPT_HXX
#include <miscopt.hxx>
#endif
using namespace ::rtl;
using namespace ::cppu;
using namespace ::com::sun::star::awt;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::util;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::frame;
using namespace ::drafts::com::sun::star::frame;
namespace svt
{
ToolboxController::ToolboxController(
const Reference< XMultiServiceFactory >& rServiceManager,
const Reference< XFrame >& xFrame,
const OUString& aCommandURL ) :
OWeakObject()
, m_aListenerContainer( m_aMutex )
, m_xServiceManager( rServiceManager )
, m_xFrame( xFrame )
, m_aCommandURL( aCommandURL )
, m_bInitialized( sal_False )
, m_bDisposed( sal_False )
{
}
ToolboxController::ToolboxController() :
OWeakObject()
, m_aListenerContainer( m_aMutex )
, m_bInitialized( sal_False )
, m_bDisposed( sal_False )
{
}
ToolboxController::~ToolboxController()
{
}
Reference< XFrame > ToolboxController::getFrameInterface() const
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
return m_xFrame;
}
Reference< XMultiServiceFactory > ToolboxController::getServiceManager() const
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
return m_xServiceManager;
}
Reference< XLayoutManager > ToolboxController::getLayoutManager() const
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
Reference< XLayoutManager > xLayoutManager;
Reference< XPropertySet > xPropSet( m_xFrame, UNO_QUERY );
if ( xPropSet.is() )
{
try
{
Any a;
a = xPropSet->getPropertyValue( OUString( RTL_CONSTASCII_USTRINGPARAM( "LayoutManager" )));
a >>= xLayoutManager;
}
catch ( Exception& )
{
}
}
return xLayoutManager;
}
// XInterface
Any SAL_CALL ToolboxController::queryInterface( const Type& rType )
throw ( RuntimeException )
{
Any a = ::cppu::queryInterface(
rType ,
static_cast< XToolbarController* >( this ),
static_cast< XStatusListener* >( this ),
static_cast< XEventListener* >( this ),
static_cast< XInitialization* >( this ),
static_cast< XComponent* >( this ),
static_cast< XUpdatable* >( this ));
if ( a.hasValue() )
return a;
return OWeakObject::queryInterface( rType );
}
void SAL_CALL ToolboxController::acquire() throw ()
{
OWeakObject::acquire();
}
void SAL_CALL ToolboxController::release() throw ()
{
OWeakObject::release();
}
void SAL_CALL ToolboxController::initialize( const Sequence< Any >& aArguments )
throw ( Exception, RuntimeException )
{
const rtl::OUString aFrameName( RTL_CONSTASCII_USTRINGPARAM( "Frame" ));
const rtl::OUString aCommandURLName( RTL_CONSTASCII_USTRINGPARAM( "CommandURL" ));
const rtl::OUString aServiceManagerName( RTL_CONSTASCII_USTRINGPARAM( "ServiceManager" ));
const rtl::OUString aParentWindow( RTL_CONSTASCII_USTRINGPARAM( "ParentWindow" ));
bool bInitialized( true );
bool bBindListener( false );
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
throw DisposedException();
bInitialized = m_bInitialized;
}
if ( !bInitialized )
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
m_bInitialized = sal_True;
PropertyValue aPropValue;
for ( int i = 0; i < aArguments.getLength(); i++ )
{
if ( aArguments[i] >>= aPropValue )
{
if ( aPropValue.Name.equalsAscii( "Frame" ))
aPropValue.Value >>= m_xFrame;
else if ( aPropValue.Name.equalsAscii( "CommandURL" ))
aPropValue.Value >>= m_aCommandURL;
else if ( aPropValue.Name.equalsAscii( "ServiceManager" ))
aPropValue.Value >>= m_xServiceManager;
else if ( aPropValue.Name.equalsAscii( "ParentWindow" ))
aPropValue.Value >>= m_xParentWindow;
}
}
if ( m_aCommandURL.getLength() )
m_aListenerMap.insert( URLToDispatchMap::value_type( m_aCommandURL, Reference< XDispatch >() ));
}
}
void SAL_CALL ToolboxController::update()
throw ( RuntimeException )
{
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
throw DisposedException();
}
// Bind all registered listeners to their dispatch objects
bindListener();
}
// XComponent
void SAL_CALL ToolboxController::dispose()
throw (::com::sun::star::uno::RuntimeException)
{
Reference< XComponent > xThis( static_cast< OWeakObject* >(this), UNO_QUERY );
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
throw DisposedException();
}
com::sun::star::lang::EventObject aEvent( xThis );
m_aListenerContainer.disposeAndClear( aEvent );
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
Reference< XStatusListener > xStatusListener( static_cast< OWeakObject* >( this ), UNO_QUERY );
URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
while ( pIter != m_aListenerMap.end() )
{
try
{
Reference< XDispatch > xDispatch( pIter->second );
Reference< XURLTransformer > xURLTransformer( m_xServiceManager->createInstance(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.URLTransformer" ))),
UNO_QUERY );
com::sun::star::util::URL aTargetURL;
aTargetURL.Complete = pIter->first;
xURLTransformer->parseStrict( aTargetURL );
if ( xDispatch.is() && xStatusListener.is() )
xDispatch->removeStatusListener( xStatusListener, aTargetURL );
}
catch ( Exception& )
{
}
++pIter;
}
m_bDisposed = sal_True;
}
void SAL_CALL ToolboxController::addEventListener( const Reference< XEventListener >& xListener )
throw ( RuntimeException )
{
m_aListenerContainer.addInterface( ::getCppuType( ( const Reference< XEventListener >* ) NULL ), xListener );
}
void SAL_CALL ToolboxController::removeEventListener( const Reference< XEventListener >& aListener )
throw ( RuntimeException )
{
m_aListenerContainer.removeInterface( ::getCppuType( ( const Reference< XEventListener >* ) NULL ), aListener );
}
// XEventListener
void SAL_CALL ToolboxController::disposing( const EventObject& Source )
throw ( RuntimeException )
{
Reference< XInterface > xSource( Source.Source );
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
return;
URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
while ( pIter != m_aListenerMap.end() )
{
// Compare references and release dispatch references if they are equal.
Reference< XInterface > xIfac( pIter->second, UNO_QUERY );
if ( xSource == xIfac )
pIter->second.clear();
}
Reference< XInterface > xIfac( m_xFrame, UNO_QUERY );
if ( xIfac == xSource )
m_xFrame.clear();
}
// XStatusListener
void SAL_CALL ToolboxController::statusChanged( const FeatureStateEvent& Event )
throw ( RuntimeException )
{
// must be implemented by sub class
}
// XToolbarController
void SAL_CALL ToolboxController::execute( sal_Int16 KeyModifier )
throw (::com::sun::star::uno::RuntimeException)
{
Reference< XDispatch > xDispatch;
Reference< XURLTransformer > xURLTransformer;
OUString aCommandURL;
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
throw DisposedException();
if ( m_bInitialized &&
m_xFrame.is() &&
m_xServiceManager.is() &&
m_aCommandURL.getLength() )
{
xURLTransformer = Reference< XURLTransformer >( m_xServiceManager->createInstance(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.URLTransformer" ))),
UNO_QUERY );
aCommandURL = m_aCommandURL;
URLToDispatchMap::iterator pIter = m_aListenerMap.find( m_aCommandURL );
if ( pIter != m_aListenerMap.end() )
xDispatch = pIter->second;
}
}
if ( xDispatch.is() && xURLTransformer.is() )
{
try
{
com::sun::star::util::URL aTargetURL;
Sequence<PropertyValue> aArgs;
aTargetURL.Complete = aCommandURL;
xURLTransformer->parseStrict( aTargetURL );
xDispatch->dispatch( aTargetURL, aArgs );
}
catch ( DisposedException& )
{
}
}
}
void SAL_CALL ToolboxController::click()
throw (::com::sun::star::uno::RuntimeException)
{
}
void SAL_CALL ToolboxController::doubleClick()
throw (::com::sun::star::uno::RuntimeException)
{
}
Reference< XWindow > SAL_CALL ToolboxController::createPopupWindow()
throw (::com::sun::star::uno::RuntimeException)
{
return Reference< XWindow >();
}
Reference< XWindow > SAL_CALL ToolboxController::createItemWindow( const Reference< XWindow >& Parent )
throw (::com::sun::star::uno::RuntimeException)
{
return Reference< XWindow >();
}
void ToolboxController::addStatusListener( const rtl::OUString& aCommandURL )
{
Reference< XDispatch > xDispatch;
Reference< XStatusListener > xStatusListener;
com::sun::star::util::URL aTargetURL;
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
URLToDispatchMap::iterator pIter = m_aListenerMap.find( aCommandURL );
// Already in the list of status listener. Do nothing.
if ( pIter != m_aListenerMap.end() )
return;
// Check if we are already initialized. Implementation starts adding itself as status listener when
// intialize is called.
if ( !m_bInitialized )
{
// Put into the hash_map of status listener. Will be activated when initialized is called
m_aListenerMap.insert( URLToDispatchMap::value_type( aCommandURL, Reference< XDispatch >() ));
return;
}
else
{
// Add status listener directly as intialize has already been called.
Reference< XDispatchProvider > xDispatchProvider( m_xFrame, UNO_QUERY );
if ( m_xServiceManager.is() && xDispatchProvider.is() )
{
Reference< XURLTransformer > xURLTransformer( m_xServiceManager->createInstance(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.URLTransformer" ))),
UNO_QUERY );
aTargetURL.Complete = aCommandURL;
xURLTransformer->parseStrict( aTargetURL );
xDispatch = xDispatchProvider->queryDispatch( aTargetURL, ::rtl::OUString(), 0 );
xStatusListener = Reference< XStatusListener >( static_cast< OWeakObject* >( this ), UNO_QUERY );
URLToDispatchMap::iterator pIter = m_aListenerMap.find( aCommandURL );
if ( pIter != m_aListenerMap.end() )
{
Reference< XDispatch > xOldDispatch( pIter->second );
pIter->second = xDispatch;
try
{
if ( xOldDispatch.is() )
xOldDispatch->removeStatusListener( xStatusListener, aTargetURL );
}
catch ( Exception& )
{
}
}
else
m_aListenerMap.insert( URLToDispatchMap::value_type( aCommandURL, xDispatch ));
}
}
}
// Call without locked mutex as we are called back from dispatch implementation
try
{
if ( xDispatch.is() )
xDispatch->addStatusListener( xStatusListener, aTargetURL );
}
catch ( Exception& )
{
}
}
void ToolboxController::removeStatusListener( const rtl::OUString& aCommandURL )
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
URLToDispatchMap::iterator pIter = m_aListenerMap.find( aCommandURL );
if ( pIter != m_aListenerMap.end() )
{
Reference< XDispatch > xDispatch( pIter->second );
Reference< XStatusListener > xStatusListener( static_cast< OWeakObject* >( this ), UNO_QUERY );
m_aListenerMap.erase( pIter );
try
{
Reference< XURLTransformer > xURLTransformer( m_xServiceManager->createInstance(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.URLTransformer" ))),
UNO_QUERY );
com::sun::star::util::URL aTargetURL;
aTargetURL.Complete = aCommandURL;
xURLTransformer->parseStrict( aTargetURL );
if ( xDispatch.is() && xStatusListener.is() )
xDispatch->removeStatusListener( xStatusListener, aTargetURL );
}
catch ( Exception& )
{
}
}
}
void ToolboxController::bindListener()
{
std::vector< Listener > aDispatchVector;
Reference< XStatusListener > xStatusListener;
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( !m_bInitialized )
return;
// Collect all registered command URL's and store them temporary
Reference< XDispatchProvider > xDispatchProvider( m_xFrame, UNO_QUERY );
if ( m_xServiceManager.is() && xDispatchProvider.is() )
{
xStatusListener = Reference< XStatusListener >( static_cast< OWeakObject* >( this ), UNO_QUERY );
URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
while ( pIter != m_aListenerMap.end() )
{
Reference< XURLTransformer > xURLTransformer( m_xServiceManager->createInstance(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.URLTransformer" ))),
UNO_QUERY );
com::sun::star::util::URL aTargetURL;
aTargetURL.Complete = pIter->first;
xURLTransformer->parseStrict( aTargetURL );
Reference< XDispatch > xDispatch( pIter->second );
if ( xDispatch.is() )
{
// We already have a dispatch object => we have to requery.
// Release old dispatch object and remove it as listener
try
{
xDispatch->removeStatusListener( xStatusListener, aTargetURL );
}
catch ( Exception& )
{
}
}
pIter->second.clear();
xDispatch.clear();
// Query for dispatch object. Old dispatch will be released with this, too.
try
{
xDispatch = xDispatchProvider->queryDispatch( aTargetURL, ::rtl::OUString(), 0 );
}
catch ( Exception& e )
{
}
pIter->second = xDispatch;
Listener aListener( aTargetURL, xDispatch );
aDispatchVector.push_back( aListener );
++pIter;
}
}
}
// Call without locked mutex as we are called back from dispatch implementation
if ( xStatusListener.is() )
{
try
{
for ( sal_uInt32 i = 0; i < aDispatchVector.size(); i++ )
{
Listener& rListener = aDispatchVector[i];
if ( rListener.xDispatch.is() )
rListener.xDispatch->addStatusListener( xStatusListener, rListener.aURL );
else if ( rListener.aURL.Complete == m_aCommandURL )
{
try
{
// Send status changed for the main URL, if we cannot get a valid dispatch object.
// UI disables the button. Catch exception as we release our mutex, it is possible
// that someone else already disposed this instance!
FeatureStateEvent aFeatureStateEvent;
aFeatureStateEvent.IsEnabled = sal_False;
aFeatureStateEvent.FeatureURL = rListener.aURL;
aFeatureStateEvent.State = Any();
xStatusListener->statusChanged( aFeatureStateEvent );
}
catch ( Exception& )
{
}
}
}
}
catch ( Exception& )
{
}
}
}
void ToolboxController::unbindListener()
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( !m_bInitialized )
return;
// Collect all registered command URL's and store them temporary
Reference< XDispatchProvider > xDispatchProvider( m_xFrame, UNO_QUERY );
if ( m_xServiceManager.is() && xDispatchProvider.is() )
{
Reference< XStatusListener > xStatusListener( static_cast< OWeakObject* >( this ), UNO_QUERY );
URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
while ( pIter != m_aListenerMap.end() )
{
Reference< XURLTransformer > xURLTransformer( m_xServiceManager->createInstance(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.URLTransformer" ))),
UNO_QUERY );
com::sun::star::util::URL aTargetURL;
aTargetURL.Complete = pIter->first;
xURLTransformer->parseStrict( aTargetURL );
Reference< XDispatch > xDispatch( pIter->second );
if ( xDispatch.is() )
{
// We already have a dispatch object => we have to requery.
// Release old dispatch object and remove it as listener
try
{
xDispatch->removeStatusListener( xStatusListener, aTargetURL );
}
catch ( Exception& )
{
}
}
pIter->second.clear();
++pIter;
}
}
}
sal_Bool ToolboxController::isBound() const
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( !m_bInitialized )
return sal_False;
URLToDispatchMap::const_iterator pIter = m_aListenerMap.find( m_aCommandURL );
if ( pIter != m_aListenerMap.end() )
return ( pIter->second.is() );
return sal_False;
}
sal_Bool ToolboxController::hasBigImages() const
{
sal_Bool bBig( sal_False );
sal_Int16 eOptSymbolSet = SvtMiscOptions().GetSymbolSet();
if ( eOptSymbolSet == SFX_SYMBOLS_AUTO )
{
// Use system settings, we have to retrieve the toolbar icon size from the
// Application class
ULONG nStyleIconSize = Application::GetSettings().GetStyleSettings().GetToolbarIconSize();
if ( nStyleIconSize == STYLE_TOOLBAR_ICONSIZE_LARGE )
eOptSymbolSet = SFX_SYMBOLS_LARGE;
else
eOptSymbolSet = SFX_SYMBOLS_SMALL;
}
return ( eOptSymbolSet == SFX_SYMBOLS_LARGE );
}
void ToolboxController::updateStatus()
{
bindListener();
}
void ToolboxController::updateStatus( const rtl::OUString aCommandURL )
{
Reference< XDispatch > xDispatch;
Reference< XStatusListener > xStatusListener;
com::sun::star::util::URL aTargetURL;
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( !m_bInitialized )
return;
// Try to find a dispatch object for the requested command URL
Reference< XDispatchProvider > xDispatchProvider( m_xFrame, UNO_QUERY );
xStatusListener = Reference< XStatusListener >( static_cast< OWeakObject* >( this ), UNO_QUERY );
if ( m_xServiceManager.is() && xDispatchProvider.is() )
{
Reference< XURLTransformer > xURLTransformer( m_xServiceManager->createInstance(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.URLTransformer" ))),
UNO_QUERY );
aTargetURL.Complete = aCommandURL;
xURLTransformer->parseStrict( aTargetURL );
xDispatch = xDispatchProvider->queryDispatch( aTargetURL, rtl::OUString(), 0 );
}
}
if ( xDispatch.is() && xStatusListener.is() )
{
// Catch exception as we release our mutex, it is possible that someone else
// has already disposed this instance!
// Add/remove status listener to get a update status information from the
// requested command.
try
{
xDispatch->addStatusListener( xStatusListener, aTargetURL );
xDispatch->removeStatusListener( xStatusListener, aTargetURL );
}
catch ( Exception& )
{
}
}
}
} // svt