LibreOffice Module svx (master)  1
Public Member Functions | Private Attributes | List of all members
svx::ControllerFeatures Class Referencefinal

easier access to a FormControllerHelper instance More...

#include <formcontrolling.hxx>

Collaboration diagram for svx::ControllerFeatures:
[legend]

Public Member Functions

 ControllerFeatures (IControllerFeatureInvalidation *_pInvalidationCallback)
 standard ctor More...
 
 ControllerFeatures (const css::uno::Reference< css::form::runtime::XFormController > &_rxController)
 constructs the instance from a <type scope="css::form::runtime">XFormController<type> instance More...
 
 ~ControllerFeatures ()
 dtor More...
 
bool isAssigned () const
 checks whether the instance is properly assigned to a form and/or controller More...
 
void assign (const css::uno::Reference< css::form::runtime::XFormController > &_rxController)
 assign to a controller More...
 
void dispose ()
 clears the instance so that it cannot be used afterwards More...
 
const FormControllerHelperoperator-> () const
 
FormControllerHelperoperator-> ()
 

Private Attributes

IControllerFeatureInvalidation *const m_pInvalidationCallback
 
rtl::Reference< FormControllerHelperm_pImpl
 

Detailed Description

easier access to a FormControllerHelper instance

Definition at line 72 of file formcontrolling.hxx.

Constructor & Destructor Documentation

svx::ControllerFeatures::ControllerFeatures ( IControllerFeatureInvalidation _pInvalidationCallback)

standard ctor

The instance is not functional until <method>assign</method> is used.

Parameters
_pInvalidationCallbackthe callback for invalidating feature states

Definition at line 181 of file formcontrolling.cxx.

svx::ControllerFeatures::ControllerFeatures ( const css::uno::Reference< css::form::runtime::XFormController > &  _rxController)

constructs the instance from a <type scope="css::form::runtime">XFormController<type> instance

Parameters
_rxControllerThe form controller which the helper should be responsible for. Must not be <NULL>, and must have a valid model (form).
svx::ControllerFeatures::~ControllerFeatures ( )

dtor

Definition at line 201 of file formcontrolling.cxx.

References dispose().

Member Function Documentation

void svx::ControllerFeatures::assign ( const css::uno::Reference< css::form::runtime::XFormController > &  _rxController)

assign to a controller

Definition at line 194 of file formcontrolling.cxx.

References dispose(), m_pImpl, and m_pInvalidationCallback.

Referenced by FmXFormShell::setActiveController_Lock(), and FmXFormShell::startListening_Lock().

void svx::ControllerFeatures::dispose ( void  )

clears the instance so that it cannot be used afterwards

Definition at line 207 of file formcontrolling.cxx.

References m_pImpl.

Referenced by assign(), FmXFormShell::disposing(), FmXFormShell::setActiveController_Lock(), FmXFormShell::startListening_Lock(), and ~ControllerFeatures().

bool svx::ControllerFeatures::isAssigned ( ) const
inline

checks whether the instance is properly assigned to a form and/or controller

Definition at line 103 of file formcontrolling.hxx.

Referenced by FmXFormShell::getNavControllerFeatures_Lock().

const FormControllerHelper* svx::ControllerFeatures::operator-> ( ) const
inline

Definition at line 115 of file formcontrolling.hxx.

FormControllerHelper* svx::ControllerFeatures::operator-> ( )
inline

Definition at line 116 of file formcontrolling.hxx.

Member Data Documentation

rtl::Reference<FormControllerHelper> svx::ControllerFeatures::m_pImpl
private

Definition at line 75 of file formcontrolling.hxx.

Referenced by assign(), and dispose().

IControllerFeatureInvalidation* const svx::ControllerFeatures::m_pInvalidationCallback
private

Definition at line 74 of file formcontrolling.hxx.

Referenced by assign().


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