dbaui::SubComponentManager Class Reference

#include <subcomponentmanager.hxx>

Inheritance diagram for dbaui::SubComponentManager:

Collaboration diagram for dbaui::SubComponentManager:

Public Member Functions
	SubComponentManager (OApplicationController &_rController, const ::comphelper::SharedMutex &_rMutex)
virtual	~SubComponentManager () override
void	disposing ()
virtual void SAL_CALL	propertyChange (const css::beans::PropertyChangeEvent &evt) override
virtual void SAL_CALL	disposing (const css::lang::EventObject &Source) override
css::uno::Sequence< css::uno::Reference< css::lang::XComponent > >	getSubComponents () const
bool	closeSubComponents ()
void	onSubComponentOpened (const OUString &_rName, const sal_Int32 _nComponentType, const ElementOpenMode _eOpenMode, const css::uno::Reference< css::lang::XComponent > &_rxComponent)
bool	empty () const
bool	activateSubFrame (const OUString &_rName, const sal_Int32 _nComponentType, const ElementOpenMode _eOpenMode, css::uno::Reference< css::lang::XComponent > &o_rComponent) const
	activates (i.e. More...
bool	closeSubFrames (std::u16string_view _rName, const sal_Int32 _nComponentType)
	closes all frames of the given component More...
bool	lookupSubComponent (const css::uno::Reference< css::lang::XComponent > &i_rComponent, OUString &o_rName, sal_Int32 &o_rComponentType)
	searches for the given sub component More...

Private Attributes
std::unique_ptr< SubComponentManager_Data >	m_pData

Detailed Description

Definition at line 41 of file subcomponentmanager.hxx.

Constructor & Destructor Documentation

SubComponentManager()

dbaui::SubComponentManager::SubComponentManager	(	OApplicationController &	_rController,
		const ::comphelper::SharedMutex &	_rMutex
	)

Definition at line 210 of file subcomponentmanager.cxx.

~SubComponentManager()

dbaui::SubComponentManager::~SubComponentManager ( )

overridevirtual

Definition at line 215 of file subcomponentmanager.cxx.

Member Function Documentation

activateSubFrame()

bool dbaui::SubComponentManager::activateSubFrame	(	const OUString &	_rName,
		const sal_Int32	_nComponentType,
		const ElementOpenMode	_eOpenMode,
		css::uno::Reference< css::lang::XComponent > &	o_rComponent
	)		const

activates (i.e.

brings to top) the frame in which the given component is loaded, if any

Returns

<TRUE> if any only of such a frame was found, i.e. the component had already been loaded previously

Definition at line 480 of file subcomponentmanager.cxx.

References m_pData, pos, and xFrame.

closeSubComponents()

bool dbaui::SubComponentManager::closeSubComponents

(

)

Definition at line 418 of file subcomponentmanager.cxx.

References DBG_UNHANDLED_EXCEPTION, empty(), Exception, and m_pData.

closeSubFrames()

bool dbaui::SubComponentManager::closeSubFrames	(	std::u16string_view	_rName,
		const sal_Int32	_nComponentType
	)

closes all frames of the given component

If a view for the component (given by name and type) has been loaded into one or more frames (with potentially different OpenModes), then those frames are gracefully closed.

Returns

<TRUE> if and only if closing those frames was successful, or frames for the given sub component exist.

Definition at line 508 of file subcomponentmanager.cxx.

References ENSURE_OR_RETURN_FALSE, and m_pData.

disposing() [1/2]

void dbaui::SubComponentManager::disposing

(

)

Definition at line 219 of file subcomponentmanager.cxx.

References m_pData.

disposing() [2/2]

virtual void SAL_CALL dbaui::SubComponentManager::disposing ( const css::lang::EventObject &  Source )

overridevirtual

empty()

bool dbaui::SubComponentManager::empty

(

)

const

Definition at line 439 of file subcomponentmanager.cxx.

References m_pData.

Referenced by closeSubComponents().

getSubComponents()

Sequence< Reference< XComponent > > dbaui::SubComponentManager::getSubComponents

(

)

const

Definition at line 404 of file subcomponentmanager.cxx.

References m_pData.

lookupSubComponent()

bool dbaui::SubComponentManager::lookupSubComponent	(	const css::uno::Reference< css::lang::XComponent > &	i_rComponent,
		OUString &	o_rName,
		sal_Int32 &	o_rComponentType
	)

searches for the given sub component

Parameters

i_rComponent	the sub component to look up
o_rName	contains, upon successful return, the name of the sub component
o_nComponentType	contains, upon successful return, the type of the sub component

Returns

<TRUE> if and only if the component was found

Definition at line 526 of file subcomponentmanager.cxx.

References m_pData.

onSubComponentOpened()

void dbaui::SubComponentManager::onSubComponentOpened	(	const OUString &	_rName,
		const sal_Int32	_nComponentType,
		const ElementOpenMode	_eOpenMode,
		const css::uno::Reference< css::lang::XComponent > &	_rxComponent
	)

Definition at line 445 of file subcomponentmanager.cxx.

References ENSURE_OR_THROW, m_pData, and PROPERTY_NAME().

propertyChange()

void SAL_CALL dbaui::SubComponentManager::propertyChange ( const css::beans::PropertyChangeEvent &  evt )

overridevirtual

Definition at line 329 of file subcomponentmanager.cxx.

References m_pData, and PROPERTY_NAME().

Member Data Documentation

m_pData

std::unique_ptr< SubComponentManager_Data > dbaui::SubComponentManager::m_pData

private

Definition at line 115 of file subcomponentmanager.hxx.

Referenced by activateSubFrame(), closeSubComponents(), closeSubFrames(), disposing(), empty(), getSubComponents(), lookupSubComponent(), onSubComponentOpened(), and propertyChange().

---

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

• subcomponentmanager.hxx
• subcomponentmanager.cxx