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:

Collaboration diagram for svxform::FormScriptingEnvironment:

Public Member Functions
	FormScriptingEnvironment (FmFormModel &_rModel)
	FormScriptingEnvironment (const FormScriptingEnvironment &)=delete
FormScriptingEnvironment &	operator= (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
std::mutex	m_aMutex
rtl::Reference< FormScriptListener >	m_pScriptListener
FmFormModel &	m_rFormModel
bool	m_bDisposed

Friends
class	FormScriptListener

Additional Inherited Members
Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void *	operator new (std::size_t nSize)
static void *	operator 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 39 of file fmscriptingenv.hxx.

Constructor & Destructor Documentation

FormScriptingEnvironment() [1/2]

svxform::FormScriptingEnvironment::FormScriptingEnvironment ( FmFormModel &  _rModel )

explicit

Definition at line 752 of file fmscriptingenv.cxx.

References FormScriptListener, m_bDisposed, and m_pScriptListener.

FormScriptingEnvironment() [2/2]

svxform::FormScriptingEnvironment::FormScriptingEnvironment ( const FormScriptingEnvironment &  )

delete

Member Function Documentation

dispose()

void svxform::FormScriptingEnvironment::dispose

(

void

)

disposes the scripting environment instance

Definition at line 917 of file fmscriptingenv.cxx.

References m_aMutex, m_bDisposed, and m_pScriptListener.

doFireScriptEvent()

void svxform::FormScriptingEnvironment::doFireScriptEvent ( const css::script::ScriptEvent &  _rEvent, css::uno::Any *  _pSynchronousResult  )

private

Definition at line 836 of file fmscriptingenv.cxx.

References Any, DBG_ASSERT, SfxApplication::GetBasicManager(), FmFormModel::GetObjectShell(), tools::SvRef< typename T >::is(), m_aMutex, m_bDisposed, and m_rFormModel.

Referenced by svxform::FormScriptListener::impl_doFireScriptEvent_nothrow().

impl_registerOrRevoke_throw()

void svxform::FormScriptingEnvironment::impl_registerOrRevoke_throw ( const css::uno::Reference< css::script::XEventAttacherManager > &  _rxManager, bool  _bRegister  )

private

Definition at line 761 of file fmscriptingenv.cxx.

References DBG_UNHANDLED_EXCEPTION, Exception, m_aMutex, m_bDisposed, and m_pScriptListener.

Referenced by registerEventAttacherManager(), and revokeEventAttacherManager().

operator=()

FormScriptingEnvironment & svxform::FormScriptingEnvironment::operator= ( const FormScriptingEnvironment &  )

delete

registerEventAttacherManager()

void svxform::FormScriptingEnvironment::registerEventAttacherManager

(

const css::uno::Reference< css::script::XEventAttacherManager > &

_rxManager

)

registers an XEventAttacherManager whose events should be monitored and handled

Parameters

_rxManager

the XEventAttacherManager to monitor. Must not be <NULL>.

Exceptions

css::lang::IllegalArgumentException	if <arg>_rxManager</arg> is <NULL>
css::lang::DisposedException	if the instance is already disposed
css::uno::RuntimeException	if attaching as script listener to the manager fails with a RuntimeException itself

Definition at line 785 of file fmscriptingenv.cxx.

References impl_registerOrRevoke_throw().

revokeEventAttacherManager()

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

_rxManager

the XEventAttacherManager which was previously registered. Must not ne <NULL>.

Exceptions

css::lang::IllegalArgumentException	if <arg>_rxManager</arg> is <NULL>
css::lang::DisposedException	if the instance is already disposed
css::uno::RuntimeException	if removing as script listener from the manager fails with a RuntimeException itself

Definition at line 791 of file fmscriptingenv.cxx.

References impl_registerOrRevoke_throw().

Friends And Related Function Documentation

FormScriptListener

friend class FormScriptListener

friend

Definition at line 41 of file fmscriptingenv.hxx.

Referenced by FormScriptingEnvironment().

Member Data Documentation

m_aMutex

std::mutex svxform::FormScriptingEnvironment::m_aMutex

private

Definition at line 82 of file fmscriptingenv.hxx.

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

m_bDisposed

bool svxform::FormScriptingEnvironment::m_bDisposed

private

Definition at line 85 of file fmscriptingenv.hxx.

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

m_pScriptListener

rtl::Reference<FormScriptListener> svxform::FormScriptingEnvironment::m_pScriptListener

private

Definition at line 83 of file fmscriptingenv.hxx.

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

m_rFormModel

FmFormModel& svxform::FormScriptingEnvironment::m_rFormModel

private

Definition at line 84 of file fmscriptingenv.hxx.

Referenced by doFireScriptEvent().

---

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

• fmscriptingenv.hxx
• fmscriptingenv.cxx