LibreOffice Module svx (master)  1
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
svxform::FormScriptingEnvironment Class Reference

describes the interface implemented by a component which handles scripting requirements in a form/control environment. More...

#include <fmscriptingenv.hxx>

Inheritance diagram for svxform::FormScriptingEnvironment:
[legend]
Collaboration diagram for svxform::FormScriptingEnvironment:
[legend]

Public Member Functions

 FormScriptingEnvironment (FmFormModel &_rModel)
 
 FormScriptingEnvironment (const FormScriptingEnvironment &)=delete
 
FormScriptingEnvironmentoperator= (const FormScriptingEnvironment &)=delete
 
void registerEventAttacherManager (const css::uno::Reference< css::script::XEventAttacherManager > &_rxManager)
 registers an XEventAttacherManager whose events should be monitored and handled More...
 
void revokeEventAttacherManager (const css::uno::Reference< css::script::XEventAttacherManager > &_rxManager)
 registers an XEventAttacherManager whose events should not be monitored and handled anymore More...
 
void dispose ()
 disposes the scripting environment instance More...
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Private Member Functions

void impl_registerOrRevoke_throw (const css::uno::Reference< css::script::XEventAttacherManager > &_rxManager, bool _bRegister)
 
void doFireScriptEvent (const css::script::ScriptEvent &_rEvent, css::uno::Any *_pSynchronousResult)
 

Private Attributes

::osl::Mutex m_aMutex
 
rtl::Reference< FormScriptListenerm_pScriptListener
 
FmFormModelm_rFormModel
 
bool m_bDisposed
 

Friends

class FormScriptListener
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static voidoperator new (std::size_t nSize)
 
static voidoperator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 
static void operator delete (void *pPtr)
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 
- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

describes the interface implemented by a component which handles scripting requirements in a form/control environment.

Definition at line 38 of file fmscriptingenv.hxx.

Constructor & Destructor Documentation

svxform::FormScriptingEnvironment::FormScriptingEnvironment ( FmFormModel _rModel)
explicit

Definition at line 866 of file fmscriptingenv.cxx.

References FormScriptListener, m_bDisposed, and m_pScriptListener.

svxform::FormScriptingEnvironment::FormScriptingEnvironment ( const FormScriptingEnvironment )
delete

Member Function Documentation

void svxform::FormScriptingEnvironment::dispose ( void  )

disposes the scripting environment instance

Definition at line 1030 of file fmscriptingenv.cxx.

References m_aMutex, m_bDisposed, and m_pScriptListener.

void svxform::FormScriptingEnvironment::doFireScriptEvent ( const css::script::ScriptEvent &  _rEvent,
css::uno::Any *  _pSynchronousResult 
)
private
void svxform::FormScriptingEnvironment::impl_registerOrRevoke_throw ( const css::uno::Reference< css::script::XEventAttacherManager > &  _rxManager,
bool  _bRegister 
)
private
FormScriptingEnvironment& svxform::FormScriptingEnvironment::operator= ( const FormScriptingEnvironment )
delete
void svxform::FormScriptingEnvironment::registerEventAttacherManager ( const css::uno::Reference< css::script::XEventAttacherManager > &  _rxManager)

registers an XEventAttacherManager whose events should be monitored and handled

Parameters
_rxManagerthe XEventAttacherManager to monitor. Must not be <NULL>.
Exceptions
css::lang::IllegalArgumentExceptionif <arg>_rxManager</arg> is <NULL>
css::lang::DisposedExceptionif the instance is already disposed
css::uno::RuntimeExceptionif attaching as script listener to the manager fails with a RuntimeException itself

Definition at line 899 of file fmscriptingenv.cxx.

References impl_registerOrRevoke_throw().

void svxform::FormScriptingEnvironment::revokeEventAttacherManager ( const css::uno::Reference< css::script::XEventAttacherManager > &  _rxManager)

registers an XEventAttacherManager whose events should not be monitored and handled anymore

Parameters
_rxManagerthe XEventAttacherManager which was previously registered. Must not ne <NULL>.
Exceptions
css::lang::IllegalArgumentExceptionif <arg>_rxManager</arg> is <NULL>
css::lang::DisposedExceptionif the instance is already disposed
css::uno::RuntimeExceptionif removing as script listener from the manager fails with a RuntimeException itself

Definition at line 905 of file fmscriptingenv.cxx.

References impl_registerOrRevoke_throw().

Friends And Related Function Documentation

friend class FormScriptListener
friend

Definition at line 40 of file fmscriptingenv.hxx.

Referenced by FormScriptingEnvironment().

Member Data Documentation

::osl::Mutex svxform::FormScriptingEnvironment::m_aMutex
private

Definition at line 81 of file fmscriptingenv.hxx.

Referenced by dispose(), doFireScriptEvent(), and impl_registerOrRevoke_throw().

bool svxform::FormScriptingEnvironment::m_bDisposed
private

Definition at line 84 of file fmscriptingenv.hxx.

Referenced by dispose(), doFireScriptEvent(), and impl_registerOrRevoke_throw().

rtl::Reference<FormScriptListener> svxform::FormScriptingEnvironment::m_pScriptListener
private
FmFormModel& svxform::FormScriptingEnvironment::m_rFormModel
private

Definition at line 83 of file fmscriptingenv.hxx.

Referenced by doFireScriptEvent().


The documentation for this class was generated from the following files: