UnoControls/inc/basecontrol.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <com/sun/star/awt/XPaintListener.hpp>
  23 #include <com/sun/star/awt/XWindowListener.hpp>
  24 #include <com/sun/star/awt/XControl.hpp>
  25 #include <com/sun/star/awt/XWindow.hpp>
  26 #include <com/sun/star/awt/XView.hpp>
  27 #include <com/sun/star/lang/XServiceInfo.hpp>
  28 #include <cppuhelper/compbase.hxx>
  29 #include <cppuhelper/basemutex.hxx>
  30 #include <rtl/ref.hxx>
  31
  32 namespace com::sun::star::uno { class XComponentContext; }
  33 namespace com::sun::star::awt { class XFocusListener; }
  34 namespace com::sun::star::awt { class XMouseListener; }
  35 namespace com::sun::star::awt { class XMouseMotionListener; }
  36 namespace com::sun::star::awt { struct PaintEvent; }
  37 namespace com::sun::star::awt { struct WindowEvent; }
  38 namespace unocontrols { class OMRCListenerMultiplexerHelper; }
  39
  40 namespace unocontrols {
  41
  42 class BaseControl   : public css::lang::XServiceInfo
  43                     , public css::awt::XPaintListener
  44                     , public css::awt::XWindowListener
  45                     , public css::awt::XView
  46                     , public css::awt::XWindow
  47                     , public css::awt::XControl
  48                     , public cppu::BaseMutex
  49                     , public ::cppu::WeakComponentImplHelper<>
  50 {
  51 public:
  52     BaseControl( const css::uno::Reference< css::uno::XComponentContext >& rxContext );
  53
  54     virtual ~BaseControl() override;
  55
  56     //  XInterface
  57
  58     /**
  59         @short      give answer, if interface is supported
  60         @descr      The interfaces are searched by type.
  61
  62         @seealso    XInterface
  63
  64         @param      "rType" is the type of searched interface.
  65
  66         @return     Any     information about found interface
  67
  68         @onerror    A RuntimeException is thrown.
  69     */
  70
  71     virtual css::uno::Any SAL_CALL queryInterface(
  72         const css::uno::Type& aType
  73     ) override;
  74
  75     /**
  76         @short      increment refcount
  77         @seealso    XInterface
  78         @seealso    release()
  79         @onerror    A RuntimeException is thrown.
  80     */
  81
  82     virtual void SAL_CALL acquire() noexcept override;
  83
  84     /**
  85         @short      decrement refcount
  86         @seealso    XInterface
  87         @seealso    acquire()
  88         @onerror    A RuntimeException is thrown.
  89     */
  90
  91     virtual void SAL_CALL release() noexcept override;
  92
  93     //  XTypeProvider
  94
  95     /**
  96         @short      get information about supported interfaces
  97         @seealso    XTypeProvider
  98         @return     Sequence of types of all supported interfaces
  99
 100         @onerror    A RuntimeException is thrown.
 101     */
 102
 103     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
 104
 105     /**
 106         @short      get implementation id
 107         @descr      This ID is necessary for UNO-caching. If there no ID, cache is disabled.
 108                     Another way, cache is enabled.
 109
 110         @seealso    XTypeProvider
 111         @return     ID as Sequence of byte
 112
 113         @onerror    A RuntimeException is thrown.
 114     */
 115
 116     virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
 117
 118     //  XServiceInfo
 119
 120     virtual sal_Bool SAL_CALL supportsService(
 121         const OUString& sServiceName
 122     ) override;
 123
 124     virtual OUString SAL_CALL getImplementationName() override;
 125
 126     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 127
 128     //  XComponent
 129
 130     virtual void SAL_CALL dispose() override;
 131
 132     virtual void SAL_CALL addEventListener(
 133         const css::uno::Reference< css::lang::XEventListener >& xListener
 134     ) override;
 135
 136     virtual void SAL_CALL removeEventListener(
 137         const css::uno::Reference< css::lang::XEventListener >& xListener
 138     ) override;
 139
 140     //  XControl
 141
 142     virtual void SAL_CALL createPeer(
 143         const css::uno::Reference< css::awt::XToolkit >& xToolkit,
 144         const css::uno::Reference< css::awt::XWindowPeer >& xParent
 145     ) override;
 146
 147     virtual void SAL_CALL setContext(
 148         const css::uno::Reference< css::uno::XInterface >& xContext
 149     ) override;
 150
 151     virtual sal_Bool SAL_CALL setModel(
 152         const css::uno::Reference< css::awt::XControlModel >& xModel
 153     ) override = 0;
 154
 155     virtual void SAL_CALL setDesignMode( sal_Bool bOn ) override;
 156
 157     virtual css::uno::Reference< css::uno::XInterface > SAL_CALL getContext() override;
 158
 159     virtual css::uno::Reference< css::awt::XControlModel > SAL_CALL getModel() override = 0;
 160
 161     virtual css::uno::Reference< css::awt::XWindowPeer > SAL_CALL getPeer() override;
 162
 163     virtual css::uno::Reference< css::awt::XView > SAL_CALL getView() override;
 164
 165     virtual sal_Bool SAL_CALL isDesignMode() override;
 166
 167     virtual sal_Bool SAL_CALL isTransparent() override;
 168
 169     //  XWindow
 170
 171     virtual void SAL_CALL setPosSize(   sal_Int32   nX      ,
 172                                         sal_Int32   nY      ,
 173                                         sal_Int32   nWidth  ,
 174                                         sal_Int32   nHeight ,
 175                                         sal_Int16   nFlags  ) override;
 176
 177     virtual void SAL_CALL setVisible( sal_Bool bVisible ) override;
 178
 179     virtual void SAL_CALL setEnable( sal_Bool bEnable ) override;
 180
 181     virtual void SAL_CALL setFocus() override;
 182
 183     virtual css::awt::Rectangle SAL_CALL getPosSize() override;
 184
 185     virtual void SAL_CALL addWindowListener(
 186         const css::uno::Reference< css::awt::XWindowListener >& xListener
 187     ) override;
 188
 189     virtual void SAL_CALL addFocusListener(
 190         const css::uno::Reference< css::awt::XFocusListener >& xListener
 191     ) override;
 192
 193     virtual void SAL_CALL addKeyListener(
 194         const css::uno::Reference< css::awt::XKeyListener >& xListener ) override;
 195
 196     virtual void SAL_CALL addMouseListener(
 197         const css::uno::Reference< css::awt::XMouseListener >& xListener
 198     ) override;
 199
 200     virtual void SAL_CALL addMouseMotionListener(
 201         const css::uno::Reference< css::awt::XMouseMotionListener >& xListener
 202     ) override;
 203
 204     virtual void SAL_CALL addPaintListener(
 205         const css::uno::Reference< css::awt::XPaintListener >& xListener
 206     ) override;
 207
 208     virtual void SAL_CALL removeWindowListener(
 209         const css::uno::Reference< css::awt::XWindowListener >& xListener
 210     ) override;
 211
 212     virtual void SAL_CALL removeFocusListener(
 213         const css::uno::Reference< css::awt::XFocusListener >& xListener
 214     ) override;
 215
 216     virtual void SAL_CALL removeKeyListener(
 217         const css::uno::Reference< css::awt::XKeyListener >& xListener
 218     ) override;
 219
 220     virtual void SAL_CALL removeMouseListener(
 221         const css::uno::Reference< css::awt::XMouseListener >& xListener
 222     ) override;
 223
 224     virtual void SAL_CALL removeMouseMotionListener(
 225         const css::uno::Reference< css::awt::XMouseMotionListener >& xListener
 226     ) override;
 227
 228     virtual void SAL_CALL removePaintListener(
 229         const css::uno::Reference< css::awt::XPaintListener >& xListener
 230     ) override;
 231
 232     //  XView
 233
 234     virtual void SAL_CALL draw( sal_Int32   nX  ,
 235                                 sal_Int32   nY  ) override;
 236
 237     virtual sal_Bool SAL_CALL setGraphics(
 238         const css::uno::Reference< css::awt::XGraphics >& xDevice
 239     ) override;
 240
 241     virtual void SAL_CALL setZoom(  float   fZoomX  ,
 242                                     float   fZoomY  ) override;
 243
 244     virtual css::uno::Reference< css::awt::XGraphics > SAL_CALL getGraphics() override;
 245
 246     virtual css::awt::Size SAL_CALL getSize() override;
 247
 248     //  css::lang::XEventListener
 249
 250     virtual void SAL_CALL disposing(
 251         const css::lang::EventObject& rSource
 252     ) override;
 253
 254     //  XPaintListener
 255
 256     virtual void SAL_CALL windowPaint(
 257         const css::awt::PaintEvent& rEvent
 258     ) override;
 259
 260     //  XWindowListener
 261
 262     virtual void SAL_CALL windowResized( const css::awt::WindowEvent& aEvent ) override;
 263     virtual void SAL_CALL windowMoved( const css::awt::WindowEvent& aEvent ) override;
 264     virtual void SAL_CALL windowShown( const css::lang::EventObject& aEvent ) override;
 265     virtual void SAL_CALL windowHidden( const css::lang::EventObject& aEvent ) override;
 266
 267 protected:
 268     using WeakComponentImplHelper::disposing;
 269
 270     const css::uno::Reference< css::uno::XComponentContext >& impl_getComponentContext() const { return m_xComponentContext;}
 271
 272     const css::uno::Reference< css::awt::XWindow >& impl_getPeerWindow() const { return m_xPeerWindow;}
 273
 274     const css::uno::Reference< css::awt::XGraphics >& impl_getGraphicsPeer() const { return m_xGraphicsPeer;}
 275
 276     sal_Int32 impl_getWidth() const { return m_nWidth;}
 277
 278     sal_Int32 impl_getHeight() const { return m_nHeight;}
 279
 280     virtual css::awt::WindowDescriptor impl_getWindowDescriptor(
 281         const css::uno::Reference< css::awt::XWindowPeer >& xParentPeer
 282     );
 283
 284     virtual void impl_paint(        sal_Int32               nX          ,
 285                                     sal_Int32               nY          ,
 286                             const   css::uno::Reference< css::awt::XGraphics >&   xGraphics   );
 287
 288     virtual void impl_recalcLayout( const css::awt::WindowEvent& aEvent );
 289
 290 private:
 291     OMRCListenerMultiplexerHelper* impl_getMultiplexer();
 292
 293     css::uno::Reference< css::uno::XComponentContext >        m_xComponentContext;
 294     rtl::Reference<OMRCListenerMultiplexerHelper>             m_xMultiplexer;   // multiplex events
 295     css::uno::Reference< css::uno::XInterface >               m_xContext;
 296     css::uno::Reference< css::awt::XWindowPeer >              m_xPeer;
 297     css::uno::Reference< css::awt::XWindow >                  m_xPeerWindow;
 298     css::uno::Reference< css::awt::XGraphics >                m_xGraphicsView;   // graphics for css::awt::XView-operations
 299     css::uno::Reference< css::awt::XGraphics >                m_xGraphicsPeer;   // graphics for painting on a peer
 300     sal_Int32                                       m_nX;   // Position ...
 301     sal_Int32                                       m_nY;
 302     sal_Int32                                       m_nWidth;   // ... and size of window
 303     sal_Int32                                       m_nHeight;
 304     bool                                        m_bVisible;   // Some state flags
 305     bool                                        m_bInDesignMode;
 306     bool                                        m_bEnable;
 307 };
 308
 309 }
 310
 311
 312 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */