LibreOffice Module forms (master) 1
Public Member Functions | Private Attributes | List of all members
frm::ControlFeatureInterception Class Reference

helper class for controls which allow some of their features to be intercepted by external instances More...

#include <controlfeatureinterception.hxx>

Public Member Functions

const UrlTransformergetTransformer () const
 retrieves our URL transformer, so our clients may use it, too More...
 
 ControlFeatureInterception (const css::uno::Reference< css::uno::XComponentContext > &_rxORB)
 
void registerDispatchProviderInterceptor (const css::uno::Reference< css::frame::XDispatchProviderInterceptor > &Interceptor)
 
void releaseDispatchProviderInterceptor (const css::uno::Reference< css::frame::XDispatchProviderInterceptor > &Interceptor)
 
void dispose ()
 
css::uno::Reference< css::frame::XDispatch > queryDispatch (const css::util::URL &_rURL)
 queries the interceptor chain for the given dispatch, with a blank target frame and no frame search flags More...
 
css::uno::Reference< css::frame::XDispatch > queryDispatch (const char *_pAsciiURL)
 queries the interceptor chain for the URL given as ASCII string, with a blank target frame and no frame search flags More...
 

Private Attributes

css::uno::Reference< css::frame::XDispatchProviderInterceptor > m_xFirstDispatchInterceptor
 
::std::unique_ptr< UrlTransformerm_pUrlTransformer
 

Detailed Description

helper class for controls which allow some of their features to be intercepted by external instances

For using this class, instantiate it as member, derive yourself from <type scope="css::frame">XDispatchProviderInterception</type>, and forward all respective methods to this member.

Additionally, don't forget to call <member>dispose</member> when your class is disposed itself.

Definition at line 47 of file controlfeatureinterception.hxx.

Constructor & Destructor Documentation

◆ ControlFeatureInterception()

frm::ControlFeatureInterception::ControlFeatureInterception ( const css::uno::Reference< css::uno::XComponentContext > &  _rxORB)

Definition at line 34 of file controlfeatureinterception.cxx.

Member Function Documentation

◆ dispose()

void frm::ControlFeatureInterception::dispose ( void  )

◆ getTransformer()

const UrlTransformer & frm::ControlFeatureInterception::getTransformer ( ) const
inline

retrieves our URL transformer, so our clients may use it, too

Definition at line 57 of file controlfeatureinterception.hxx.

References m_pUrlTransformer.

◆ queryDispatch() [1/2]

Reference< XDispatch > frm::ControlFeatureInterception::queryDispatch ( const char *  _pAsciiURL)

queries the interceptor chain for the URL given as ASCII string, with a blank target frame and no frame search flags

Definition at line 138 of file controlfeatureinterception.cxx.

References m_pUrlTransformer, and queryDispatch().

◆ queryDispatch() [2/2]

css::uno::Reference< css::frame::XDispatch > frm::ControlFeatureInterception::queryDispatch ( const css::util::URL &  _rURL)

queries the interceptor chain for the given dispatch, with a blank target frame and no frame search flags

Referenced by queryDispatch(), and frm::OFormNavigationHelper::queryDispatch().

◆ registerDispatchProviderInterceptor()

void frm::ControlFeatureInterception::registerDispatchProviderInterceptor ( const css::uno::Reference< css::frame::XDispatchProviderInterceptor > &  Interceptor)

◆ releaseDispatchProviderInterceptor()

void frm::ControlFeatureInterception::releaseDispatchProviderInterceptor ( const css::uno::Reference< css::frame::XDispatchProviderInterceptor > &  Interceptor)

Member Data Documentation

◆ m_pUrlTransformer

::std::unique_ptr< UrlTransformer > frm::ControlFeatureInterception::m_pUrlTransformer
private

Definition at line 52 of file controlfeatureinterception.hxx.

Referenced by getTransformer(), and queryDispatch().

◆ m_xFirstDispatchInterceptor

css::uno::Reference< css::frame::XDispatchProviderInterceptor > frm::ControlFeatureInterception::m_xFirstDispatchInterceptor
private

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