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