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