office-gobmx/UnoControls/source/controls/framecontrol.cxx
Rüdiger Timm 15b1ff2055 INTEGRATION: CWS changefileheader (1.6.26); FILE MERGED
2008/04/01 16:03:02 thb 1.6.26.3: #i85898# Stripping all external header guards
2008/04/01 12:59:01 thb 1.6.26.2: #i85898# Stripping all external header guards
2008/03/31 13:07:32 rt 1.6.26.1: #i87441# Change license header to LPGL v3.
2008-04-11 06:14:45 +00:00

607 lines
26 KiB
C++

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: framecontrol.cxx,v $
* $Revision: 1.7 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
//______________________________________________________________________________________________________________
// my own include
//______________________________________________________________________________________________________________
#include "framecontrol.hxx"
//______________________________________________________________________________________________________________
// includes of other projects
//______________________________________________________________________________________________________________
#include <com/sun/star/frame/XDispatchProvider.hpp>
#include <com/sun/star/util/XURLTransformer.hpp>
#include <com/sun/star/frame/XDispatch.hpp>
#include <com/sun/star/frame/FrameSearchFlag.hpp>
#include <com/sun/star/frame/FrameSearchFlag.hpp>
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <cppuhelper/typeprovider.hxx>
#include <vos/diagnose.hxx>
//______________________________________________________________________________________________________________
// include of my own project
//______________________________________________________________________________________________________________
//______________________________________________________________________________________________________________
// namespaces
//______________________________________________________________________________________________________________
using namespace ::rtl ;
using namespace ::osl ;
using namespace ::cppu ;
using namespace ::com::sun::star::uno ;
using namespace ::com::sun::star::lang ;
using namespace ::com::sun::star::beans ;
using namespace ::com::sun::star::awt ;
using namespace ::com::sun::star::frame ;
using namespace ::com::sun::star::util ;
namespace unocontrols{
//______________________________________________________________________________________________________________
// construct/destruct
//______________________________________________________________________________________________________________
FrameControl::FrameControl( const Reference< XMultiServiceFactory >& xFactory )
: BaseControl ( xFactory )
, OBroadcastHelper ( m_aMutex )
, OPropertySetHelper ( *SAL_STATIC_CAST( OBroadcastHelper *, this ) )
, m_aInterfaceContainer ( m_aMutex )
, m_aConnectionPointContainer ( m_aMutex )
{
}
FrameControl::~FrameControl()
{
}
//____________________________________________________________________________________________________________
// XInterface
//____________________________________________________________________________________________________________
Any SAL_CALL FrameControl::queryInterface( const Type& rType ) throw( RuntimeException )
{
// Attention:
// Don't use mutex or guard in this method!!! Is a method of XInterface.
Any aReturn ;
Reference< XInterface > xDel = BaseControl::impl_getDelegator();
if ( xDel.is() )
{
// If an delegator exist, forward question to his queryInterface.
// Delegator will ask his own queryAggregation!
aReturn = xDel->queryInterface( rType );
}
else
{
// If an delegator unknown, forward question to own queryAggregation.
aReturn = queryAggregation( rType );
}
return aReturn ;
}
//____________________________________________________________________________________________________________
// XInterface
//____________________________________________________________________________________________________________
void SAL_CALL FrameControl::acquire() throw()
{
// Attention:
// Don't use mutex or guard in this method!!! Is a method of XInterface.
// Forward to baseclass
BaseControl::acquire();
}
//____________________________________________________________________________________________________________
// XInterface
//____________________________________________________________________________________________________________
void SAL_CALL FrameControl::release() throw()
{
// Attention:
// Don't use mutex or guard in this method!!! Is a method of XInterface.
// Forward to baseclass
BaseControl::release();
}
//____________________________________________________________________________________________________________
// XTypeProvider
//____________________________________________________________________________________________________________
Sequence< Type > SAL_CALL FrameControl::getTypes() throw( RuntimeException )
{
// Optimize this method !
// We initialize a static variable only one time. And we don't must use a mutex at every call!
// For the first call; pTypeCollection is NULL - for the second call pTypeCollection is different from NULL!
static OTypeCollection* pTypeCollection = NULL ;
if ( pTypeCollection == NULL )
{
// Ready for multithreading; get global mutex for first call of this method only! see before
MutexGuard aGuard( Mutex::getGlobalMutex() );
// Control these pointer again ... it can be, that another instance will be faster then these!
if ( pTypeCollection == NULL )
{
// Create a static typecollection ...
static OTypeCollection aTypeCollection ( ::getCppuType(( const Reference< XControlModel >*)NULL ) ,
::getCppuType(( const Reference< XControlContainer >*)NULL ) ,
::getCppuType(( const Reference< XConnectionPointContainer >*)NULL ) ,
BaseControl::getTypes()
);
// ... and set his address to static pointer!
pTypeCollection = &aTypeCollection ;
}
}
return pTypeCollection->getTypes();
}
//____________________________________________________________________________________________________________
// XAggregation
//____________________________________________________________________________________________________________
Any SAL_CALL FrameControl::queryAggregation( const Type& aType ) throw( RuntimeException )
{
// Ask for my own supported interfaces ...
// Attention: XTypeProvider and XInterface are supported by OComponentHelper!
Any aReturn ( ::cppu::queryInterface( aType ,
static_cast< XControlModel* > ( this ) ,
static_cast< XConnectionPointContainer* > ( this )
)
);
// If searched interface not supported by this class ...
if ( aReturn.hasValue() == sal_False )
{
// ... ask baseclasses.
aReturn = OPropertySetHelper::queryInterface( aType );
if ( aReturn.hasValue() == sal_False )
{
aReturn = BaseControl::queryAggregation( aType );
}
}
return aReturn ;
}
//____________________________________________________________________________________________________________
// XControl
//____________________________________________________________________________________________________________
void SAL_CALL FrameControl::createPeer( const Reference< XToolkit >& xToolkit ,
const Reference< XWindowPeer >& xParentPeer ) throw( RuntimeException )
{
BaseControl::createPeer( xToolkit, xParentPeer );
if ( impl_getPeerWindow().is() )
{
if( m_sComponentURL.getLength() > 0 )
{
impl_createFrame( getPeer(), m_sComponentURL, m_seqLoaderArguments );
}
}
}
//____________________________________________________________________________________________________________
// XControl
//____________________________________________________________________________________________________________
sal_Bool SAL_CALL FrameControl::setModel( const Reference< XControlModel >& /*xModel*/ ) throw( RuntimeException )
{
// We have no model.
return sal_False ;
}
//____________________________________________________________________________________________________________
// XControl
//____________________________________________________________________________________________________________
Reference< XControlModel > SAL_CALL FrameControl::getModel() throw( RuntimeException )
{
// We have no model.
return Reference< XControlModel >();
}
//____________________________________________________________________________________________________________
// XControl
//____________________________________________________________________________________________________________
void SAL_CALL FrameControl::dispose() throw( RuntimeException )
{
impl_deleteFrame();
BaseControl::dispose();
}
//____________________________________________________________________________________________________________
// XView
//____________________________________________________________________________________________________________
sal_Bool SAL_CALL FrameControl::setGraphics( const Reference< XGraphics >& /*xDevice*/ ) throw( RuntimeException )
{
// it is not possible to print this control
return sal_False ;
}
//____________________________________________________________________________________________________________
// XView
//____________________________________________________________________________________________________________
Reference< XGraphics > SAL_CALL FrameControl::getGraphics() throw( RuntimeException )
{
// when its not posible to set graphics ! then its possible to return null
return Reference< XGraphics >();
}
//____________________________________________________________________________________________________________
// XConnectionPointContainer
//____________________________________________________________________________________________________________
Sequence< Type > SAL_CALL FrameControl::getConnectionPointTypes() throw( RuntimeException )
{
// Forwarded to helper class
return m_aConnectionPointContainer.getConnectionPointTypes();
}
//____________________________________________________________________________________________________________
// XConnectionPointContainer
//____________________________________________________________________________________________________________
Reference< XConnectionPoint > SAL_CALL FrameControl::queryConnectionPoint( const Type& aType ) throw( RuntimeException )
{
// Forwarded to helper class
return m_aConnectionPointContainer.queryConnectionPoint( aType );
}
//____________________________________________________________________________________________________________
// XConnectionPointContainer
//____________________________________________________________________________________________________________
void SAL_CALL FrameControl::advise( const Type& aType ,
const Reference< XInterface >& xListener ) throw( RuntimeException )
{
// Forwarded to helper class
m_aConnectionPointContainer.advise( aType, xListener );
}
//____________________________________________________________________________________________________________
// XConnectionPointContainer
//____________________________________________________________________________________________________________
void SAL_CALL FrameControl::unadvise( const Type& aType ,
const Reference< XInterface >& xListener ) throw( RuntimeException )
{
// Forwarded to helper class
m_aConnectionPointContainer.unadvise( aType, xListener );
}
//____________________________________________________________________________________________________________
// impl but public method to register service
//____________________________________________________________________________________________________________
const Sequence< OUString > FrameControl::impl_getStaticSupportedServiceNames()
{
MutexGuard aGuard( Mutex::getGlobalMutex() );
Sequence< OUString > seqServiceNames( 1 );
seqServiceNames.getArray() [0] = OUString::createFromAscii( SERVICENAME_FRAMECONTROL );
return seqServiceNames ;
}
//____________________________________________________________________________________________________________
// impl but public method to register service
//____________________________________________________________________________________________________________
const OUString FrameControl::impl_getStaticImplementationName()
{
return OUString::createFromAscii( IMPLEMENTATIONNAME_FRAMECONTROL );
}
//____________________________________________________________________________________________________________
// OPropertySetHelper
//____________________________________________________________________________________________________________
sal_Bool FrameControl::convertFastPropertyValue( Any& rConvertedValue ,
Any& rOldValue ,
sal_Int32 nHandle ,
const Any& rValue ) throw( IllegalArgumentException )
{
sal_Bool bReturn = sal_False ;
switch (nHandle)
{
case PROPERTYHANDLE_COMPONENTURL : rConvertedValue = rValue ;
rOldValue <<= m_sComponentURL ;
bReturn = sal_True ;
break ;
case PROPERTYHANDLE_LOADERARGUMENTS : rConvertedValue = rValue ;
rOldValue <<= m_seqLoaderArguments ;
bReturn = sal_True ;
break ;
}
if ( bReturn == sal_False )
{
throw IllegalArgumentException();
}
return bReturn ;
}
//____________________________________________________________________________________________________________
// OPropertySetHelper
//____________________________________________________________________________________________________________
void FrameControl::setFastPropertyValue_NoBroadcast( sal_Int32 nHandle ,
const Any& rValue )
throw ( ::com::sun::star::uno::Exception )
{
// this method only set the value
MutexGuard aGuard (m_aMutex) ;
switch (nHandle)
{
case PROPERTYHANDLE_COMPONENTURL : rValue >>= m_sComponentURL ;
if (getPeer().is())
{
impl_createFrame ( getPeer(), m_sComponentURL, m_seqLoaderArguments ) ;
}
break ;
case PROPERTYHANDLE_LOADERARGUMENTS : rValue >>= m_seqLoaderArguments ;
break ;
default : VOS_ENSHURE ( nHandle == -1, ERRORTEXT_VOSENSHURE ) ;
}
}
//____________________________________________________________________________________________________________
// OPropertySetHelper
//____________________________________________________________________________________________________________
void FrameControl::getFastPropertyValue( Any& rRet ,
sal_Int32 nHandle ) const
{
MutexGuard aGuard ( Mutex::getGlobalMutex() ) ;
switch (nHandle)
{
case PROPERTYHANDLE_COMPONENTURL : rRet <<= m_sComponentURL ;
break ;
case PROPERTYHANDLE_LOADERARGUMENTS : rRet <<= m_seqLoaderArguments ;
break ;
case PROPERTYHANDLE_FRAME : rRet <<= m_xFrame ;
break ;
default : VOS_ENSHURE ( nHandle == -1, ERRORTEXT_VOSENSHURE ) ;
}
}
//____________________________________________________________________________________________________________
// OPropertySetHelper
//____________________________________________________________________________________________________________
IPropertyArrayHelper& FrameControl::getInfoHelper()
{
// Create a table that map names to index values.
static OPropertyArrayHelper* pInfo ;
if (!pInfo)
{
// global method must be guarded
MutexGuard aGuard ( Mutex::getGlobalMutex() ) ;
if (!pInfo)
{
pInfo = new OPropertyArrayHelper( impl_getStaticPropertyDescriptor(), sal_True );
}
}
return *pInfo ;
}
/*
//--------------------------------------------------------------------------------------------------
// start OConnectionPointContainerHelper
//--------------------------------------------------------------------------------------------------
Uik* FrameControl::getConnectionPointUiks ( sal_Int32* pCount ) const
{
static Uik szUiks[] =
{
((XEventListener*)NULL)->getSmartUik (),
::getCppuType((const Reference< XPropertyChangeListener >*)0),
::getCppuType((const Reference< XVetoableChangeListener >*)0),
::getCppuType((const Reference< XPropertiesChangeListener >*)0)
} ;
*pCount = 4 ;
return szUiks ;
}
//--------------------------------------------------------------------------------------------------
// end OConnectionPointContainerHelper
//--------------------------------------------------------------------------------------------------
*/
//____________________________________________________________________________________________________________
// OPropertySetHelper
//____________________________________________________________________________________________________________
Reference< XPropertySetInfo > SAL_CALL FrameControl::getPropertySetInfo() throw( RuntimeException )
{
// Optimize this method !
// We initialize a static variable only one time. And we don't must use a mutex at every call!
// For the first call; pInfo is NULL - for the second call pInfo is different from NULL!
static Reference< XPropertySetInfo >* pInfo = (Reference< XPropertySetInfo >*)0 ;
if ( pInfo == (Reference< XPropertySetInfo >*)0 )
{
// Ready for multithreading
MutexGuard aGuard ( Mutex::getGlobalMutex () ) ;
// Control this pointer again, another instance can be faster then these!
if ( pInfo == (Reference< XPropertySetInfo >*)0 )
{
// Create structure of propertysetinfo for baseclass "OPropertySetHelper".
// (Use method "getInfoHelper()".)
static Reference< XPropertySetInfo > xInfo ( createPropertySetInfo ( getInfoHelper () ) ) ;
pInfo = &xInfo ;
}
}
return ( *pInfo ) ;
}
//____________________________________________________________________________________________________________
// BaseControl
//____________________________________________________________________________________________________________
WindowDescriptor* FrameControl::impl_getWindowDescriptor( const Reference< XWindowPeer >& xParentPeer )
{
WindowDescriptor* pDescriptor = new WindowDescriptor ;
pDescriptor->Type = WindowClass_CONTAINER ;
pDescriptor->ParentIndex = -1 ;
pDescriptor->Parent = xParentPeer ;
pDescriptor->Bounds = getPosSize () ;
pDescriptor->WindowAttributes = 0 ;
return pDescriptor ;
}
//____________________________________________________________________________________________________________
// private method
//____________________________________________________________________________________________________________
void FrameControl::impl_createFrame( const Reference< XWindowPeer >& xPeer ,
const OUString& rURL ,
const Sequence< PropertyValue >& rArguments )
{
Reference< XFrame > xOldFrame ;
Reference< XFrame > xNewFrame ;
{
MutexGuard aGuard ( m_aMutex ) ;
xOldFrame = m_xFrame ;
}
xNewFrame = Reference< XFrame > ( impl_getMultiServiceFactory()->createInstance ( OUString::createFromAscii( "com.sun.star.frame.Frame" ) ), UNO_QUERY ) ;
Reference< XDispatchProvider > xDSP ( xNewFrame, UNO_QUERY ) ;
if (xDSP.is())
{
Reference< XWindow > xWP ( xPeer, UNO_QUERY ) ;
xNewFrame->initialize ( xWP ) ;
// option
//xFrame->setName( "WhatYouWant" );
Reference< XURLTransformer > xTrans ( impl_getMultiServiceFactory()->createInstance ( OUString::createFromAscii( "com.sun.star.util.URLTransformer" ) ), UNO_QUERY ) ;
if(xTrans.is())
{
// load file
URL aURL ;
aURL.Complete = rURL ;
xTrans->parseStrict( aURL ) ;
Reference< XDispatch > xDisp = xDSP->queryDispatch ( aURL, OUString (), FrameSearchFlag::SELF ) ;
if (xDisp.is())
{
xDisp->dispatch ( aURL, rArguments ) ;
}
}
}
// set the frame
{
MutexGuard aGuard ( m_aMutex ) ;
m_xFrame = xNewFrame ;
}
// notify the listeners
sal_Int32 nFrameId = PROPERTYHANDLE_FRAME ;
Any aNewFrame ( &xNewFrame, ::getCppuType((const Reference< XFrame >*)0) ) ;
Any aOldFrame ( &xOldFrame, ::getCppuType((const Reference< XFrame >*)0) ) ;
fire ( &nFrameId, &aNewFrame, &aOldFrame, 1, sal_False ) ;
if (xOldFrame.is())
{
xOldFrame->dispose () ;
}
}
//____________________________________________________________________________________________________________
// private method
//____________________________________________________________________________________________________________
void FrameControl::impl_deleteFrame()
{
Reference< XFrame > xOldFrame;
Reference< XFrame > xNullFrame;
{
// do not dispose the frame in this guarded section (deadlock?)
MutexGuard aGuard( m_aMutex );
xOldFrame = m_xFrame;
m_xFrame = Reference< XFrame > ();
}
// notify the listeners
sal_Int32 nFrameId = PROPERTYHANDLE_FRAME;
Any aNewFrame( &xNullFrame, ::getCppuType((const Reference< XFrame >*)0) );
Any aOldFrame( &xOldFrame, ::getCppuType((const Reference< XFrame >*)0) );
fire( &nFrameId, &aNewFrame, &aOldFrame, 1, sal_False );
// dispose the frame
if( xOldFrame.is() )
xOldFrame->dispose();
}
//____________________________________________________________________________________________________________
// private method
//____________________________________________________________________________________________________________
const Sequence< Property > FrameControl::impl_getStaticPropertyDescriptor()
{
// All Properties of this implementation. The array must be sorted!
static const Property pPropertys[PROPERTY_COUNT] =
{
Property( OUString::createFromAscii( PROPERTYNAME_COMPONENTURL ), PROPERTYHANDLE_COMPONENTURL , ::getCppuType((const OUString*)0) , PropertyAttribute::BOUND | PropertyAttribute::CONSTRAINED ),
Property( OUString::createFromAscii( PROPERTYNAME_FRAME ), PROPERTYHANDLE_FRAME , ::getCppuType((const Reference< XFrame >*)0) , PropertyAttribute::BOUND | PropertyAttribute::TRANSIENT ),
Property( OUString::createFromAscii( PROPERTYNAME_LOADERARGUMENTS ), PROPERTYHANDLE_LOADERARGUMENTS , ::getCppuType((const Sequence< PropertyValue >*)0), PropertyAttribute::BOUND | PropertyAttribute::CONSTRAINED )
};
static const Sequence< Property > seqPropertys( pPropertys, PROPERTY_COUNT );
return seqPropertys ;
}
} // namespace unocontrols