sfx2/source/view/userinputinterception.cxx

   1 /*************************************************************************
   2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 *
   4 * Copyright 2008 by Sun Microsystems, Inc.
   5 *
   6 * OpenOffice.org - a multi-platform office productivity suite
   7 *
   8 * $RCSfile: userinputinterception.cxx,v $
   9 *
  10 * $Revision: 1.2 $
  11 *
  12 * This file is part of OpenOffice.org.
  13 *
  14 * OpenOffice.org is free software: you can redistribute it and/or modify
  15 * it under the terms of the GNU Lesser General Public License version 3
  16 * only, as published by the Free Software Foundation.
  17 *
  18 * OpenOffice.org is distributed in the hope that it will be useful,
  19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 * GNU Lesser General Public License version 3 for more details
  22 * (a copy is included in the LICENSE file that accompanied this code).
  23 *
  24 * You should have received a copy of the GNU Lesser General Public License
  25 * version 3 along with OpenOffice.org.  If not, see
  26 * <http://www.openoffice.org/license.html>
  27 * for a copy of the LGPLv3 License.
  28 ************************************************************************/
  29
  30 // MARKER(update_precomp.py): autogen include statement, do not remove
  31 #include "precompiled_sfx2.hxx"
  32
  33 #include "sfx2/userinputinterception.hxx"
  34
  35 /** === begin UNO includes === **/
  36 #include <com/sun/star/awt/MouseButton.hpp>
  37 #include <com/sun/star/awt/KeyModifier.hpp>
  38 /** === end UNO includes === **/
  39
  40 #include <cppuhelper/interfacecontainer.hxx>
  41 #include <cppuhelper/weak.hxx>
  42 #include <vcl/event.hxx>
  43 #include <vcl/window.hxx>
  44
  45 //........................................................................
  46 namespace sfx2
  47 {
  48 //........................................................................
  49
  50     /** === begin UNO using === **/
  51     using ::com::sun::star::uno::Reference;
  52     using ::com::sun::star::uno::XInterface;
  53     using ::com::sun::star::uno::UNO_QUERY;
  54     using ::com::sun::star::uno::UNO_QUERY_THROW;
  55     using ::com::sun::star::uno::UNO_SET_THROW;
  56     using ::com::sun::star::uno::Exception;
  57     using ::com::sun::star::uno::RuntimeException;
  58     using ::com::sun::star::uno::Any;
  59     using ::com::sun::star::uno::makeAny;
  60     using ::com::sun::star::awt::MouseEvent;
  61     using ::com::sun::star::awt::KeyEvent;
  62     using ::com::sun::star::awt::InputEvent;
  63     using ::com::sun::star::awt::XKeyHandler;
  64     using ::com::sun::star::awt::XMouseClickHandler;
  65     using ::com::sun::star::lang::DisposedException;
  66     /** === end UNO using === **/
  67     namespace MouseButton = ::com::sun::star::awt::MouseButton;
  68     namespace KeyModifier = ::com::sun::star::awt::KeyModifier;
  69
  70     struct UserInputInterception_Data
  71     {
  72     public:
  73         ::cppu::OWeakObject&                m_rControllerImpl;
  74         ::cppu::OInterfaceContainerHelper   m_aKeyHandlers;
  75         ::cppu::OInterfaceContainerHelper   m_aMouseClickHandlers;
  76
  77     public:
  78         UserInputInterception_Data( ::cppu::OWeakObject& _rControllerImpl, ::osl::Mutex& _rMutex )
  79             :m_rControllerImpl( _rControllerImpl )
  80             ,m_aKeyHandlers( _rMutex )
  81             ,m_aMouseClickHandlers( _rMutex )
  82         {
  83         }
  84     };
  85
  86     namespace
  87     {
  88         template< class VLCEVENT >
  89         void lcl_initModifiers( InputEvent& _rEvent, const VLCEVENT& _rVclEvent )
  90         {
  91             _rEvent.Modifiers = 0;
  92
  93             if ( _rVclEvent.IsShift() )
  94                 _rEvent.Modifiers |= KeyModifier::SHIFT;
  95             if ( _rVclEvent.IsMod1() )
  96                 _rEvent.Modifiers |= KeyModifier::MOD1;
  97             if ( _rVclEvent.IsMod2() )
  98                 _rEvent.Modifiers |= KeyModifier::MOD2;
  99                 if ( _rVclEvent.IsMod3() )
 100                         _rEvent.Modifiers |= KeyModifier::MOD3;
 101         }
 102
 103         void lcl_initKeyEvent( KeyEvent& rEvent, const ::KeyEvent& rEvt )
 104         {
 105             lcl_initModifiers( rEvent, rEvt.GetKeyCode() );
 106
 107             rEvent.KeyCode = rEvt.GetKeyCode().GetCode();
 108             rEvent.KeyChar = rEvt.GetCharCode();
 109             rEvent.KeyFunc = sal::static_int_cast< sal_Int16 >( rEvt.GetKeyCode().GetFunction());
 110         }
 111
 112         void lcl_initMouseEvent( MouseEvent& rEvent, const ::MouseEvent& rEvt )
 113         {
 114             lcl_initModifiers( rEvent, rEvt );
 115
 116             rEvent.Buttons = 0;
 117             if ( rEvt.IsLeft() )
 118                 rEvent.Buttons |= MouseButton::LEFT;
 119             if ( rEvt.IsRight() )
 120                 rEvent.Buttons |= MouseButton::RIGHT;
 121             if ( rEvt.IsMiddle() )
 122                 rEvent.Buttons |= MouseButton::MIDDLE;
 123
 124             rEvent.X = rEvt.GetPosPixel().X();
 125             rEvent.Y = rEvt.GetPosPixel().Y();
 126             rEvent.ClickCount = rEvt.GetClicks();
 127             rEvent.PopupTrigger = sal_False;
 128         }
 129
 130     }
 131
 132     //====================================================================
 133     //= UserInputInterception
 134     //====================================================================
 135     //--------------------------------------------------------------------
 136     UserInputInterception::UserInputInterception( ::cppu::OWeakObject& _rControllerImpl, ::osl::Mutex& _rMutex )
 137         :m_pData( new UserInputInterception_Data( _rControllerImpl, _rMutex ) )
 138     {
 139     }
 140
 141     //--------------------------------------------------------------------
 142     UserInputInterception::~UserInputInterception()
 143     {
 144     }
 145
 146     //--------------------------------------------------------------------
 147     void UserInputInterception::addKeyHandler( const Reference< XKeyHandler >& _rxHandler ) throw (RuntimeException)
 148     {
 149         if ( _rxHandler.is() )
 150             m_pData->m_aKeyHandlers.addInterface( _rxHandler );
 151     }
 152
 153     //--------------------------------------------------------------------
 154     void UserInputInterception::removeKeyHandler( const Reference< XKeyHandler >& _rxHandler ) throw (RuntimeException)
 155     {
 156         m_pData->m_aKeyHandlers.removeInterface( _rxHandler );
 157     }
 158
 159     //--------------------------------------------------------------------
 160     void UserInputInterception::addMouseClickHandler( const Reference< XMouseClickHandler >& _rxHandler ) throw (RuntimeException)
 161     {
 162         if ( _rxHandler.is() )
 163             m_pData->m_aMouseClickHandlers.addInterface( _rxHandler );
 164     }
 165
 166     //--------------------------------------------------------------------
 167     void UserInputInterception::removeMouseClickHandler( const Reference< XMouseClickHandler >& _rxHandler ) throw (RuntimeException)
 168     {
 169         m_pData->m_aMouseClickHandlers.removeInterface( _rxHandler );
 170     }
 171
 172     //--------------------------------------------------------------------
 173     bool UserInputInterception::hasKeyHandlers() const
 174     {
 175         return m_pData->m_aKeyHandlers.getLength() > 0;
 176     }
 177
 178     //--------------------------------------------------------------------
 179     bool UserInputInterception::hasMouseClickListeners() const
 180     {
 181         return m_pData->m_aMouseClickHandlers.getLength() > 0;
 182     }
 183
 184     //--------------------------------------------------------------------
 185     bool UserInputInterception::handleNotifyEvent( const NotifyEvent& _rEvent )
 186     {
 187         Reference < XInterface > xHoldAlive( m_pData->m_rControllerImpl );
 188
 189         USHORT nType = _rEvent.GetType();
 190         bool bHandled = false;
 191
 192         switch ( nType )
 193         {
 194             case EVENT_KEYINPUT:
 195             case EVENT_KEYUP:
 196             {
 197                 KeyEvent aEvent;
 198                 lcl_initKeyEvent( aEvent, *_rEvent.GetKeyEvent() );
 199                 if ( _rEvent.GetWindow() )
 200                     aEvent.Source = _rEvent.GetWindow()->GetComponentInterface();
 201
 202                 ::cppu::OInterfaceIteratorHelper aIterator( m_pData->m_aKeyHandlers );
 203                 while ( aIterator.hasMoreElements() )
 204                 {
 205                     Reference< XKeyHandler > xHandler( static_cast< XKeyHandler* >( aIterator.next() ) );
 206                     if ( !xHandler.is() )
 207                         continue;
 208
 209                     try
 210                     {
 211                         if ( nType == EVENT_KEYINPUT )
 212                             bHandled = xHandler->keyPressed( aEvent );
 213                         else
 214                             bHandled = xHandler->keyReleased( aEvent );
 215                     }
 216                     catch( const DisposedException& e )
 217                     {
 218                         if ( e.Context == xHandler )
 219                             aIterator.remove();
 220                     }
 221                 }
 222             }
 223             break;
 224
 225             case EVENT_MOUSEBUTTONDOWN:
 226             case EVENT_MOUSEBUTTONUP:
 227             {
 228                 MouseEvent aEvent;
 229                 lcl_initMouseEvent( aEvent, *_rEvent.GetMouseEvent() );
 230                 if ( _rEvent.GetWindow() )
 231                     aEvent.Source = _rEvent.GetWindow()->GetComponentInterface();
 232
 233                 ::cppu::OInterfaceIteratorHelper aIterator( m_pData->m_aMouseClickHandlers );
 234                 while ( aIterator.hasMoreElements() )
 235                 {
 236                     Reference< XMouseClickHandler > xHandler( static_cast< XMouseClickHandler* >( aIterator.next() ) );
 237                     if ( !xHandler.is() )
 238                         continue;
 239
 240                     try
 241                     {
 242                         if ( nType == EVENT_MOUSEBUTTONDOWN )
 243                             bHandled = xHandler->mousePressed( aEvent );
 244                         else
 245                             bHandled = xHandler->mouseReleased( aEvent );
 246                     }
 247                     catch( const DisposedException& e )
 248                     {
 249                         if ( e.Context == xHandler )
 250                             aIterator.remove();
 251                     }
 252                 }
 253             }
 254             break;
 255
 256             default:
 257                 OSL_ENSURE( false, "UserInputInterception::handleNotifyEvent: illegal event type!" );
 258                 break;
 259         }
 260
 261         return bHandled;
 262     }
 263
 264 //........................................................................
 265 } // namespace sfx2
 266 //........................................................................