summaryrefslogtreecommitdiffstats
path: root/UnoControls/inc/multiplexer.hxx
blob: 58bd1563fb0a34f82c862b0477a272759be1d91e (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#pragma once

#include <com/sun/star/awt/XKeyListener.hpp>
#include <com/sun/star/awt/XPaintListener.hpp>
#include <com/sun/star/awt/XMouseMotionListener.hpp>
#include <com/sun/star/awt/XWindowListener.hpp>
#include <com/sun/star/awt/XTopWindowListener.hpp>
#include <com/sun/star/awt/XMouseListener.hpp>
#include <com/sun/star/awt/XFocusListener.hpp>
#include <cppuhelper/weak.hxx>
#include <cppuhelper/weakref.hxx>
#include <comphelper/multicontainer2.hxx>

namespace com::sun::star::awt { class XWindow; }
namespace com::sun::star::awt { struct KeyEvent; }
namespace com::sun::star::awt { struct MouseEvent; }
namespace com::sun::star::awt { struct PaintEvent; }
namespace com::sun::star::awt { struct WindowEvent; }

namespace unocontrols {

class OMRCListenerMultiplexerHelper final : 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:

    /**
        @short      constructor
        @descr      Create a Multiplexer of XWindowEvents.
        @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.
    */

    OMRCListenerMultiplexerHelper(  const   css::uno::Reference< css::awt::XWindow >& xControl    ,
                                    const   css::uno::Reference< css::awt::XWindow >& xPeer       );

    /**
        @short      copy-constructor
        @descr
        @param      rCopyInstance   C++-Reference to instance to make copy from.
    */

    OMRCListenerMultiplexerHelper( const OMRCListenerMultiplexerHelper& aCopyInstance );

    virtual ~OMRCListenerMultiplexerHelper() override;

    //  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 ) override;

    /**
        @short      increment refcount
        @seealso    XInterface
        @seealso    release()
        @onerror    A RuntimeException is thrown.
    */

    virtual void SAL_CALL acquire() noexcept override;

    /**
        @short      decrement refcount
        @seealso    XInterface
        @seealso    acquire()
        @onerror    A RuntimeException is thrown.
    */

    virtual void SAL_CALL release() noexcept override;

    OMRCListenerMultiplexerHelper& operator= ( const OMRCListenerMultiplexerHelper& aCopyInstance );

    //  container methods

    /**
        @short      Remove all listeners from the previous set peer and add the needed listeners to rPeer.
        @param      rPeer       The peer from which the original events are dispatched. Null is allowed.
    */

    void setPeer( const css::uno::Reference< css::awt::XWindow >& xPeer );

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

    void disposeAndClear();

    /**
        @short      Add the specified listener to the source.
    */

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

    /**
        @short      Remove the specified listener from the source.
    */

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

    //  XEventListener

    virtual void SAL_CALL disposing(const css::lang::EventObject& aSource) override;

    //  XFocusListener

    virtual void SAL_CALL focusGained(const css::awt::FocusEvent& aEvent ) override;

    virtual void SAL_CALL focusLost(const css::awt::FocusEvent& aEvent ) override;

    //  XWindowListener

    virtual void SAL_CALL windowResized(const css::awt::WindowEvent& aEvent ) override;

    virtual void SAL_CALL windowMoved(const css::awt::WindowEvent& aEvent ) override;

    virtual void SAL_CALL windowShown(const css::lang::EventObject& aEvent ) override;

    virtual void SAL_CALL windowHidden(const css::lang::EventObject& aEvent ) override;

    //  XKeyListener

    virtual void SAL_CALL keyPressed( const css::awt::KeyEvent& aEvent ) override;

    virtual void SAL_CALL keyReleased( const css::awt::KeyEvent& aEvent ) override;

    //  XMouseListener

    virtual void SAL_CALL mousePressed(const css::awt::MouseEvent& aEvent ) override;

    virtual void SAL_CALL mouseReleased(const css::awt::MouseEvent& aEvent ) override;

    virtual void SAL_CALL mouseEntered(const css::awt::MouseEvent& aEvent ) override;

    virtual void SAL_CALL mouseExited(const css::awt::MouseEvent& aEvent ) override;

    //  XMouseMotionListener

    virtual void SAL_CALL mouseDragged(const css::awt::MouseEvent& aEvent ) override;

    virtual void SAL_CALL mouseMoved(const css::awt::MouseEvent& aEvent ) override;

    //  XPaintListener

    virtual void SAL_CALL windowPaint(const css::awt::PaintEvent& aEvent ) override;

    //  XTopWindowListener

    virtual void SAL_CALL windowOpened( const css::lang::EventObject& aEvent ) override;

    virtual void SAL_CALL windowClosing( const css::lang::EventObject& aEvent ) override;

    virtual void SAL_CALL windowClosed( const css::lang::EventObject& aEvent ) override;

    virtual void SAL_CALL windowMinimized( const css::lang::EventObject& aEvent ) override;

    virtual void SAL_CALL windowNormalized( const css::lang::EventObject& aEvent ) override;

    virtual void SAL_CALL windowActivated( const css::lang::EventObject& aEvent ) override;

    virtual void SAL_CALL windowDeactivated( const css::lang::EventObject& aEvent ) override;

private:

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

    void impl_adviseToPeer( const   css::uno::Reference< css::awt::XWindow >& xPeer   ,
                            const   css::uno::Type&                          aType   );

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

    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;
    comphelper::OMultiTypeInterfaceContainerHelper2  m_aListenerHolder;

};

}


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