svx/source/inc/fmscriptingenv.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_SVX_SOURCE_INC_FMSCRIPTINGENV_HXX
  21 #define INCLUDED_SVX_SOURCE_INC_FMSCRIPTINGENV_HXX
  22
  23 #include <com/sun/star/script/XEventAttacherManager.hpp>
  24 #include <rtl/ref.hxx>
  25 #include <salhelper/simplereferenceobject.hxx>
  26 #include <mutex>
  27
  28 class FmFormModel;
  29
  30 namespace svxform
  31 {
  32     class FormScriptListener;
  33
  34     //= IFormScriptingEnvironment
  35
  36     /** describes the interface implemented by a component which handles scripting requirements
  37         in a form/control environment.
  38     */
  39     class FormScriptingEnvironment final : public ::salhelper::SimpleReferenceObject
  40     {
  41     friend class FormScriptListener;
  42     public:
  43         explicit FormScriptingEnvironment( FmFormModel& _rModel );
  44         FormScriptingEnvironment(const FormScriptingEnvironment&) = delete;
  45         FormScriptingEnvironment& operator=(const FormScriptingEnvironment&) = delete;
  46
  47         /** registers an XEventAttacherManager whose events should be monitored and handled
  48
  49             @param _rxManager
  50                 the XEventAttacherManager to monitor. Must not be <NULL/>.
  51
  52             @throws css::lang::IllegalArgumentException
  53                 if <arg>_rxManager</arg> is <NULL/>
  54             @throws css::lang::DisposedException
  55                 if the instance is already disposed
  56             @throws css::uno::RuntimeException
  57                 if attaching as script listener to the manager fails with a RuntimeException itself
  58         */
  59         void registerEventAttacherManager(
  60             const css::uno::Reference< css::script::XEventAttacherManager >& _rxManager );
  61
  62         /** registers an XEventAttacherManager whose events should not be monitored and handled anymore
  63
  64             @param _rxManager
  65                 the XEventAttacherManager which was previously registered. Must not ne <NULL/>.
  66
  67             @throws css::lang::IllegalArgumentException
  68                 if <arg>_rxManager</arg> is <NULL/>
  69             @throws css::lang::DisposedException
  70                 if the instance is already disposed
  71             @throws css::uno::RuntimeException
  72                 if removing as script listener from the manager fails with a RuntimeException itself
  73         */
  74         void revokeEventAttacherManager(
  75             const css::uno::Reference< css::script::XEventAttacherManager >& _rxManager );
  76
  77         /** disposes the scripting environment instance
  78         */
  79         void dispose();
  80
  81     private:
  82         std::mutex              m_aMutex;
  83         rtl::Reference<FormScriptListener> m_pScriptListener;
  84         FmFormModel&            m_rFormModel;
  85         bool                    m_bDisposed;
  86
  87         void impl_registerOrRevoke_throw( const css::uno::Reference< css::script::XEventAttacherManager >& _rxManager, bool _bRegister );
  88         // callback for FormScriptListener
  89         void doFireScriptEvent( const css::script::ScriptEvent& _rEvent, css::uno::Any* _pSynchronousResult );
  90
  91     };
  92
  93 }
  94
  95
  96 #endif // INCLUDED_SVX_SOURCE_INC_FMSCRIPTINGENV_HXX
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */