blob: fa5fc97910aa97f336d95f0ad5e2d022392b088e [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_forms.hxx"
#include "windowstateguard.hxx"
#include "frm_strings.hxx"
/** === begin UNO includes === **/
#include <com/sun/star/awt/XWindowListener2.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
/** === end UNO includes === **/
#include <cppuhelper/implbase1.hxx>
#include <tools/diagnose_ex.h>
//........................................................................
namespace frm
{
//........................................................................
/** === begin UNO using === **/
using ::com::sun::star::awt::XWindowListener2;
using ::com::sun::star::uno::Reference;
using ::com::sun::star::awt::XWindow2;
using ::com::sun::star::awt::WindowEvent;
using ::com::sun::star::uno::RuntimeException;
using ::com::sun::star::awt::XControlModel;
using ::com::sun::star::beans::XPropertySet;
using ::com::sun::star::lang::EventObject;
using ::com::sun::star::uno::RuntimeException;
using ::com::sun::star::uno::UNO_QUERY;
using ::com::sun::star::uno::Exception;
/** === end UNO using === **/
//====================================================================
//= WindowStateGuard_Impl
//====================================================================
typedef ::cppu::WeakImplHelper1 < XWindowListener2
> WindowStateGuard_Impl_Base;
class WindowStateGuard_Impl : public WindowStateGuard_Impl_Base
{
private:
::osl::Mutex m_aMutex;
Reference< XWindow2 > m_xWindow;
Reference< XPropertySet > m_xModelProps;
public:
/** constructs the instance
@param _rxWindow
the window at which to listen. Must not be <NULL/>.
@param _rxModel
the model which acts as the reference for the states to be enforced. Must not be <NULL/>.
*/
WindowStateGuard_Impl( const Reference< XWindow2 >& _rxWindow, const Reference< XPropertySet >& _rxMdelProps );
void dispose();
protected:
// XWindowListener2
virtual void SAL_CALL windowEnabled( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL windowDisabled( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
// XWindowListener
virtual void SAL_CALL windowResized( const ::com::sun::star::awt::WindowEvent& e ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL windowMoved( const ::com::sun::star::awt::WindowEvent& e ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL windowShown( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL windowHidden( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
// XEventListener
virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException);
private:
/** ensures that the window's Enabled state matches what is described at the model
@precond
our mutex is locked
*/
void impl_ensureEnabledState_nothrow_nolck();
};
//--------------------------------------------------------------------
WindowStateGuard_Impl::WindowStateGuard_Impl( const Reference< XWindow2 >& _rxWindow, const Reference< XPropertySet >& _rxMdelProps )
:m_xWindow( _rxWindow )
,m_xModelProps( _rxMdelProps )
{
if ( !m_xWindow.is() || !m_xModelProps.is() )
throw RuntimeException();
osl_incrementInterlockedCount( &m_refCount );
{
m_xWindow->addWindowListener( this );
}
osl_decrementInterlockedCount( &m_refCount );
}
//--------------------------------------------------------------------
void WindowStateGuard_Impl::dispose()
{
::osl::MutexGuard aGuard( m_aMutex );
if ( !m_xWindow.is() )
// already disposed
return;
m_xWindow->removeWindowListener( this );
m_xWindow.clear();
}
//--------------------------------------------------------------------
void WindowStateGuard_Impl::impl_ensureEnabledState_nothrow_nolck()
{
try
{
Reference< XWindow2 > xWindow;
sal_Bool bEnabled = sal_False;
sal_Bool bShouldBeEnabled = sal_False;
{
::osl::MutexGuard aGuard( m_aMutex );
if ( !m_xWindow.is() || !m_xModelProps.is() )
return;
xWindow = m_xWindow;
bEnabled = xWindow->isEnabled();
OSL_VERIFY( m_xModelProps->getPropertyValue( PROPERTY_ENABLED ) >>= bShouldBeEnabled );
}
if ( !bShouldBeEnabled && bEnabled && xWindow.is() )
xWindow->setEnable( sal_False );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
}
//--------------------------------------------------------------------
void SAL_CALL WindowStateGuard_Impl::windowEnabled( const EventObject& /*e*/ ) throw (RuntimeException)
{
impl_ensureEnabledState_nothrow_nolck();
}
//--------------------------------------------------------------------
void SAL_CALL WindowStateGuard_Impl::windowDisabled( const EventObject& /*e*/ ) throw (RuntimeException)
{
impl_ensureEnabledState_nothrow_nolck();
}
//--------------------------------------------------------------------
void SAL_CALL WindowStateGuard_Impl::windowResized( const WindowEvent& /*e*/ ) throw (RuntimeException)
{
// not interested in
}
//--------------------------------------------------------------------
void SAL_CALL WindowStateGuard_Impl::windowMoved( const WindowEvent& /*e*/ ) throw (RuntimeException)
{
// not interested in
}
//--------------------------------------------------------------------
void SAL_CALL WindowStateGuard_Impl::windowShown( const EventObject& /*e*/ ) throw (RuntimeException)
{
// not interested in
}
//--------------------------------------------------------------------
void SAL_CALL WindowStateGuard_Impl::windowHidden( const EventObject& /*e*/ ) throw (RuntimeException)
{
// not interested in
}
//--------------------------------------------------------------------
void SAL_CALL WindowStateGuard_Impl::disposing( const EventObject& Source ) throw (RuntimeException)
{
OSL_ENSURE( Source.Source == m_xWindow, "WindowStateGuard_Impl::disposing: where does this come from?" );
(void)Source;
dispose();
}
//====================================================================
//= WindowStateGuard
//====================================================================
//--------------------------------------------------------------------
WindowStateGuard::WindowStateGuard()
{
}
//--------------------------------------------------------------------
WindowStateGuard::~WindowStateGuard()
{
}
//--------------------------------------------------------------------
void WindowStateGuard::attach( const Reference< XWindow2 >& _rxWindow, const Reference< XControlModel >& _rxModel )
{
if ( m_pImpl.is() )
{
m_pImpl->dispose();
m_pImpl = NULL;
}
Reference< XPropertySet > xModelProps( _rxModel, UNO_QUERY );
OSL_ENSURE( xModelProps.is() || !_rxModel.is(), "WindowStateGuard::attach: a model which is no XPropertySet?" );
if ( _rxWindow.is() && xModelProps.is() )
m_pImpl = new WindowStateGuard_Impl( _rxWindow, xModelProps );
}
//........................................................................
} // namespace frm
//........................................................................