svx/source/inc/fmscriptingenv.hxx

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