blob: 4d94a3b7c9901352e45c44131c75b99bfe6e40f4 [file] [log] [blame]
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_svtools.hxx"
#include <svtools/statusbarcontroller.hxx>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/frame/XDispatchProvider.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
#include <com/sun/star/frame/XLayoutManager.hpp>
#include <vos/mutex.hxx>
#include <vcl/svapp.hxx>
#include <vcl/window.hxx>
#include <vcl/status.hxx>
#include <svtools/imgdef.hxx>
#include <svtools/miscopt.hxx>
#include <toolkit/helper/vclunohelper.hxx>
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 ::com::sun::star::frame;
namespace svt
{
StatusbarController::StatusbarController(
const Reference< XMultiServiceFactory >& rServiceManager,
const Reference< XFrame >& xFrame,
const ::rtl::OUString& aCommandURL,
unsigned short nID ) :
OWeakObject()
, m_bInitialized( sal_False )
, m_bDisposed( sal_False )
, m_nID( nID )
, m_xFrame( xFrame )
, m_xServiceManager( rServiceManager )
, m_aCommandURL( aCommandURL )
, m_aListenerContainer( m_aMutex )
{
}
StatusbarController::StatusbarController() :
OWeakObject()
, m_bInitialized( sal_False )
, m_bDisposed( sal_False )
, m_nID( 0 )
, m_aListenerContainer( m_aMutex )
{
}
StatusbarController::~StatusbarController()
{
}
Reference< XFrame > StatusbarController::getFrameInterface() const
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
return m_xFrame;
}
Reference< XMultiServiceFactory > StatusbarController::getServiceManager() const
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
return m_xServiceManager;
}
Reference< XLayoutManager > StatusbarController::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( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "LayoutManager" )));
a >>= xLayoutManager;
}
catch ( Exception& )
{
}
}
return xLayoutManager;
}
Reference< XURLTransformer > StatusbarController::getURLTransformer() const
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( !m_xURLTransformer.is() && m_xServiceManager.is() )
{
m_xURLTransformer = Reference< XURLTransformer >(
m_xServiceManager->createInstance(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.URLTransformer" ))),
UNO_QUERY );
}
return m_xURLTransformer;
}
// XInterface
Any SAL_CALL StatusbarController::queryInterface( const Type& rType )
throw ( RuntimeException )
{
Any a = ::cppu::queryInterface(
rType ,
static_cast< XStatusbarController* >( 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 StatusbarController::acquire() throw ()
{
OWeakObject::acquire();
}
void SAL_CALL StatusbarController::release() throw ()
{
OWeakObject::release();
}
void SAL_CALL StatusbarController::initialize( const Sequence< Any >& aArguments )
throw ( Exception, RuntimeException )
{
bool bInitialized( true );
{
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.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "Frame" )))
aPropValue.Value >>= m_xFrame;
else if ( aPropValue.Name.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "CommandURL" )))
aPropValue.Value >>= m_aCommandURL;
else if ( aPropValue.Name.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "ServiceManager" )))
aPropValue.Value >>= m_xServiceManager;
else if ( aPropValue.Name.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "ParentWindow" )))
aPropValue.Value >>= m_xParentWindow;
else if ( aPropValue.Name.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "Identifier" )))
aPropValue.Value >>= m_nID;
else if ( aPropValue.Name.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "StatusbarItem" )))
aPropValue.Value >>= m_xStatusbarItem;
}
}
if ( m_aCommandURL.getLength() )
m_aListenerMap.insert( URLToDispatchMap::value_type( m_aCommandURL, Reference< XDispatch >() ));
}
}
void SAL_CALL StatusbarController::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 StatusbarController::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 );
Reference< XURLTransformer > xURLTransformer = getURLTransformer();
URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
com::sun::star::util::URL aTargetURL;
while ( pIter != m_aListenerMap.end() )
{
try
{
Reference< XDispatch > xDispatch( pIter->second );
aTargetURL.Complete = pIter->first;
xURLTransformer->parseStrict( aTargetURL );
if ( xDispatch.is() && xStatusListener.is() )
xDispatch->removeStatusListener( xStatusListener, aTargetURL );
}
catch ( Exception& )
{
}
++pIter;
}
// clear hash map
m_aListenerMap.clear();
// release references
m_xURLTransformer.clear();
m_xServiceManager.clear();
m_xFrame.clear();
m_xParentWindow.clear();
m_xStatusbarItem.clear();
m_bDisposed = sal_True;
}
void SAL_CALL StatusbarController::addEventListener( const Reference< XEventListener >& xListener )
throw ( RuntimeException )
{
m_aListenerContainer.addInterface( ::getCppuType( ( const Reference< XEventListener >* ) NULL ), xListener );
}
void SAL_CALL StatusbarController::removeEventListener( const Reference< XEventListener >& aListener )
throw ( RuntimeException )
{
m_aListenerContainer.removeInterface( ::getCppuType( ( const Reference< XEventListener >* ) NULL ), aListener );
}
// XEventListener
void SAL_CALL StatusbarController::disposing( const EventObject& Source )
throw ( RuntimeException )
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
return;
Reference< XFrame > xFrame( Source.Source, UNO_QUERY );
if ( xFrame.is() )
{
if ( xFrame == m_xFrame )
m_xFrame.clear();
return;
}
Reference< XDispatch > xDispatch( Source.Source, UNO_QUERY );
if ( !xDispatch.is() )
return;
URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
while ( pIter != m_aListenerMap.end() )
{
// Compare references and release dispatch references if they are equal.
if ( xDispatch == pIter->second )
pIter->second.clear();
pIter++;
}
}
// XStatusListener
void SAL_CALL StatusbarController::statusChanged( const FeatureStateEvent& Event )
throw ( RuntimeException )
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
return;
Window* pWindow = VCLUnoHelper::GetWindow( m_xParentWindow );
if ( pWindow && pWindow->GetType() == WINDOW_STATUSBAR && m_nID != 0 )
{
rtl::OUString aStrValue;
StatusBar* pStatusBar = (StatusBar *)pWindow;
if ( Event.State >>= aStrValue )
pStatusBar->SetItemText( m_nID, aStrValue );
else if ( !Event.State.hasValue() )
pStatusBar->SetItemText( m_nID, String() );
}
}
// XStatusbarController
::sal_Bool SAL_CALL StatusbarController::mouseButtonDown(
const ::com::sun::star::awt::MouseEvent& )
throw (::com::sun::star::uno::RuntimeException)
{
return sal_False;
}
::sal_Bool SAL_CALL StatusbarController::mouseMove(
const ::com::sun::star::awt::MouseEvent& )
throw (::com::sun::star::uno::RuntimeException)
{
return sal_False;
}
::sal_Bool SAL_CALL StatusbarController::mouseButtonUp(
const ::com::sun::star::awt::MouseEvent& )
throw (::com::sun::star::uno::RuntimeException)
{
return sal_False;
}
void SAL_CALL StatusbarController::command(
const ::com::sun::star::awt::Point&,
::sal_Int32,
::sal_Bool,
const ::com::sun::star::uno::Any& )
throw (::com::sun::star::uno::RuntimeException)
{
}
void SAL_CALL StatusbarController::paint(
const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XGraphics >&,
const ::com::sun::star::awt::Rectangle&,
::sal_Int32 )
throw (::com::sun::star::uno::RuntimeException)
{
}
void SAL_CALL StatusbarController::click( const ::com::sun::star::awt::Point& )
throw (::com::sun::star::uno::RuntimeException)
{
}
void SAL_CALL StatusbarController::doubleClick( const ::com::sun::star::awt::Point& ) throw (::com::sun::star::uno::RuntimeException)
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
return;
Sequence< PropertyValue > aArgs;
execute( aArgs );
}
void StatusbarController::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 = getURLTransformer();
aTargetURL.Complete = aCommandURL;
xURLTransformer->parseStrict( aTargetURL );
xDispatch = xDispatchProvider->queryDispatch( aTargetURL, ::rtl::OUString(), 0 );
xStatusListener = Reference< XStatusListener >( static_cast< OWeakObject* >( this ), UNO_QUERY );
URLToDispatchMap::iterator aIter = m_aListenerMap.find( aCommandURL );
if ( aIter != m_aListenerMap.end() )
{
Reference< XDispatch > xOldDispatch( aIter->second );
aIter->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 StatusbarController::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 = getURLTransformer();
com::sun::star::util::URL aTargetURL;
aTargetURL.Complete = aCommandURL;
xURLTransformer->parseStrict( aTargetURL );
if ( xDispatch.is() && xStatusListener.is() )
xDispatch->removeStatusListener( xStatusListener, aTargetURL );
}
catch ( Exception& )
{
}
}
}
void StatusbarController::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 = getURLTransformer();
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& )
{
}
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() )
return;
for ( sal_uInt32 i = 0; i < aDispatchVector.size(); i++ )
{
try
{
Listener& rListener = aDispatchVector[i];
if ( rListener.xDispatch.is() )
rListener.xDispatch->addStatusListener( xStatusListener, rListener.aURL );
else if ( rListener.aURL.Complete == m_aCommandURL )
{
// 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 ( ... ){}
}
}
void StatusbarController::unbindListener()
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( !m_bInitialized )
return;
Reference< XStatusListener > xStatusListener( static_cast< OWeakObject* >( this ), UNO_QUERY );
URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
while ( pIter != m_aListenerMap.end() )
{
Reference< XURLTransformer > xURLTransformer = getURLTransformer();
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 StatusbarController::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;
}
void StatusbarController::updateStatus()
{
bindListener();
}
void StatusbarController::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 = getURLTransformer();
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& )
{
}
}
}
::Rectangle StatusbarController::getControlRect() const
{
::Rectangle aRect;
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
throw DisposedException();
if ( m_xParentWindow.is() )
{
StatusBar* pStatusBar = dynamic_cast< StatusBar* >( VCLUnoHelper::GetWindow( m_xParentWindow ));
if ( pStatusBar && pStatusBar->GetType() == WINDOW_STATUSBAR )
aRect = pStatusBar->GetItemRect( m_nID );
}
}
return aRect;
}
void StatusbarController::execute( const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& aArgs )
{
Reference< XDispatch > xDispatch;
Reference< XURLTransformer > xURLTransformer;
rtl::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 = getURLTransformer();
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;
aTargetURL.Complete = aCommandURL;
xURLTransformer->parseStrict( aTargetURL );
xDispatch->dispatch( aTargetURL, aArgs );
}
catch ( DisposedException& )
{
}
}
}
void StatusbarController::execute(
const rtl::OUString& aCommandURL,
const Sequence< ::com::sun::star::beans::PropertyValue >& aArgs )
{
Reference< XDispatch > xDispatch;
com::sun::star::util::URL aTargetURL;
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
throw DisposedException();
if ( m_bInitialized &&
m_xFrame.is() &&
m_xServiceManager.is() &&
m_aCommandURL.getLength() )
{
Reference< XURLTransformer > xURLTransformer( getURLTransformer() );
aTargetURL.Complete = aCommandURL;
xURLTransformer->parseStrict( aTargetURL );
URLToDispatchMap::iterator pIter = m_aListenerMap.find( aCommandURL );
if ( pIter != m_aListenerMap.end() )
xDispatch = pIter->second;
else
{
Reference< ::com::sun::star::frame::XDispatchProvider > xDispatchProvider(
m_xFrame->getController(), UNO_QUERY );
if ( xDispatchProvider.is() )
xDispatch = xDispatchProvider->queryDispatch( aTargetURL, ::rtl::OUString(), 0 );
}
}
}
if ( xDispatch.is() )
{
try
{
xDispatch->dispatch( aTargetURL, aArgs );
}
catch ( DisposedException& )
{
}
}
}
} // svt