UnoControls/inc/multiplexer.hxx

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