dbaccess::DocumentEventNotifier Class Reference

#include <documenteventnotifier.hxx>

Collaboration diagram for dbaccess::DocumentEventNotifier:

Public Member Functions
	DocumentEventNotifier (::cppu::OWeakObject &_rBroadcasterDocument, ::osl::Mutex &_rMutex)
	~DocumentEventNotifier ()
void	addLegacyEventListener (const css::uno::Reference< css::document::XEventListener > &Listener)
void	removeLegacyEventListener (const css::uno::Reference< css::document::XEventListener > &Listener)
void	addDocumentEventListener (const css::uno::Reference< css::document::XDocumentEventListener > &Listener)
void	removeDocumentEventListener (const css::uno::Reference< css::document::XDocumentEventListener > &Listener)
void	disposing ()
	disposes the instance @precond the mutex is not locked More...
void	onDocumentInitialized ()
	tells the instance that its document is completely initialized now. More...
void	notifyDocumentEvent (const OUString &EventName, const css::uno::Reference< css::frame::XController2 > &_rxViewController, const css::uno::Any &Supplement)
	notifies a document event described by the given parameters More...
void	notifyDocumentEventAsync (const OUString &EventName, const css::uno::Reference< css::frame::XController2 > &ViewController, const css::uno::Any &Supplement)
	notifies a document event, described by the given parameters, asynchronously More...
void	notifyDocumentEvent (const char *_pAsciiEventName, const css::uno::Reference< css::frame::XController2 > &_rxViewController=nullptr, const css::uno::Any &_rSupplement=css::uno::Any())
	notifies a document event to all registered listeners More...
void	notifyDocumentEventAsync (const char *_pAsciiEventName, const css::uno::Reference< css::frame::XController2 > &_rxViewController=nullptr, const css::uno::Any &_rSupplement=css::uno::Any())
	notifies a document event to all registered listeners, asynchronously More...

Private Attributes
::rtl::Reference< DocumentEventNotifier_Impl >	m_pImpl

Detailed Description

Definition at line 38 of file documenteventnotifier.hxx.

Constructor & Destructor Documentation

DocumentEventNotifier()

dbaccess::DocumentEventNotifier::DocumentEventNotifier	(	::cppu::OWeakObject &	_rBroadcasterDocument,
		::osl::Mutex &	_rMutex
	)

Definition at line 237 of file documenteventnotifier.cxx.

References m_pImpl.

~DocumentEventNotifier()

dbaccess::DocumentEventNotifier::~DocumentEventNotifier

(

)

Definition at line 242 of file documenteventnotifier.cxx.

Member Function Documentation

addDocumentEventListener()

void dbaccess::DocumentEventNotifier::addDocumentEventListener

(

const css::uno::Reference< css::document::XDocumentEventListener > &

Listener

)

Definition at line 266 of file documenteventnotifier.cxx.

References m_pImpl.

Referenced by dbaccess::ODatabaseDocument::addDocumentEventListener().

addLegacyEventListener()

void dbaccess::DocumentEventNotifier::addLegacyEventListener

(

const css::uno::Reference< css::document::XEventListener > &

Listener

)

Definition at line 256 of file documenteventnotifier.cxx.

References m_pImpl.

disposing()

void dbaccess::DocumentEventNotifier::disposing

(

)

disposes the instance @precond the mutex is not locked

Definition at line 246 of file documenteventnotifier.cxx.

References m_pImpl.

Referenced by dbaccess::ODatabaseDocument::disposing().

notifyDocumentEvent() [1/2]

void dbaccess::DocumentEventNotifier::notifyDocumentEvent ( const char *  _pAsciiEventName, const css::uno::Reference< css::frame::XController2 > &  _rxViewController = nullptr, const css::uno::Any &  _rSupplement = css::uno::Any()  )

inline

notifies a document event to all registered listeners

@precond the mutex is not locked @precond ->onDocumentInitialized has been called

Definition at line 97 of file documenteventnotifier.hxx.

References notifyDocumentEvent().

notifyDocumentEvent() [2/2]

void dbaccess::DocumentEventNotifier::notifyDocumentEvent	(	const OUString &	EventName,
		const css::uno::Reference< css::frame::XController2 > &	_rxViewController,
		const css::uno::Any &	Supplement
	)

notifies a document event described by the given parameters

@precond the mutex is not locked @precond ->onDocumentInitialized has been called

Referenced by dbaccess::ODatabaseDocument::close(), dbaccess::ODatabaseDocument::disconnectController(), dbaccess::ODatabaseDocument::disposing(), dbaccess::ODatabaseDocument::impl_attachResource(), dbaccess::ODatabaseDocument::impl_storeAs_throw(), dbaccess::ODatabaseDocument::initNew(), notifyDocumentEvent(), dbaccess::ODatabaseDocument::notifyDocumentEvent(), dbaccess::ODatabaseDocument::storeAsURL(), and dbaccess::ODatabaseDocument::storeToURL().

notifyDocumentEventAsync() [1/2]

void dbaccess::DocumentEventNotifier::notifyDocumentEventAsync ( const char *  _pAsciiEventName, const css::uno::Reference< css::frame::XController2 > &  _rxViewController = nullptr, const css::uno::Any &  _rSupplement = css::uno::Any()  )

inline

notifies a document event to all registered listeners, asynchronously

Note that no event is actually notified before you called ->onDocumentInitialized.

@precond the mutex is locked

Definition at line 113 of file documenteventnotifier.hxx.

References notifyDocumentEventAsync().

notifyDocumentEventAsync() [2/2]

void dbaccess::DocumentEventNotifier::notifyDocumentEventAsync	(	const OUString &	EventName,
		const css::uno::Reference< css::frame::XController2 > &	ViewController,
		const css::uno::Any &	Supplement
	)

notifies a document event, described by the given parameters, asynchronously

Note that no event is actually notified before you called ->onDocumentInitialized.

@precond the mutex is locked

Referenced by dbaccess::ODatabaseDocument::connectController(), dbaccess::ODatabaseDocument::impl_setModified_nothrow(), dbaccess::ODatabaseDocument::impl_storeAs_throw(), dbaccess::ODatabaseDocument::initNew(), dbaccess::ODatabaseDocument::notifyDocumentEvent(), notifyDocumentEventAsync(), dbaccess::ViewMonitor::onSetCurrentController(), dbaccess::ODatabaseDocument::setTitle(), dbaccess::ODatabaseDocument::storeAsURL(), and dbaccess::ODatabaseDocument::storeToURL().

onDocumentInitialized()

void dbaccess::DocumentEventNotifier::onDocumentInitialized

(

)

tells the instance that its document is completely initialized now.

Before you call this method, no notification will actually happen

@precond the mutex is locked

Definition at line 251 of file documenteventnotifier.cxx.

References m_pImpl.

Referenced by dbaccess::ODatabaseDocument::impl_setInitialized().

removeDocumentEventListener()

void dbaccess::DocumentEventNotifier::removeDocumentEventListener

(

const css::uno::Reference< css::document::XDocumentEventListener > &

Listener

)

Definition at line 271 of file documenteventnotifier.cxx.

References m_pImpl.

Referenced by dbaccess::ODatabaseDocument::removeDocumentEventListener().

removeLegacyEventListener()

void dbaccess::DocumentEventNotifier::removeLegacyEventListener

(

const css::uno::Reference< css::document::XEventListener > &

Listener

)

Definition at line 261 of file documenteventnotifier.cxx.

References m_pImpl.

Member Data Documentation

m_pImpl

::rtl::Reference< DocumentEventNotifier_Impl > dbaccess::DocumentEventNotifier::m_pImpl

private

Definition at line 123 of file documenteventnotifier.hxx.

Referenced by addDocumentEventListener(), addLegacyEventListener(), disposing(), onDocumentInitialized(), removeDocumentEventListener(), and removeLegacyEventListener().

---

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

• documenteventnotifier.hxx
• documenteventnotifier.cxx