UnoControls/inc/multiplexer.hxx

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