helper class to encapsulate the frame which a controller is plugged into, doing some common actions on it. More...

#include <controllerframe.hxx>

Public Member Functions
	ControllerFrame (IController &_rController)

	~ControllerFrame ()

const css::uno::Reference< css::frame::XFrame > &	attachFrame (const css::uno::Reference< css::frame::XFrame > &_rxFrame)
	attaches a new frame More...

const css::uno::Reference< css::frame::XFrame > &	getFrame () const

bool	isActive () const
	determines whether the frame is currently active More...

void	frameAction (css::frame::FrameAction _eAction)
	notifies the instance that a certain frame action happened with our frame More...

Private Attributes
::std::unique_ptr< ControllerFrame_Data >	m_pData

Detailed Description

helper class to encapsulate the frame which a controller is plugged into, doing some common actions on it.

Definition at line 45 of file controllerframe.hxx.

Constructor & Destructor Documentation

◆ ControllerFrame()

dbaui::ControllerFrame::ControllerFrame ( IController & _rController )

Definition at line 327 of file controllerframe.cxx.

◆ ~ControllerFrame()

dbaui::ControllerFrame::~ControllerFrame ( )

Definition at line 332 of file controllerframe.cxx.

Member Function Documentation

◆ attachFrame()

const Reference< XFrame > & dbaui::ControllerFrame::attachFrame ( const css::uno::Reference< css::frame::XFrame > & _rxFrame )

attaches a new frame

Definition at line 336 of file controllerframe.cxx.

References dbaui::lcl_isActive_nothrow(), dbaui::lcl_notifyFocusChange_nothrow(), dbaui::lcl_setFrame_nothrow(), dbaui::lcl_updateActiveComponents_nothrow(), and m_pData.

Referenced by dbaui::OGenericUnoController::attachFrame(), and dbaui::OGenericUnoController::disposing().

◆ frameAction()

void dbaui::ControllerFrame::frameAction ( css::frame::FrameAction _eAction )

notifies the instance that a certain frame action happened with our frame

Definition at line 364 of file controllerframe.cxx.

References dbaui::lcl_updateActive_nothrow(), and m_pData.

Referenced by dbaui::OGenericUnoController::frameAction().

◆ getFrame()

const Reference< XFrame > & dbaui::ControllerFrame::getFrame ( ) const

Definition at line 354 of file controllerframe.cxx.

References m_pData.

Referenced by dbaui::OGenericUnoController::attachFrame(), dbaui::OGenericUnoController::disposing(), dbaui::OApplicationController::Execute(), dbaui::OGenericUnoController::frameAction(), dbaui::OGenericUnoController::getFrame(), dbaui::OGenericUnoController::getTopMostContainerWindow(), and dbaui::OApplicationController::openElementWithArguments().

◆ isActive()

bool dbaui::ControllerFrame::isActive ( ) const

determines whether the frame is currently active

Definition at line 359 of file controllerframe.cxx.

References m_pData.

Member Data Documentation

◆ m_pData

::std::unique_ptr< ControllerFrame_Data > dbaui::ControllerFrame::m_pData

private

Definition at line 70 of file controllerframe.hxx.

Referenced by attachFrame(), frameAction(), getFrame(), and isActive().

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

Public Member Functions

Private Attributes