Base class for sidebar panels that provides some convenience functionality. More...

#include <SidebarPanelBase.hxx>

Inheritance diagram for sfx2::sidebar::SidebarPanelBase:

Collaboration diagram for sfx2::sidebar::SidebarPanelBase:

Public Member Functions
virtual void SAL_CALL	notifyContextChangeEvent (const css::ui::ContextChangeEventObject &rEvent) override

virtual void SAL_CALL	disposing (const css::lang::EventObject &rEvent) override

virtual css::uno::Reference< css::frame::XFrame > SAL_CALL	getFrame () override

virtual OUString SAL_CALL	getResourceURL () override

virtual sal_Int16 SAL_CALL	getType () override

virtual css::uno::Reference< css::uno::XInterface > SAL_CALL	getRealInterface () override

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	createAccessible (const css::uno::Reference< css::accessibility::XAccessible > &rxParentAccessible) override

virtual css::uno::Reference< css::awt::XWindow > SAL_CALL	getWindow () override

virtual css::ui::LayoutSize SAL_CALL	getHeightForWidth (sal_Int32 nWidth) override

virtual sal_Int32 SAL_CALL	getMinimalWidth () override

virtual void SAL_CALL	updateModel (const css::uno::Reference< css::frame::XModel > &xModel) override

void	SetParentPanel (sfx2::sidebar::Panel *pPanel)

Public Member Functions inherited from comphelper::WeakComponentImplHelper< typename... Ifc >
virtual void SAL_CALL	acquire () noexcept override

virtual void SAL_CALL	release () noexcept override

virtual void SAL_CALL	dispose () noexcept final override

virtual void SAL_CALL	addEventListener (css::uno::Reference< css::lang::XEventListener > const &rxListener) final override

virtual void SAL_CALL	removeEventListener (css::uno::Reference< css::lang::XEventListener > const &rxListener) final override

virtual css::uno::Any SAL_CALL	queryInterface (css::uno::Type const &rType) override

virtual css::uno::Sequence< css::uno::Type > SAL_CALL	getTypes () override

virtual css::uno::Sequence< sal_Int8 > SAL_CALL	getImplementationId () override

Public Member Functions inherited from comphelper::WeakComponentImplHelperBase
virtual	~WeakComponentImplHelperBase () override

virtual void SAL_CALL	dispose () override

virtual void SAL_CALL	addEventListener (css::uno::Reference< css::lang::XEventListener > const &rxListener) override

virtual void SAL_CALL	removeEventListener (css::uno::Reference< css::lang::XEventListener > const &rxListener) override

virtual css::uno::Any SAL_CALL	queryInterface (css::uno::Type const &rType) override

virtual void	disposing (std::unique_lock< std::mutex > &)

Public Member Functions inherited from comphelper::UnoImplBase
virtual	~UnoImplBase ()

Static Public Member Functions
static css::uno::Reference< css::ui::XUIElement >	Create (const OUString &rsResourceURL, const css::uno::Reference< css::frame::XFrame > &rxFrame, std::unique_ptr< PanelLayout > xControl, const css::ui::LayoutSize &rLayoutSize)

Private Member Functions
	SidebarPanelBase (OUString sResourceURL, css::uno::Reference< css::frame::XFrame > xFrame, std::unique_ptr< PanelLayout > xControl, const css::ui::LayoutSize &rLayoutSize)

virtual	~SidebarPanelBase () override

	SidebarPanelBase (const SidebarPanelBase &)=delete

SidebarPanelBase &	operator= (const SidebarPanelBase &)=delete

virtual void	disposing (std::unique_lock< std::mutex > &) override

Private Attributes
css::uno::Reference< css::frame::XFrame >	mxFrame

std::unique_ptr< PanelLayout >	mxControl

const OUString	msResourceURL

const css::ui::LayoutSize	maLayoutSize

Additional Inherited Members
Protected Member Functions inherited from comphelper::WeakComponentImplHelperBase
void	throwIfDisposed (std::unique_lock< std::mutex > &)

Protected Attributes inherited from comphelper::WeakComponentImplHelperBase
comphelper::OInterfaceContainerHelper4< css::lang::XEventListener >	maEventListeners

Protected Attributes inherited from comphelper::UnoImplBase
std::mutex	m_aMutex

bool	m_bDisposed

Detailed Description

Base class for sidebar panels that provides some convenience functionality.

Definition at line 51 of file SidebarPanelBase.hxx.

Constructor & Destructor Documentation

◆ SidebarPanelBase() [1/2]

sfx2::sidebar::SidebarPanelBase::SidebarPanelBase	(	OUString	sResourceURL,
		css::uno::Reference< css::frame::XFrame >	xFrame,
		std::unique_ptr< PanelLayout >	xControl,
		const css::ui::LayoutSize &	rLayoutSize
	)

private

Definition at line 52 of file SidebarPanelBase.cxx.

References mxFrame, and xFrame.

Referenced by Create().

◆ ~SidebarPanelBase()

sfx2::sidebar::SidebarPanelBase::~SidebarPanelBase ( )

overrideprivatevirtual

Definition at line 71 of file SidebarPanelBase.cxx.

◆ SidebarPanelBase() [2/2]

sfx2::sidebar::SidebarPanelBase::SidebarPanelBase ( const SidebarPanelBase & )

privatedelete

Member Function Documentation

◆ Create()

Reference< ui::XUIElement > sfx2::sidebar::SidebarPanelBase::Create	(	const OUString &	rsResourceURL,
		const css::uno::Reference< css::frame::XFrame > &	rxFrame,
		std::unique_ptr< PanelLayout >	xControl,
		const css::ui::LayoutSize &	rLayoutSize
	)

