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 _UNOCONTROLS_MULTIPLEXER_HXX
  21 #define _UNOCONTROLS_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/interfacecontainer.hxx>
  48
  49 //____________________________________________________________________________________________________________
  50 //  "namespaces"
  51 //____________________________________________________________________________________________________________
  52
  53 namespace unocontrols{
  54
  55 //____________________________________________________________________________________________________________
  56 //  class
  57 //____________________________________________________________________________________________________________
  58
  59 class OMRCListenerMultiplexerHelper : public ::com::sun::star::awt::XFocusListener
  60                                     , public ::com::sun::star::awt::XWindowListener
  61                                     , public ::com::sun::star::awt::XKeyListener
  62                                     , public ::com::sun::star::awt::XMouseListener
  63                                     , public ::com::sun::star::awt::XMouseMotionListener
  64                                     , public ::com::sun::star::awt::XPaintListener
  65                                     , public ::com::sun::star::awt::XTopWindowListener
  66                                     , public ::cppu::OWeakObject
  67 {
  68
  69 //____________________________________________________________________________________________________________
  70 //  public methods
  71 //____________________________________________________________________________________________________________
  72
  73 public:
  74
  75     //________________________________________________________________________________________________________
  76     //  construct/destruct
  77     //________________________________________________________________________________________________________
  78
  79     /**_______________________________________________________________________________________________________
  80         @short      constructor
  81         @descr      Create a Multiplexer of XWindowEvents.
  82
  83         @seealso    -
  84
  85         @param      rControl    The control. All listeners think that this is the original broadcaster.
  86         @param      rPeer       The peer from which the original events are dispatched. Null is allowed.
  87
  88         @return     -
  89
  90         @onerror    -
  91     */
  92
  93     OMRCListenerMultiplexerHelper(  const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xControl    ,
  94                                     const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer       );
  95
  96     /**_______________________________________________________________________________________________________
  97         @short      copy-constructor
  98         @descr
  99
 100         @seealso    -
 101
 102         @param      rCopyInstance   C++-Reference to instance to make copy from.
 103
 104         @return     -
 105
 106         @onerror    -
 107     */
 108
 109     OMRCListenerMultiplexerHelper( const OMRCListenerMultiplexerHelper& aCopyInstance );
 110
 111     /**_______________________________________________________________________________________________________
 112         @short      destructor
 113         @descr      -
 114
 115         @seealso    -
 116
 117         @param      -
 118
 119         @return     -
 120
 121         @onerror    -
 122     */
 123
 124     ~OMRCListenerMultiplexerHelper();
 125
 126     //________________________________________________________________________________________________________
 127     //  XInterface
 128     //________________________________________________________________________________________________________
 129
 130     /**_______________________________________________________________________________________________________
 131         @short      give answer, if interface is supported
 132         @descr      The interfaces are searched by type.
 133
 134         @seealso    XInterface
 135
 136         @param      "rType" is the type of searched interface.
 137
 138         @return     Any     information about found interface
 139
 140         @onerror    A RuntimeException is thrown.
 141     */
 142
 143     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType )
 144         throw( ::com::sun::star::uno::RuntimeException );
 145
 146     /**_______________________________________________________________________________________________________
 147         @short      increment refcount
 148         @descr      -
 149
 150         @seealso    XInterface
 151         @seealso    release()
 152
 153         @param      -
 154
 155         @return     -
 156
 157         @onerror    A RuntimeException is thrown.
 158     */
 159
 160     virtual void SAL_CALL acquire() throw();
 161
 162     /**_______________________________________________________________________________________________________
 163         @short      decrement refcount
 164         @descr      -
 165
 166         @seealso    XInterface
 167         @seealso    acquire()
 168
 169         @param      -
 170
 171         @return     -
 172
 173         @onerror    A RuntimeException is thrown.
 174     */
 175
 176     virtual void SAL_CALL release() throw();
 177
 178     //________________________________________________________________________________________________________
 179     //  operator
 180     //________________________________________________________________________________________________________
 181
 182     /**_______________________________________________________________________________________________________
 183         @short      -
 184         @descr      -
 185
 186         @seealso    -
 187
 188         @param      -
 189
 190         @return     -
 191
 192         @onerror    -
 193     */
 194
 195     operator ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >() const;
 196
 197     /**_______________________________________________________________________________________________________
 198         @short      -
 199         @descr      -
 200
 201         @seealso    -
 202
 203         @param      -
 204
 205         @return     -
 206
 207         @onerror    -
 208     */
 209
 210     OMRCListenerMultiplexerHelper& operator= ( const OMRCListenerMultiplexerHelper& aCopyInstance );
 211
 212     //________________________________________________________________________________________________________
 213     //  container methods
 214     //________________________________________________________________________________________________________
 215
 216     /**_______________________________________________________________________________________________________
 217         @short      Remove all listeners from the previous set peer and add the needed listeners to rPeer.
 218         @descr      -
 219
 220         @seealso    -
 221
 222         @param      rPeer       The peer from which the original events are dispatched. Null is allowed.
 223
 224         @return     -
 225
 226         @onerror    -
 227     */
 228
 229     void setPeer( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer );
 230
 231     /**_______________________________________________________________________________________________________
 232         @short      Remove all listeners and send a disposing message.
 233         @descr      -
 234
 235         @seealso    -
 236
 237         @param      -
 238
 239         @return     -
 240
 241         @onerror    -
 242     */
 243
 244     void disposeAndClear();
 245
 246     /**_______________________________________________________________________________________________________
 247         @short      Add the specified listener to the source.
 248         @descr      -
 249
 250         @seealso    -
 251
 252         @param      -
 253
 254         @return     -
 255
 256         @onerror    -
 257     */
 258
 259     void advise(    const   ::com::sun::star::uno::Type&                              aType       ,
 260                     const   ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >&  xListener   );
 261
 262     /**_______________________________________________________________________________________________________
 263         @short      Remove the specified listener from the source.
 264         @descr      -
 265
 266         @seealso    -
 267
 268         @param      -
 269
 270         @return     -
 271
 272         @onerror    -
 273     */
 274
 275     void unadvise(  const   ::com::sun::star::uno::Type&                              aType       ,
 276                     const   ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >&  xListener   );
 277
 278     //________________________________________________________________________________________________________
 279     //  XEventListener
 280     //________________________________________________________________________________________________________
 281
 282     /**_______________________________________________________________________________________________________
 283         @short      -
 284         @descr      -
 285
 286         @seealso    -
 287         @seealso    -
 288
 289         @param      -
 290
 291         @return     -
 292
 293         @onerror    -
 294     */
 295
 296     virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& aSource)
 297         throw( ::com::sun::star::uno::RuntimeException ) ;
 298
 299     //________________________________________________________________________________________________________
 300     //  XFocusListener
 301     //________________________________________________________________________________________________________
 302
 303     /**_______________________________________________________________________________________________________
 304         @short      -
 305         @descr      -
 306
 307         @seealso    -
 308         @seealso    -
 309
 310         @param      -
 311
 312         @return     -
 313
 314         @onerror    -
 315     */
 316
 317     virtual void SAL_CALL focusGained(const ::com::sun::star::awt::FocusEvent& aEvent )
 318         throw( ::com::sun::star::uno::RuntimeException ) ;
 319
 320     /**_______________________________________________________________________________________________________
 321         @short      -
 322         @descr      -
 323
 324         @seealso    -
 325         @seealso    -
 326
 327         @param      -
 328
 329         @return     -
 330
 331         @onerror    -
 332     */
 333
 334     virtual void SAL_CALL focusLost(const ::com::sun::star::awt::FocusEvent& aEvent )
 335         throw( ::com::sun::star::uno::RuntimeException ) ;
 336
 337     //________________________________________________________________________________________________________
 338     //  XWindowListener
 339     //________________________________________________________________________________________________________
 340
 341     /**_______________________________________________________________________________________________________
 342         @short      -
 343         @descr      -
 344
 345         @seealso    -
 346         @seealso    -
 347
 348         @param      -
 349
 350         @return     -
 351
 352         @onerror    -
 353     */
 354
 355     virtual void SAL_CALL windowResized(const ::com::sun::star::awt::WindowEvent& aEvent )
 356         throw( ::com::sun::star::uno::RuntimeException ) ;
 357
 358     /**_______________________________________________________________________________________________________
 359         @short      -
 360         @descr      -
 361
 362         @seealso    -
 363         @seealso    -
 364
 365         @param      -
 366
 367         @return     -
 368
 369         @onerror    -
 370     */
 371
 372     virtual void SAL_CALL windowMoved(const ::com::sun::star::awt::WindowEvent& aEvent )
 373         throw( ::com::sun::star::uno::RuntimeException ) ;
 374
 375     /**_______________________________________________________________________________________________________
 376         @short      -
 377         @descr      -
 378
 379         @seealso    -
 380         @seealso    -
 381
 382         @param      -
 383
 384         @return     -
 385
 386         @onerror    -
 387     */
 388
 389     virtual void SAL_CALL windowShown(const ::com::sun::star::lang::EventObject& aEvent )
 390         throw( ::com::sun::star::uno::RuntimeException ) ;
 391
 392     /**_______________________________________________________________________________________________________
 393         @short      -
 394         @descr      -
 395
 396         @seealso    -
 397         @seealso    -
 398
 399         @param      -
 400
 401         @return     -
 402
 403         @onerror    -
 404     */
 405
 406     virtual void SAL_CALL windowHidden(const ::com::sun::star::lang::EventObject& aEvent )
 407         throw( ::com::sun::star::uno::RuntimeException ) ;
 408
 409     //________________________________________________________________________________________________________
 410     //  XKeyListener
 411     //________________________________________________________________________________________________________
 412
 413     /**_______________________________________________________________________________________________________
 414         @short      -
 415         @descr      -
 416
 417         @seealso    -
 418         @seealso    -
 419
 420         @param      -
 421
 422         @return     -
 423
 424         @onerror    -
 425     */
 426
 427     virtual void SAL_CALL keyPressed( const ::com::sun::star::awt::KeyEvent& aEvent )
 428         throw( ::com::sun::star::uno::RuntimeException ) ;
 429
 430     /**_______________________________________________________________________________________________________
 431         @short      -
 432         @descr      -
 433
 434         @seealso    -
 435         @seealso    -
 436
 437         @param      -
 438
 439         @return     -
 440
 441         @onerror    -
 442     */
 443
 444     virtual void SAL_CALL keyReleased( const ::com::sun::star::awt::KeyEvent& aEvent )
 445         throw( ::com::sun::star::uno::RuntimeException ) ;
 446
 447     //________________________________________________________________________________________________________
 448     //  XMouseListener
 449     //________________________________________________________________________________________________________
 450
 451     /**_______________________________________________________________________________________________________
 452         @short      -
 453         @descr      -
 454
 455         @seealso    -
 456         @seealso    -
 457
 458         @param      -
 459
 460         @return     -
 461
 462         @onerror    -
 463     */
 464
 465     virtual void SAL_CALL mousePressed(const ::com::sun::star::awt::MouseEvent& aEvent )
 466         throw( ::com::sun::star::uno::RuntimeException ) ;
 467
 468     /**_______________________________________________________________________________________________________
 469         @short      -
 470         @descr      -
 471
 472         @seealso    -
 473         @seealso    -
 474
 475         @param      -
 476
 477         @return     -
 478
 479         @onerror    -
 480     */
 481
 482     virtual void SAL_CALL mouseReleased(const ::com::sun::star::awt::MouseEvent& aEvent )
 483         throw( ::com::sun::star::uno::RuntimeException ) ;
 484
 485     /**_______________________________________________________________________________________________________
 486         @short      -
 487         @descr      -
 488
 489         @seealso    -
 490         @seealso    -
 491
 492         @param      -
 493
 494         @return     -
 495
 496         @onerror    -
 497     */
 498
 499     virtual void SAL_CALL mouseEntered(const ::com::sun::star::awt::MouseEvent& aEvent )
 500         throw( ::com::sun::star::uno::RuntimeException ) ;
 501
 502     /**_______________________________________________________________________________________________________
 503         @short      -
 504         @descr      -
 505
 506         @seealso    -
 507         @seealso    -
 508
 509         @param      -
 510
 511         @return     -
 512
 513         @onerror    -
 514     */
 515
 516     virtual void SAL_CALL mouseExited(const ::com::sun::star::awt::MouseEvent& aEvent )
 517         throw( ::com::sun::star::uno::RuntimeException ) ;
 518
 519     //________________________________________________________________________________________________________
 520     //  XMouseMotionListener
 521     //________________________________________________________________________________________________________
 522
 523     /**_______________________________________________________________________________________________________
 524         @short      -
 525         @descr      -
 526
 527         @seealso    -
 528         @seealso    -
 529
 530         @param      -
 531
 532         @return     -
 533
 534         @onerror    -
 535     */
 536
 537     virtual void SAL_CALL mouseDragged(const ::com::sun::star::awt::MouseEvent& aEvent )
 538         throw( ::com::sun::star::uno::RuntimeException ) ;
 539
 540     /**_______________________________________________________________________________________________________
 541         @short      -
 542         @descr      -
 543
 544         @seealso    -
 545         @seealso    -
 546
 547         @param      -
 548
 549         @return     -
 550
 551         @onerror    -
 552     */
 553
 554     virtual void SAL_CALL mouseMoved(const ::com::sun::star::awt::MouseEvent& aEvent )
 555         throw( ::com::sun::star::uno::RuntimeException ) ;
 556
 557     //________________________________________________________________________________________________________
 558     //  XPaintListener
 559     //________________________________________________________________________________________________________
 560
 561     /**_______________________________________________________________________________________________________
 562         @short      -
 563         @descr      -
 564
 565         @seealso    -
 566         @seealso    -
 567
 568         @param      -
 569
 570         @return     -
 571
 572         @onerror    -
 573     */
 574
 575     virtual void SAL_CALL windowPaint(const ::com::sun::star::awt::PaintEvent& aEvent )
 576         throw( ::com::sun::star::uno::RuntimeException ) ;
 577
 578     //________________________________________________________________________________________________________
 579     //  XTopWindowListener
 580     //________________________________________________________________________________________________________
 581
 582     /**_______________________________________________________________________________________________________
 583         @short      -
 584         @descr      -
 585
 586         @seealso    -
 587         @seealso    -
 588
 589         @param      -
 590
 591         @return     -
 592
 593         @onerror    -
 594     */
 595
 596     virtual void SAL_CALL windowOpened( const ::com::sun::star::lang::EventObject& aEvent )
 597         throw( ::com::sun::star::uno::RuntimeException ) ;
 598
 599     /**_______________________________________________________________________________________________________
 600         @short      -
 601         @descr      -
 602
 603         @seealso    -
 604         @seealso    -
 605
 606         @param      -
 607
 608         @return     -
 609
 610         @onerror    -
 611     */
 612
 613     virtual void SAL_CALL windowClosing( const ::com::sun::star::lang::EventObject& aEvent )
 614         throw( ::com::sun::star::uno::RuntimeException ) ;
 615
 616     /**_______________________________________________________________________________________________________
 617         @short      -
 618         @descr      -
 619
 620         @seealso    -
 621         @seealso    -
 622
 623         @param      -
 624
 625         @return     -
 626
 627         @onerror    -
 628     */
 629
 630     virtual void SAL_CALL windowClosed( const ::com::sun::star::lang::EventObject& aEvent )
 631         throw( ::com::sun::star::uno::RuntimeException ) ;
 632
 633     /**_______________________________________________________________________________________________________
 634         @short      -
 635         @descr      -
 636
 637         @seealso    -
 638         @seealso    -
 639
 640         @param      -
 641
 642         @return     -
 643
 644         @onerror    -
 645     */
 646
 647     virtual void SAL_CALL windowMinimized( const ::com::sun::star::lang::EventObject& aEvent )
 648         throw( ::com::sun::star::uno::RuntimeException ) ;
 649
 650     /**_______________________________________________________________________________________________________
 651         @short      -
 652         @descr      -
 653
 654         @seealso    -
 655         @seealso    -
 656
 657         @param      -
 658
 659         @return     -
 660
 661         @onerror    -
 662     */
 663
 664     virtual void SAL_CALL windowNormalized( const ::com::sun::star::lang::EventObject& aEvent )
 665         throw( ::com::sun::star::uno::RuntimeException ) ;
 666
 667     /**_______________________________________________________________________________________________________
 668         @short      -
 669         @descr      -
 670
 671         @seealso    -
 672         @seealso    -
 673
 674         @param      -
 675
 676         @return     -
 677
 678         @onerror    -
 679     */
 680
 681     virtual void SAL_CALL windowActivated( const ::com::sun::star::lang::EventObject& aEvent )
 682         throw( ::com::sun::star::uno::RuntimeException ) ;
 683
 684     /**_______________________________________________________________________________________________________
 685         @short      -
 686         @descr      -
 687
 688         @seealso    -
 689         @seealso    -
 690
 691         @param      -
 692
 693         @return     -
 694
 695         @onerror    -
 696     */
 697
 698     virtual void SAL_CALL windowDeactivated( const ::com::sun::star::lang::EventObject& aEvent )
 699         throw( ::com::sun::star::uno::RuntimeException ) ;
 700
 701 //____________________________________________________________________________________________________________
 702 //  protected methods
 703 //____________________________________________________________________________________________________________
 704
 705 protected:
 706
 707     /**_______________________________________________________________________________________________________
 708         @short      Remove the listener from the peer.
 709         @descr      -
 710
 711         @seealso    -
 712
 713         @param      xPeer   The peer from which the listener is removed.
 714         @param      rType   The listener type, which specify the type of the listener.
 715
 716         @return     -
 717
 718         @onerror    -
 719     */
 720
 721     void impl_adviseToPeer( const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer   ,
 722                             const   ::com::sun::star::uno::Type&                          aType   );
 723
 724     /**_______________________________________________________________________________________________________
 725         @short      Add the listener to the peer.
 726         @descr      -
 727
 728         @seealso    -
 729
 730         @param      xPeer   The peer to which the listener is added.
 731         @param      rType   The listener type, which specify the type of the listener.
 732
 733         @return     -
 734
 735         @onerror    -
 736     */
 737
 738     void impl_unadviseFromPeer( const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >& xPeer   ,
 739                                 const   ::com::sun::star::uno::Type&                          aType   );
 740
 741 //____________________________________________________________________________________________________________
 742 //  private variables
 743 //____________________________________________________________________________________________________________
 744
 745 private:
 746
 747     ::osl::Mutex                                m_aMutex            ;
 748     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >      m_xPeer             ;   /// The source of the events. Normally this is the peer object.
 749     ::com::sun::star::uno::WeakReference< ::com::sun::star::awt::XWindow >  m_xControl          ;
 750     ::cppu::OMultiTypeInterfaceContainerHelper  m_aListenerHolder   ;
 751
 752 };  // class OMRCListenerMultiplexerHelper
 753
 754 }   // namespace unocontrols
 755
 756 #endif  // ifndef _UNOCONTROLS_MULTIPLEXER_HXX
 757
 758 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */