forms/source/helper/windowstateguard.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <windowstateguard.hxx>
  21 #include <frm_strings.hxx>
  22
  23 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  24 #include <com/sun/star/awt/XWindowListener2.hpp>
  25 #include <com/sun/star/beans/XPropertySet.hpp>
  26 #include <cppuhelper/implbase.hxx>
  27 #include <comphelper/diagnose_ex.hxx>
  28
  29
  30 namespace frm
  31 {
  32
  33
  34     using ::com::sun::star::awt::XWindowListener2;
  35     using ::com::sun::star::uno::Reference;
  36     using ::com::sun::star::awt::XWindow2;
  37     using ::com::sun::star::awt::WindowEvent;
  38     using ::com::sun::star::lang::IllegalArgumentException;
  39     using ::com::sun::star::awt::XControlModel;
  40     using ::com::sun::star::beans::XPropertySet;
  41     using ::com::sun::star::lang::EventObject;
  42     using ::com::sun::star::uno::UNO_QUERY;
  43     using ::com::sun::star::uno::Exception;
  44
  45     typedef ::cppu::WeakImplHelper <   XWindowListener2
  46                                     >   WindowStateGuard_Impl_Base;
  47     class WindowStateGuard_Impl : public WindowStateGuard_Impl_Base
  48     {
  49     private:
  50         ::osl::Mutex                m_aMutex;
  51         Reference< XWindow2 >       m_xWindow;
  52         Reference< XPropertySet >   m_xModelProps;
  53
  54     public:
  55         /** constructs the instance
  56             @param _rxWindow
  57                 the window at which to listen. Must not be <NULL/>.
  58             @param _rxModel
  59                 the model which acts as the reference for the states to be enforced. Must not be <NULL/>.
  60         */
  61         WindowStateGuard_Impl( const Reference< XWindow2 >& _rxWindow, const Reference< XPropertySet >& _rxMdelProps );
  62
  63         void dispose();
  64
  65     protected:
  66         // XWindowListener2
  67         virtual void SAL_CALL windowEnabled( const css::lang::EventObject& e ) override;
  68         virtual void SAL_CALL windowDisabled( const css::lang::EventObject& e ) override;
  69
  70         // XWindowListener
  71         virtual void SAL_CALL windowResized( const css::awt::WindowEvent& e ) override;
  72         virtual void SAL_CALL windowMoved( const css::awt::WindowEvent& e ) override;
  73         virtual void SAL_CALL windowShown( const css::lang::EventObject& e ) override;
  74         virtual void SAL_CALL windowHidden( const css::lang::EventObject& e ) override;
  75
  76         // XEventListener
  77         virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
  78
  79     private:
  80         /** ensures that the window's Enabled state matches what is described at the model
  81             @precond
  82                 our mutex is locked
  83         */
  84         void    impl_ensureEnabledState_nothrow_nolck();
  85     };
  86
  87
  88     WindowStateGuard_Impl::WindowStateGuard_Impl( const Reference< XWindow2 >& _rxWindow, const Reference< XPropertySet >& _rxMdelProps )
  89         :m_xWindow( _rxWindow )
  90         ,m_xModelProps( _rxMdelProps )
  91     {
  92         if ( !m_xWindow.is() )
  93             throw IllegalArgumentException(u"no window supplied"_ustr, *this, 0);
  94         if ( !m_xModelProps.is() )
  95             throw IllegalArgumentException(u"no property set supplied"_ustr, *this, 1);
  96
  97         osl_atomic_increment( &m_refCount );
  98         {
  99             m_xWindow->addWindowListener( this );
 100         }
 101         osl_atomic_decrement( &m_refCount );
 102     }
 103
 104
 105     void WindowStateGuard_Impl::dispose()
 106     {
 107         ::osl::MutexGuard aGuard( m_aMutex );
 108         if ( !m_xWindow.is() )
 109             // already disposed
 110             return;
 111
 112         m_xWindow->removeWindowListener( this );
 113         m_xWindow.clear();
 114     }
 115
 116
 117     void WindowStateGuard_Impl::impl_ensureEnabledState_nothrow_nolck()
 118     {
 119         try
 120         {
 121             Reference< XWindow2 > xWindow;
 122             Reference< XPropertySet > xModelProps;
 123             bool bShouldBeEnabled = false;
 124             {
 125                 ::osl::MutexGuard aGuard( m_aMutex );
 126                 if ( !m_xWindow.is() || !m_xModelProps.is() )
 127                     return;
 128                 xWindow = m_xWindow;
 129                 xModelProps = m_xModelProps;
 130             }
 131             // fdo#42157: do not lock m_aMutex to prevent deadlock
 132             bool const bEnabled = xWindow->isEnabled();
 133             OSL_VERIFY( xModelProps->getPropertyValue( PROPERTY_ENABLED )
 134                         >>= bShouldBeEnabled );
 135
 136             if ( !bShouldBeEnabled && bEnabled )
 137                 xWindow->setEnable( false );
 138         }
 139         catch( const Exception& )
 140         {
 141             DBG_UNHANDLED_EXCEPTION("forms.helper");
 142         }
 143     }
 144
 145
 146     void SAL_CALL WindowStateGuard_Impl::windowEnabled( const EventObject& /*e*/ )
 147     {
 148         impl_ensureEnabledState_nothrow_nolck();
 149     }
 150
 151
 152     void SAL_CALL WindowStateGuard_Impl::windowDisabled( const EventObject& /*e*/ )
 153     {
 154         impl_ensureEnabledState_nothrow_nolck();
 155     }
 156
 157
 158     void SAL_CALL WindowStateGuard_Impl::windowResized( const WindowEvent& /*e*/ )
 159     {
 160         // not interested in
 161     }
 162
 163
 164     void SAL_CALL WindowStateGuard_Impl::windowMoved( const WindowEvent& /*e*/ )
 165     {
 166         // not interested in
 167     }
 168
 169
 170     void SAL_CALL WindowStateGuard_Impl::windowShown( const EventObject& /*e*/ )
 171     {
 172         // not interested in
 173     }
 174
 175
 176     void SAL_CALL WindowStateGuard_Impl::windowHidden( const EventObject& /*e*/ )
 177     {
 178         // not interested in
 179     }
 180
 181
 182     void SAL_CALL WindowStateGuard_Impl::disposing( const EventObject& Source )
 183     {
 184         OSL_ENSURE( Source.Source == m_xWindow, "WindowStateGuard_Impl::disposing: where does this come from?" );
 185         dispose();
 186     }
 187
 188     WindowStateGuard::WindowStateGuard()
 189     {
 190     }
 191
 192
 193     WindowStateGuard::~WindowStateGuard()
 194     {
 195     }
 196
 197
 198     void WindowStateGuard::attach( const Reference< XWindow2 >& _rxWindow, const Reference< XControlModel >& _rxModel )
 199     {
 200         if ( m_pImpl.is() )
 201         {
 202             m_pImpl->dispose();
 203             m_pImpl = nullptr;
 204         }
 205
 206         Reference< XPropertySet > xModelProps( _rxModel, UNO_QUERY );
 207         OSL_ENSURE( xModelProps.is() || !_rxModel.is(), "WindowStateGuard::attach: a model which is no XPropertySet?" );
 208         if ( _rxWindow.is() && xModelProps.is() )
 209             m_pImpl = new WindowStateGuard_Impl( _rxWindow, xModelProps );
 210     }
 211
 212
 213 } // namespace frm
 214
 215
 216 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */