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
  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 SAL_NO_VTABLE IFormScriptingEnvironment : public ::salhelper::SimpleReferenceObject
  39     {
  40     public:
  41         /** registers an XEventAttacherManager whose events should be monitored and handled
  42
  43             @param _rxManager
  44                 the XEventAttacherManager to monitor. Must not be <NULL/>.
  45
  46             @throws css::lang::IllegalArgumentException
  47                 if <arg>_rxManager</arg> is <NULL/>
  48             @throws css::lang::DisposedException
  49                 if the instance is already disposed
  50             @throws css::uno::RuntimeException
  51                 if attaching as script listener to the manager fails with a RuntimeException itself
  52         */
  53         virtual void registerEventAttacherManager(
  54             const css::uno::Reference< css::script::XEventAttacherManager >& _rxManager ) = 0;
  55
  56         /** registers an XEventAttacherManager whose events should not be monitored and handled anymore
  57
  58             @param _rxManager
  59                 the XEventAttacherManager which was previously registered. Must not ne <NULL/>.
  60
  61             @throws css::lang::IllegalArgumentException
  62                 if <arg>_rxManager</arg> is <NULL/>
  63             @throws css::lang::DisposedException
  64                 if the instance is already disposed
  65             @throws css::uno::RuntimeException
  66                 if removing as script listener from the manager fails with a RuntimeException itself
  67         */
  68         virtual void revokeEventAttacherManager(
  69             const css::uno::Reference< css::script::XEventAttacherManager >& _rxManager ) = 0;
  70
  71         /** disposes the scripting environment instance
  72         */
  73         virtual void dispose() = 0;
  74
  75         virtual ~IFormScriptingEnvironment() override;
  76     };
  77     typedef ::rtl::Reference< IFormScriptingEnvironment >   PFormScriptingEnvironment;
  78
  79
  80     /** creates a default component implementing the IFormScriptingEnvironment interface
  81     */
  82     PFormScriptingEnvironment   createDefaultFormScriptingEnvironment( FmFormModel& _rFormModel );
  83
  84
  85 }
  86
  87
  88 #endif // INCLUDED_SVX_SOURCE_INC_FMSCRIPTINGENV_HXX
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */