include/sfx2/userinputinterception.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 #ifndef INCLUDED_SFX2_USERINPUTINTERCEPTION_HXX
  21 #define INCLUDED_SFX2_USERINPUTINTERCEPTION_HXX
  22
  23 #include <sfx2/dllapi.h>
  24
  25 #include <memory>
  26
  27 namespace com::sun::star::awt { class XKeyHandler; }
  28 namespace com::sun::star::awt { class XMouseClickHandler; }
  29 namespace com::sun::star::uno { template <typename > class Reference; }
  30 namespace osl { class Mutex; }
  31
  32 class NotifyEvent;
  33
  34 namespace cppu { class OWeakObject; }
  35
  36
  37 namespace sfx2
  38 {
  39
  40
  41     //= UserInputInterception
  42
  43     struct UserInputInterception_Data;
  44     /** helper class for implementing the XUserInputInterception interface
  45         for a controller implementation
  46     */
  47     class SFX2_DLLPUBLIC UserInputInterception
  48     {
  49     public:
  50         UserInputInterception( ::cppu::OWeakObject& _rControllerImpl, ::osl::Mutex& _rMutex );
  51         ~UserInputInterception();
  52         UserInputInterception(const UserInputInterception&) = delete;
  53         UserInputInterception& operator=( const UserInputInterception& ) = delete;
  54
  55         // delegator functions for your XUserInputInterception implementation
  56         /// @throws css::uno::RuntimeException
  57         void    addKeyHandler( const css::uno::Reference< css::awt::XKeyHandler >& xHandler );
  58         /// @throws css::uno::RuntimeException
  59         void    removeKeyHandler( const css::uno::Reference< css::awt::XKeyHandler >& xHandler );
  60         /// @throws css::uno::RuntimeException
  61         void    addMouseClickHandler( const css::uno::Reference< css::awt::XMouseClickHandler >& xHandler );
  62         /// @throws css::uno::RuntimeException
  63         void    removeMouseClickHandler( const css::uno::Reference< css::awt::XMouseClickHandler >& xHandler );
  64
  65         // state
  66         bool    hasKeyHandlers() const;
  67         bool    hasMouseClickListeners() const;
  68
  69         // forwarding a NotifyEvent to the KeyListeners respectively MouseClickListeners
  70         bool    handleNotifyEvent( const NotifyEvent& _rEvent );
  71
  72     private:
  73         ::std::unique_ptr< UserInputInterception_Data >   m_pData;
  74     };
  75
  76
  77 } // namespace sfx2
  78
  79
  80 #endif // INCLUDED_SFX2_USERINPUTINTERCEPTION_HXX
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */