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

#ifndef _UNOCONTROLS_MULTIPLEXER_HXX
#define _UNOCONTROLS_MULTIPLEXER_HXX

//____________________________________________________________________________________________________________
//	includes of other projects
//____________________________________________________________________________________________________________

#include <com/sun/star/awt/XKeyListener.hpp>
#include <com/sun/star/awt/XPaintListener.hpp>
#include <com/sun/star/awt/KeyEvent.hpp>
#include <com/sun/star/awt/KeyModifier.hpp>
#include <com/sun/star/awt/XMouseMotionListener.hpp>
#include <com/sun/star/awt/FocusEvent.hpp>
#include <com/sun/star/awt/XWindowListener.hpp>
#include <com/sun/star/awt/XActivateListener.hpp>
#include <com/sun/star/awt/MouseEvent.hpp>
#include <com/sun/star/awt/XTopWindowListener.hpp>
#include <com/sun/star/awt/PaintEvent.hpp>
#include <com/sun/star/awt/InputEvent.hpp>
#include <com/sun/star/awt/KeyGroup.hpp>
#include <com/sun/star/awt/Key.hpp>
#include <com/sun/star/awt/WindowEvent.hpp>
#include <com/sun/star/awt/XMouseListener.hpp>
#include <com/sun/star/awt/KeyFunction.hpp>
#include <com/sun/star/awt/FocusChangeReason.hpp>
#include <com/sun/star/awt/MouseButton.hpp>
#include <com/sun/star/awt/XFocusListener.hpp>
#include <com/sun/star/awt/XTopWindow.hpp>
#include <com/sun/star/awt/XWindow.hpp>
#include <com/sun/star/awt/PosSize.hpp>
#include <cppuhelper/weak.hxx>
#include <cppuhelper/interfacecontainer.hxx>
//____________________________________________________________________________________________________________
//	includes of my own project
//____________________________________________________________________________________________________________

//____________________________________________________________________________________________________________
//	"namespaces"
//____________________________________________________________________________________________________________

namespace unocontrols{

#define CSS_UNO     ::com::sun::star::uno
#define CSS_AWT     ::com::sun::star::awt
#define CSS_LANG    ::com::sun::star::lang

//____________________________________________________________________________________________________________
//	class
//____________________________________________________________________________________________________________

class OMRCListenerMultiplexerHelper	: public CSS_AWT::XFocusListener
                                    , public CSS_AWT::XWindowListener
                                    , public CSS_AWT::XKeyListener
                                    , public CSS_AWT::XMouseListener
                                    , public CSS_AWT::XMouseMotionListener
                                    , public CSS_AWT::XPaintListener
                                    , public CSS_AWT::XTopWindowListener
                                    , public ::cppu::OWeakObject
{

//____________________________________________________________________________________________________________
//	public methods
//____________________________________________________________________________________________________________

public:

    //________________________________________________________________________________________________________
    //	construct/destruct
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		constructor
        @descr		Create a Multiplexer of XWindowEvents.

        @seealso	-

        @param		rControl	The control. All listeners think that this is the original broadcaster.
        @param		rPeer		The peer from which the original events are dispatched. Null is allowed.

        @return		-

        @onerror	-
    */

    OMRCListenerMultiplexerHelper(	const	CSS_UNO::Reference< CSS_AWT::XWindow >&	xControl	,
                                    const	CSS_UNO::Reference< CSS_AWT::XWindow >&	xPeer		);

    /**_______________________________________________________________________________________________________
        @short		copy-constructor
        @descr

        @seealso	-

        @param		rCopyInstance	C++-Reference to instance to make copy from.

        @return		-

        @onerror	-
    */

    OMRCListenerMultiplexerHelper( const OMRCListenerMultiplexerHelper& aCopyInstance );

    /**_______________________________________________________________________________________________________
        @short		destructor
        @descr		-

        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    ~OMRCListenerMultiplexerHelper();

    //________________________________________________________________________________________________________
    //	XInterface
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		give answer, if interface is supported
        @descr		The interfaces are searched by type.

        @seealso	XInterface

        @param      "rType" is the type of searched interface.

        @return		Any		information about found interface

        @onerror	A RuntimeException is thrown.
    */

    virtual CSS_UNO::Any SAL_CALL queryInterface( const CSS_UNO::Type& aType )
        throw( CSS_UNO::RuntimeException );

    /**_______________________________________________________________________________________________________
        @short		increment refcount
        @descr		-

        @seealso	XInterface
        @seealso	release()

        @param		-

        @return		-

        @onerror	A RuntimeException is thrown.
    */

    virtual void SAL_CALL acquire() throw();

    /**_______________________________________________________________________________________________________
        @short		decrement refcount
        @descr		-

        @seealso	XInterface
        @seealso	acquire()

        @param		-

        @return		-

        @onerror	A RuntimeException is thrown.
    */

    virtual void SAL_CALL release() throw();

    //________________________________________________________________________________________________________
    //	operator
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    operator CSS_UNO::Reference< CSS_UNO::XInterface >() const;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    OMRCListenerMultiplexerHelper& operator= ( const OMRCListenerMultiplexerHelper& aCopyInstance );

    //________________________________________________________________________________________________________
    //	container methods
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		Remove all listeners from the previous set peer and add the needed listeners to rPeer.
        @descr		-

        @seealso	-

        @param		rPeer		The peer from which the original events are dispatched. Null is allowed.

        @return		-

        @onerror	-
    */

    void setPeer( const CSS_UNO::Reference< CSS_AWT::XWindow >& xPeer );

    /**_______________________________________________________________________________________________________
        @short		Remove all listeners and send a disposing message.
        @descr		-

        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    void disposeAndClear();

    /**_______________________________________________________________________________________________________
        @short		Add the specified listener to the source.
        @descr		-

        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    void advise(	const	CSS_UNO::Type&                              aType		,
                    const	CSS_UNO::Reference< CSS_UNO::XInterface >&  xListener	);

    /**_______________________________________________________________________________________________________
        @short		Remove the specified listener from the source.
        @descr		-

        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    void unadvise(	const	CSS_UNO::Type&                              aType		,
                    const	CSS_UNO::Reference< CSS_UNO::XInterface >&  xListener	);

    //________________________________________________________________________________________________________
    //	XEventListener
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL disposing(const CSS_LANG::EventObject& aSource)
        throw( CSS_UNO::RuntimeException ) ;

    //________________________________________________________________________________________________________
    //	XFocusListener
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL focusGained(const CSS_AWT::FocusEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL focusLost(const CSS_AWT::FocusEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    //________________________________________________________________________________________________________
    //	XWindowListener
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowResized(const CSS_AWT::WindowEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowMoved(const CSS_AWT::WindowEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowShown(const CSS_LANG::EventObject& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowHidden(const CSS_LANG::EventObject& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    //________________________________________________________________________________________________________
    //	XKeyListener
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL keyPressed( const CSS_AWT::KeyEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL keyReleased( const CSS_AWT::KeyEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    //________________________________________________________________________________________________________
    //	XMouseListener
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL mousePressed(const CSS_AWT::MouseEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL mouseReleased(const CSS_AWT::MouseEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL mouseEntered(const CSS_AWT::MouseEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL mouseExited(const CSS_AWT::MouseEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    //________________________________________________________________________________________________________
    //	XMouseMotionListener
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL mouseDragged(const CSS_AWT::MouseEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL mouseMoved(const CSS_AWT::MouseEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    //________________________________________________________________________________________________________
    //	XPaintListener
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowPaint(const CSS_AWT::PaintEvent& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    //________________________________________________________________________________________________________
    //	XTopWindowListener
    //________________________________________________________________________________________________________

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowOpened( const CSS_LANG::EventObject& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowClosing( const CSS_LANG::EventObject& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowClosed( const CSS_LANG::EventObject& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowMinimized( const CSS_LANG::EventObject& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowNormalized( const CSS_LANG::EventObject& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowActivated( const CSS_LANG::EventObject& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

    /**_______________________________________________________________________________________________________
        @short		-
        @descr		-

        @seealso	-
        @seealso	-

        @param		-

        @return		-

        @onerror	-
    */

    virtual void SAL_CALL windowDeactivated( const CSS_LANG::EventObject& aEvent )
        throw( CSS_UNO::RuntimeException ) ;

//____________________________________________________________________________________________________________
//	protected methods
//____________________________________________________________________________________________________________

protected:

    /**_______________________________________________________________________________________________________
        @short		Remove the listener from the peer.
        @descr		-

        @seealso	-

        @param		xPeer	The peer from which the listener is removed.
        @param		rType	The listener type, which specify the type of the listener.

        @return		-

        @onerror	-
    */

    void impl_adviseToPeer(	const	CSS_UNO::Reference< CSS_AWT::XWindow >&	xPeer	,
                            const	CSS_UNO::Type&		    				aType	);

    /**_______________________________________________________________________________________________________
        @short		Add the listener to the peer.
        @descr		-

        @seealso	-

        @param		xPeer	The peer to which the listener is added.
        @param		rType	The listener type, which specify the type of the listener.

        @return		-

        @onerror	-
    */

    void impl_unadviseFromPeer(	const	CSS_UNO::Reference< CSS_AWT::XWindow >&	xPeer	,
                                const	CSS_UNO::Type&  						aType	);

//____________________________________________________________________________________________________________
//	private variables
//____________________________________________________________________________________________________________

private:

    ::osl::Mutex                                m_aMutex			;
    CSS_UNO::Reference< CSS_AWT::XWindow >      m_xPeer				;	/// The source of the events. Normally this is the peer object.
    CSS_UNO::WeakReference< CSS_AWT::XWindow >  m_xControl			;
    ::cppu::OMultiTypeInterfaceContainerHelper  m_aListenerHolder	;

};	// class OMRCListenerMultiplexerHelper

// The namespace aliases are only used in this header
#undef CSS_UNO
#undef CSS_AWT
#undef CSS_LANG


}	// namespace unocontrols

#endif	// ifndef _UNOCONTROLS_MULTIPLEXER_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */