UnoControls/inc/multiplexer.hxx

   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 #ifndef INCLUDED_UNOCONTROLS_INC_MULTIPLEXER_HXX
  21 #define INCLUDED_UNOCONTROLS_INC_MULTIPLEXER_HXX
  22
  23 #include <com/sun/star/awt/XKeyListener.hpp>
  24 #include <com/sun/star/awt/XPaintListener.hpp>
  25 #include <com/sun/star/awt/KeyEvent.hpp>
  26 #include <com/sun/star/awt/KeyModifier.hpp>
  27 #include <com/sun/star/awt/XMouseMotionListener.hpp>
  28 #include <com/sun/star/awt/FocusEvent.hpp>
  29 #include <com/sun/star/awt/XWindowListener.hpp>
  30 #include <com/sun/star/awt/XActivateListener.hpp>
  31 #include <com/sun/star/awt/MouseEvent.hpp>
  32 #include <com/sun/star/awt/XTopWindowListener.hpp>
  33 #include <com/sun/star/awt/PaintEvent.hpp>
  34 #include <com/sun/star/awt/InputEvent.hpp>
  35 #include <com/sun/star/awt/KeyGroup.hpp>
  36 #include <com/sun/star/awt/Key.hpp>
  37 #include <com/sun/star/awt/WindowEvent.hpp>
  38 #include <com/sun/star/awt/XMouseListener.hpp>
  39 #include <com/sun/star/awt/KeyFunction.hpp>
  40 #include <com/sun/star/awt/FocusChangeReason.hpp>
  41 #include <com/sun/star/awt/MouseButton.hpp>
  42 #include <com/sun/star/awt/XFocusListener.hpp>
  43 #include <com/sun/star/awt/XTopWindow.hpp>
  44 #include <com/sun/star/awt/XWindow.hpp>
  45 #include <com/sun/star/awt/PosSize.hpp>
  46 #include <cppuhelper/weak.hxx>
  47 #include <cppuhelper/weakref.hxx>
  48 #include <cppuhelper/interfacecontainer.hxx>
  49
  50 //  "namespaces"
  51
  52 namespace unocontrols{
  53
  54 //  class
  55
  56 class OMRCListenerMultiplexerHelper : public ::com::sun::star::awt::XFocusListener
  57                                     , public ::com::sun::star::awt::XWindowListener
  58                                     , public ::com::sun::star::awt::XKeyListener
  59                                     , public ::com::sun::star::awt::XMouseListener
  60                                     , public ::com::sun::star::awt::XMouseMotionListener
  61                                     , public ::com::sun::star::awt::XPaintListener
  62                                     , public ::com::sun::star::awt::XTopWindowListener
  63                                     , public ::cppu::OWeakObject
  64 {
  65
  66 //  public methods
  67
  68 public:
  69
  70     //  construct/destruct
  71
  72     /**_______________________________________________________________________________________________________
  73         @short      constructor
  74         @descr      Create a Multiplexer of XWindowEvents.
  75         @param      rControl    The control. All listeners think that this is the original broadcaster.
  76         @param      rPeer       The peer from which the original events are dispatched. Null is allowed.
  77     */
  78
  79     OMRCListenerMultiplexerHelper(  const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xControl    ,
  80                                     const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer       );
  81
  82     /**_______________________________________________________________________________________________________
  83         @short      copy-constructor
  84         @descr
  85         @param      rCopyInstance   C++-Reference to instance to make copy from.
  86     */
  87
  88     OMRCListenerMultiplexerHelper( const OMRCListenerMultiplexerHelper& aCopyInstance );
  89
  90     /**_______________________________________________________________________________________________________
  91         @short      destructor
  92     */
  93
  94     virtual ~OMRCListenerMultiplexerHelper();
  95
  96     //  XInterface
  97
  98     /**_______________________________________________________________________________________________________
  99         @short      give answer, if interface is supported
 100         @descr      The interfaces are searched by type.
 101
 102         @seealso    XInterface
 103
 104         @param      "rType" is the type of searched interface.
 105
 106         @return     Any     information about found interface
 107
 108         @onerror    A RuntimeException is thrown.
 109     */
 110
 111     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType )
 112         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 113
 114     /**_______________________________________________________________________________________________________
 115         @short      increment refcount
 116         @seealso    XInterface
 117         @seealso    release()
 118         @onerror    A RuntimeException is thrown.
 119     */
 120
 121     virtual void SAL_CALL acquire() throw() SAL_OVERRIDE;
 122
 123     /**_______________________________________________________________________________________________________
 124         @short      decrement refcount
 125         @seealso    XInterface
 126         @seealso    acquire()
 127         @onerror    A RuntimeException is thrown.
 128     */
 129
 130     virtual void SAL_CALL release() throw() SAL_OVERRIDE;
 131
 132     //  operator
 133
 134     /**_______________________________________________________________________________________________________
 135     */
 136
 137     operator ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >() const { return ((OWeakObject*)this);}
 138
 139     /**_______________________________________________________________________________________________________
 140     */
 141
 142     OMRCListenerMultiplexerHelper& operator= ( const OMRCListenerMultiplexerHelper& aCopyInstance );
 143
 144     //  container methods
 145
 146     /**_______________________________________________________________________________________________________
 147         @short      Remove all listeners from the previous set peer and add the needed listeners to rPeer.
 148         @param      rPeer       The peer from which the original events are dispatched. Null is allowed.
 149     */
 150
 151     void setPeer( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer );
 152
 153     /**_______________________________________________________________________________________________________
 154         @short      Remove all listeners and send a disposing message.
 155     */
 156
 157     void disposeAndClear();
 158
 159     /**_______________________________________________________________________________________________________
 160         @short      Add the specified listener to the source.
 161     */
 162
 163     void advise(    const   ::com::sun::star::uno::Type&                              aType       ,
 164                     const   ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >&  xListener   );
 165
 166     /**_______________________________________________________________________________________________________
 167         @short      Remove the specified listener from the source.
 168     */
 169
 170     void unadvise(  const   ::com::sun::star::uno::Type&                              aType       ,
 171                     const   ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >&  xListener   );
 172
 173     //  XEventListener
 174
 175     /**_______________________________________________________________________________________________________
 176     */
 177
 178     virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& aSource)
 179         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 180
 181     //  XFocusListener
 182
 183     /**_______________________________________________________________________________________________________
 184     */
 185
 186     virtual void SAL_CALL focusGained(const ::com::sun::star::awt::FocusEvent& aEvent )
 187         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 188
 189     /**_______________________________________________________________________________________________________
 190     */
 191
 192     virtual void SAL_CALL focusLost(const ::com::sun::star::awt::FocusEvent& aEvent )
 193         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 194
 195     //  XWindowListener
 196
 197     /**_______________________________________________________________________________________________________
 198     */
 199
 200     virtual void SAL_CALL windowResized(const ::com::sun::star::awt::WindowEvent& aEvent )
 201         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 202
 203     /**_______________________________________________________________________________________________________
 204     */
 205
 206     virtual void SAL_CALL windowMoved(const ::com::sun::star::awt::WindowEvent& aEvent )
 207         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 208
 209     /**_______________________________________________________________________________________________________
 210     */
 211
 212     virtual void SAL_CALL windowShown(const ::com::sun::star::lang::EventObject& aEvent )
 213         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 214
 215     /**_______________________________________________________________________________________________________
 216     */
 217
 218     virtual void SAL_CALL windowHidden(const ::com::sun::star::lang::EventObject& aEvent )
 219         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 220
 221     //  XKeyListener
 222
 223     /**_______________________________________________________________________________________________________
 224     */
 225
 226     virtual void SAL_CALL keyPressed( const ::com::sun::star::awt::KeyEvent& aEvent )
 227         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 228
 229     /**_______________________________________________________________________________________________________
 230     */
 231
 232     virtual void SAL_CALL keyReleased( const ::com::sun::star::awt::KeyEvent& aEvent )
 233         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 234
 235     //  XMouseListener
 236
 237     /**_______________________________________________________________________________________________________
 238     */
 239
 240     virtual void SAL_CALL mousePressed(const ::com::sun::star::awt::MouseEvent& aEvent )
 241         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 242
 243     /**_______________________________________________________________________________________________________
 244     */
 245
 246     virtual void SAL_CALL mouseReleased(const ::com::sun::star::awt::MouseEvent& aEvent )
 247         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 248
 249     /**_______________________________________________________________________________________________________
 250     */
 251
 252     virtual void SAL_CALL mouseEntered(const ::com::sun::star::awt::MouseEvent& aEvent )
 253         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 254
 255     /**_______________________________________________________________________________________________________
 256     */
 257
 258     virtual void SAL_CALL mouseExited(const ::com::sun::star::awt::MouseEvent& aEvent )
 259         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 260
 261     //  XMouseMotionListener
 262
 263     /**_______________________________________________________________________________________________________
 264     */
 265
 266     virtual void SAL_CALL mouseDragged(const ::com::sun::star::awt::MouseEvent& aEvent )
 267         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 268
 269     /**_______________________________________________________________________________________________________
 270     */
 271
 272     virtual void SAL_CALL mouseMoved(const ::com::sun::star::awt::MouseEvent& aEvent )
 273         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 274
 275     //  XPaintListener
 276
 277     /**_______________________________________________________________________________________________________
 278     */
 279
 280     virtual void SAL_CALL windowPaint(const ::com::sun::star::awt::PaintEvent& aEvent )
 281         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 282
 283     //  XTopWindowListener
 284
 285     /**_______________________________________________________________________________________________________
 286     */
 287
 288     virtual void SAL_CALL windowOpened( const ::com::sun::star::lang::EventObject& aEvent )
 289         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 290
 291     /**_______________________________________________________________________________________________________
 292     */
 293
 294     virtual void SAL_CALL windowClosing( const ::com::sun::star::lang::EventObject& aEvent )
 295         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 296
 297     /**_______________________________________________________________________________________________________
 298     */
 299
 300     virtual void SAL_CALL windowClosed( const ::com::sun::star::lang::EventObject& aEvent )
 301         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 302
 303     /**_______________________________________________________________________________________________________
 304     */
 305
 306     virtual void SAL_CALL windowMinimized( const ::com::sun::star::lang::EventObject& aEvent )
 307         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 308
 309     /**_______________________________________________________________________________________________________
 310     */
 311
 312     virtual void SAL_CALL windowNormalized( const ::com::sun::star::lang::EventObject& aEvent )
 313         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 314
 315     /**_______________________________________________________________________________________________________
 316     */
 317
 318     virtual void SAL_CALL windowActivated( const ::com::sun::star::lang::EventObject& aEvent )
 319         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 320
 321     /**_______________________________________________________________________________________________________
 322     */
 323
 324     virtual void SAL_CALL windowDeactivated( const ::com::sun::star::lang::EventObject& aEvent )
 325         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 326
 327 //  protected methods
 328
 329 protected:
 330
 331     /**_______________________________________________________________________________________________________
 332         @short      Remove the listener from the peer.
 333         @param      xPeer   The peer from which the listener is removed.
 334         @param      rType   The listener type, which specify the type of the listener.
 335     */
 336
 337     void impl_adviseToPeer( const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer   ,
 338                             const   ::com::sun::star::uno::Type&                          aType   );
 339
 340     /**_______________________________________________________________________________________________________
 341         @short      Add the listener to the peer.
 342         @param      xPeer   The peer to which the listener is added.
 343         @param      rType   The listener type, which specify the type of the listener.
 344     */
 345
 346     void impl_unadviseFromPeer( const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer   ,
 347                                 const   ::com::sun::star::uno::Type&                          aType   );
 348
 349 //  private variables
 350
 351 private:
 352
 353     ::osl::Mutex                                m_aMutex;
 354     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >      m_xPeer;   /// The source of the events. Normally this is the peer object.
 355     ::com::sun::star::uno::WeakReference< ::com::sun::star::awt::XWindow >  m_xControl;
 356     ::cppu::OMultiTypeInterfaceContainerHelper  m_aListenerHolder;
 357
 358 };  // class OMRCListenerMultiplexerHelper
 359
 360 }   // namespace unocontrols
 361
 362 #endif // INCLUDED_UNOCONTROLS_INC_MULTIPLEXER_HXX
 363
 364 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */