/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef _UNOCONTROLS_MULTIPLEXER_HXX
#define _UNOCONTROLS_MULTIPLEXER_HXX
#include <com/sun/star/awt/XKeyListener.hpp>
#include <com/sun/star/awt/XPaintListener.hpp>
#include <com/sun/star/awt/KeyEvent.hpp>
#include <com/sun/star/awt/KeyModifier.hpp>
#include <com/sun/star/awt/XMouseMotionListener.hpp>
#include <com/sun/star/awt/FocusEvent.hpp>
#include <com/sun/star/awt/XWindowListener.hpp>
#include <com/sun/star/awt/XActivateListener.hpp>
#include <com/sun/star/awt/MouseEvent.hpp>
#include <com/sun/star/awt/XTopWindowListener.hpp>
#include <com/sun/star/awt/PaintEvent.hpp>
#include <com/sun/star/awt/InputEvent.hpp>
#include <com/sun/star/awt/KeyGroup.hpp>
#include <com/sun/star/awt/Key.hpp>
#include <com/sun/star/awt/WindowEvent.hpp>
#include <com/sun/star/awt/XMouseListener.hpp>
#include <com/sun/star/awt/KeyFunction.hpp>
#include <com/sun/star/awt/FocusChangeReason.hpp>
#include <com/sun/star/awt/MouseButton.hpp>
#include <com/sun/star/awt/XFocusListener.hpp>
#include <com/sun/star/awt/XTopWindow.hpp>
#include <com/sun/star/awt/XWindow.hpp>
#include <com/sun/star/awt/PosSize.hpp>
#include <cppuhelper/weak.hxx>
#include <cppuhelper/interfacecontainer.hxx>
//____________________________________________________________________________________________________________
// "namespaces"
//____________________________________________________________________________________________________________
namespace unocontrols{
//____________________________________________________________________________________________________________
// class
//____________________________________________________________________________________________________________
class OMRCListenerMultiplexerHelper : public ::com::sun::star::awt::XFocusListener
, public ::com::sun::star::awt::XWindowListener
, public ::com::sun::star::awt::XKeyListener
, public ::com::sun::star::awt::XMouseListener
, public ::com::sun::star::awt::XMouseMotionListener
, public ::com::sun::star::awt::XPaintListener
, public ::com::sun::star::awt::XTopWindowListener
, public ::cppu::OWeakObject
{
//____________________________________________________________________________________________________________
// public methods
//____________________________________________________________________________________________________________
public:
//________________________________________________________________________________________________________
// construct/destruct
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short constructor
@descr Create a Multiplexer of XWindowEvents.
@seealso -
@param rControl The control. All listeners think that this is the original broadcaster.
@param rPeer The peer from which the original events are dispatched. Null is allowed.
@return -
@onerror -
*/
OMRCListenerMultiplexerHelper( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xControl ,
const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer );
/**_______________________________________________________________________________________________________
@short copy-constructor
@descr
@seealso -
@param rCopyInstance C++-Reference to instance to make copy from.
@return -
@onerror -
*/
OMRCListenerMultiplexerHelper( const OMRCListenerMultiplexerHelper& aCopyInstance );
/**_______________________________________________________________________________________________________
@short destructor
@descr -
@seealso -
@param -
@return -
@onerror -
*/
~OMRCListenerMultiplexerHelper();
//________________________________________________________________________________________________________
// XInterface
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short give answer, if interface is supported
@descr The interfaces are searched by type.
@seealso XInterface
@param "rType" is the type of searched interface.
@return Any information about found interface
@onerror A RuntimeException is thrown.
*/
virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType )
throw( ::com::sun::star::uno::RuntimeException );
/**_______________________________________________________________________________________________________
@short increment refcount
@descr -
@seealso XInterface
@seealso release()
@param -
@return -
@onerror A RuntimeException is thrown.
*/
virtual void SAL_CALL acquire() throw();
/**_______________________________________________________________________________________________________
@short decrement refcount
@descr -
@seealso XInterface
@seealso acquire()
@param -
@return -
@onerror A RuntimeException is thrown.
*/
virtual void SAL_CALL release() throw();
//________________________________________________________________________________________________________
// operator
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@param -
@return -
@onerror -
*/
operator ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >() const;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@param -
@return -
@onerror -
*/
OMRCListenerMultiplexerHelper& operator= ( const OMRCListenerMultiplexerHelper& aCopyInstance );
//________________________________________________________________________________________________________
// container methods
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short Remove all listeners from the previous set peer and add the needed listeners to rPeer.
@descr -
@seealso -
@param rPeer The peer from which the original events are dispatched. Null is allowed.
@return -
@onerror -
*/
void setPeer( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer );
/**_______________________________________________________________________________________________________
@short Remove all listeners and send a disposing message.
@descr -
@seealso -
@param -
@return -
@onerror -
*/
void disposeAndClear();
/**_______________________________________________________________________________________________________
@short Add the specified listener to the source.
@descr -
@seealso -
@param -
@return -
@onerror -
*/
void advise( const ::com::sun::star::uno::Type& aType ,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& xListener );
/**_______________________________________________________________________________________________________
@short Remove the specified listener from the source.
@descr -
@seealso -
@param -
@return -
@onerror -
*/
void unadvise( const ::com::sun::star::uno::Type& aType ,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& xListener );
//________________________________________________________________________________________________________
// XEventListener
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& aSource)
throw( ::com::sun::star::uno::RuntimeException ) ;
//________________________________________________________________________________________________________
// XFocusListener
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL focusGained(const ::com::sun::star::awt::FocusEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL focusLost(const ::com::sun::star::awt::FocusEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
//________________________________________________________________________________________________________
// XWindowListener
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowResized(const ::com::sun::star::awt::WindowEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowMoved(const ::com::sun::star::awt::WindowEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowShown(const ::com::sun::star::lang::EventObject& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowHidden(const ::com::sun::star::lang::EventObject& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
//________________________________________________________________________________________________________
// XKeyListener
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL keyPressed( const ::com::sun::star::awt::KeyEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL keyReleased( const ::com::sun::star::awt::KeyEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
//________________________________________________________________________________________________________
// XMouseListener
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL mousePressed(const ::com::sun::star::awt::MouseEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL mouseReleased(const ::com::sun::star::awt::MouseEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL mouseEntered(const ::com::sun::star::awt::MouseEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL mouseExited(const ::com::sun::star::awt::MouseEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
//________________________________________________________________________________________________________
// XMouseMotionListener
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL mouseDragged(const ::com::sun::star::awt::MouseEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL mouseMoved(const ::com::sun::star::awt::MouseEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
//________________________________________________________________________________________________________
// XPaintListener
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowPaint(const ::com::sun::star::awt::PaintEvent& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
//________________________________________________________________________________________________________
// XTopWindowListener
//________________________________________________________________________________________________________
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowOpened( const ::com::sun::star::lang::EventObject& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowClosing( const ::com::sun::star::lang::EventObject& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowClosed( const ::com::sun::star::lang::EventObject& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowMinimized( const ::com::sun::star::lang::EventObject& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowNormalized( const ::com::sun::star::lang::EventObject& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowActivated( const ::com::sun::star::lang::EventObject& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
/**_______________________________________________________________________________________________________
@short -
@descr -
@seealso -
@seealso -
@param -
@return -
@onerror -
*/
virtual void SAL_CALL windowDeactivated( const ::com::sun::star::lang::EventObject& aEvent )
throw( ::com::sun::star::uno::RuntimeException ) ;
//____________________________________________________________________________________________________________
// protected methods
//____________________________________________________________________________________________________________
protected:
/**_______________________________________________________________________________________________________
@short Remove the listener from the peer.
@descr -
@seealso -
@param xPeer The peer from which the listener is removed.
@param rType The listener type, which specify the type of the listener.
@return -
@onerror -
*/
void impl_adviseToPeer( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer ,
const ::com::sun::star::uno::Type& aType );
/**_______________________________________________________________________________________________________
@short Add the listener to the peer.
@descr -
@seealso -
@param xPeer The peer to which the listener is added.
@param rType The listener type, which specify the type of the listener.
@return -
@onerror -
*/
void impl_unadviseFromPeer( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer ,
const ::com::sun::star::uno::Type& aType );
//____________________________________________________________________________________________________________
// private variables
//____________________________________________________________________________________________________________
private:
::osl::Mutex m_aMutex ;
::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow > m_xPeer ; /// The source of the events. Normally this is the peer object.
::com::sun::star::uno::WeakReference< ::com::sun::star::awt::XWindow > m_xControl ;
::cppu::OMultiTypeInterfaceContainerHelper m_aListenerHolder ;
}; // class OMRCListenerMultiplexerHelper
} // namespace unocontrols
#endif // ifndef _UNOCONTROLS_MULTIPLEXER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */