1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef SVX_FMSCRIPTINGENV_HXX 29*cdf0e10cSrcweir #define SVX_FMSCRIPTINGENV_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir /** === begin UNO includes === **/ 32*cdf0e10cSrcweir #include <com/sun/star/script/XEventAttacherManager.hpp> 33*cdf0e10cSrcweir /** === end UNO includes === **/ 34*cdf0e10cSrcweir #include <rtl/ref.hxx> 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir class FmFormModel; 37*cdf0e10cSrcweir //........................................................................ 38*cdf0e10cSrcweir namespace svxform 39*cdf0e10cSrcweir { 40*cdf0e10cSrcweir //........................................................................ 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir //==================================================================== 43*cdf0e10cSrcweir //= IFormScriptingEnvironment 44*cdf0e10cSrcweir //==================================================================== 45*cdf0e10cSrcweir /** describes the interface implemented by a component which handles scripting requirements 46*cdf0e10cSrcweir in a form/control environment. 47*cdf0e10cSrcweir */ 48*cdf0e10cSrcweir class SAL_NO_VTABLE IFormScriptingEnvironment : public ::rtl::IReference 49*cdf0e10cSrcweir { 50*cdf0e10cSrcweir public: 51*cdf0e10cSrcweir /** registers an XEventAttacherManager whose events should be monitored and handled 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir @param _rxManager 54*cdf0e10cSrcweir the XEventAttacherManager to monitor. Must not be <NULL/>. 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 57*cdf0e10cSrcweir if <arg>_rxManager</arg> is <NULL/> 58*cdf0e10cSrcweir @throws ::com::sun::star::lang::DisposedException 59*cdf0e10cSrcweir if the instance is already disposed 60*cdf0e10cSrcweir @throws ::com::sun::star::uno::RuntimeException 61*cdf0e10cSrcweir if attaching as script listener to the manager fails with a RuntimeException itself 62*cdf0e10cSrcweir */ 63*cdf0e10cSrcweir virtual void registerEventAttacherManager( 64*cdf0e10cSrcweir const ::com::sun::star::uno::Reference< ::com::sun::star::script::XEventAttacherManager >& _rxManager ) = 0; 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir /** registers an XEventAttacherManager whose events should not be monitored and handled anymore 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir @param _rxManager 69*cdf0e10cSrcweir the XEventAttacherManager which was previously registered. Must not ne <NULL/>. 70*cdf0e10cSrcweir 71*cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 72*cdf0e10cSrcweir if <arg>_rxManager</arg> is <NULL/> 73*cdf0e10cSrcweir @throws ::com::sun::star::lang::DisposedException 74*cdf0e10cSrcweir if the instance is already disposed 75*cdf0e10cSrcweir @throws ::com::sun::star::uno::RuntimeException 76*cdf0e10cSrcweir if removing as script listener from the manager fails with a RuntimeException itself 77*cdf0e10cSrcweir */ 78*cdf0e10cSrcweir virtual void revokeEventAttacherManager( 79*cdf0e10cSrcweir const ::com::sun::star::uno::Reference< ::com::sun::star::script::XEventAttacherManager >& _rxManager ) = 0; 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir /** disposes the scripting environment instance 82*cdf0e10cSrcweir */ 83*cdf0e10cSrcweir virtual void dispose() = 0; 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir virtual ~IFormScriptingEnvironment(); 86*cdf0e10cSrcweir }; 87*cdf0e10cSrcweir typedef ::rtl::Reference< IFormScriptingEnvironment > PFormScriptingEnvironment; 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir //==================================================================== 90*cdf0e10cSrcweir /** creates a default component implementing the IFormScriptingEnvironment interface 91*cdf0e10cSrcweir */ 92*cdf0e10cSrcweir PFormScriptingEnvironment createDefaultFormScriptingEnvironment( FmFormModel& _rFormModel ); 93*cdf0e10cSrcweir 94*cdf0e10cSrcweir //........................................................................ 95*cdf0e10cSrcweir } // namespace svxform 96*cdf0e10cSrcweir //........................................................................ 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir #endif // SVX_FMSCRIPTINGENV_HXX 99*cdf0e10cSrcweir 100