static

Definition at line 37 of file SidebarPanelBase.cxx.

References SidebarPanelBase().

◆ createAccessible()

Reference< accessibility::XAccessible > SAL_CALL sfx2::sidebar::SidebarPanelBase::createAccessible ( const css::uno::Reference< css::accessibility::XAccessible > & rxParentAccessible )

overridevirtual

Definition at line 144 of file SidebarPanelBase.cxx.

◆ disposing() [1/2]

void SAL_CALL sfx2::sidebar::SidebarPanelBase::disposing ( const css::lang::EventObject & rEvent )

overridevirtual

Definition at line 115 of file SidebarPanelBase.cxx.

References mxControl, and mxFrame.

◆ disposing() [2/2]

void sfx2::sidebar::SidebarPanelBase::disposing ( std::unique_lock< std::mutex > & )

overrideprivatevirtual

Reimplemented from comphelper::WeakComponentImplHelperBase.

Definition at line 82 of file SidebarPanelBase.cxx.

References mxControl, and mxFrame.

◆ getFrame()

css::uno::Reference< css::frame::XFrame > SAL_CALL sfx2::sidebar::SidebarPanelBase::getFrame ( )

overridevirtual

Definition at line 124 of file SidebarPanelBase.cxx.

References mxFrame.

◆ getHeightForWidth()

ui::LayoutSize SAL_CALL sfx2::sidebar::SidebarPanelBase::getHeightForWidth ( sal_Int32 nWidth )

overridevirtual

Definition at line 157 of file SidebarPanelBase.cxx.

References Size::Height(), maLayoutSize, and mxControl.

◆ getMinimalWidth()

sal_Int32 SAL_CALL sfx2::sidebar::SidebarPanelBase::getMinimalWidth ( )

overridevirtual

Definition at line 176 of file SidebarPanelBase.cxx.

References mxControl, and Size::Width().

◆ getRealInterface()

Reference< XInterface > SAL_CALL sfx2::sidebar::SidebarPanelBase::getRealInterface ( )

overridevirtual

Definition at line 139 of file SidebarPanelBase.cxx.

◆ getResourceURL()

OUString SAL_CALL sfx2::sidebar::SidebarPanelBase::getResourceURL ( )

overridevirtual

Definition at line 129 of file SidebarPanelBase.cxx.

References msResourceURL.

◆ getType()

sal_Int16 SAL_CALL sfx2::sidebar::SidebarPanelBase::getType ( )

overridevirtual

Definition at line 134 of file SidebarPanelBase.cxx.

◆ getWindow()

Reference< awt::XWindow > SAL_CALL sfx2::sidebar::SidebarPanelBase::getWindow ( )

overridevirtual

Definition at line 151 of file SidebarPanelBase.cxx.

◆ notifyContextChangeEvent()

void SAL_CALL sfx2::sidebar::SidebarPanelBase::notifyContextChangeEvent ( const css::ui::ContextChangeEventObject & rEvent )

overridevirtual

Definition at line 99 of file SidebarPanelBase.cxx.

References vcl::EnumContext::GetApplicationEnum(), vcl::EnumContext::GetContextEnum(), and mxControl.

◆ operator=()

SidebarPanelBase & sfx2::sidebar::SidebarPanelBase::operator= ( const SidebarPanelBase & )

privatedelete

◆ SetParentPanel()

void sfx2::sidebar::SidebarPanelBase::SetParentPanel ( sfx2::sidebar::Panel * pPanel )

Definition at line 75 of file SidebarPanelBase.cxx.

References mxControl.

Referenced by sfx2::sidebar::Panel::SetUIElement().

◆ updateModel()

void SAL_CALL sfx2::sidebar::SidebarPanelBase::updateModel ( const css::uno::Reference< css::frame::XModel > & xModel )

overridevirtual

Definition at line 185 of file SidebarPanelBase.cxx.

References mxControl, and xModel.

Member Data Documentation

◆ maLayoutSize

const css::ui::LayoutSize sfx2::sidebar::SidebarPanelBase::maLayoutSize

private

Definition at line 97 of file SidebarPanelBase.hxx.

Referenced by getHeightForWidth().

◆ msResourceURL

const OUString sfx2::sidebar::SidebarPanelBase::msResourceURL

private

Definition at line 96 of file SidebarPanelBase.hxx.

Referenced by getResourceURL().

◆ mxControl

std::unique_ptr<PanelLayout> sfx2::sidebar::SidebarPanelBase::mxControl

private

Definition at line 95 of file SidebarPanelBase.hxx.

Referenced by disposing(), getHeightForWidth(), getMinimalWidth(), notifyContextChangeEvent(), SetParentPanel(), and updateModel().

◆ mxFrame

css::uno::Reference<css::frame::XFrame> sfx2::sidebar::SidebarPanelBase::mxFrame

private

Definition at line 94 of file SidebarPanelBase.hxx.

Referenced by disposing(), getFrame(), and SidebarPanelBase().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SidebarPanelBase() [1/2]

◆ ~SidebarPanelBase()

◆ SidebarPanelBase() [2/2]

Member Function Documentation

◆ Create()

◆ createAccessible()

◆ disposing() [1/2]

◆ disposing() [2/2]

◆ getFrame()

◆ getHeightForWidth()

◆ getMinimalWidth()

◆ getRealInterface()

◆ getResourceURL()

◆ getType()

◆ getWindow()

◆ notifyContextChangeEvent()

◆ operator=()

◆ SetParentPanel()

◆ updateModel()

Member Data Documentation

◆ maLayoutSize

◆ msResourceURL

◆ mxControl

◆ mxFrame