LibreOffice Module dbaccess (master) 1
Public Member Functions | Protected Member Functions | List of all members
dbaui::IController Class Referenceabstract

#include <IController.hxx>

Inheritance diagram for dbaui::IController:
[legend]

Public Member Functions

virtual void executeUnChecked (const css::util::URL &_rCommand, const css::uno::Sequence< css::beans::PropertyValue > &aArgs)=0
 executes the given command without checking if it is allowed More...
 
virtual void executeChecked (const css::util::URL &_rCommand, const css::uno::Sequence< css::beans::PropertyValue > &aArgs)=0
 executes the given command only when it is allowed More...
 
virtual void executeUnChecked (sal_uInt16 _nCommandId, const css::uno::Sequence< css::beans::PropertyValue > &aArgs)=0
 executes the given command without checking if it is allowed More...
 
virtual void executeChecked (sal_uInt16 _nCommandId, const css::uno::Sequence< css::beans::PropertyValue > &aArgs)=0
 executes the given command only when it is allowed More...
 
virtual bool isCommandEnabled (sal_uInt16 _nCommandId) const =0
 checks if the given Command is enabled More...
 
virtual bool isCommandEnabled (const OUString &_rCompleteCommandURL) const =0
 checks if the given Command is enabled More...
 
virtual bool isDataSourceReadOnly () const =0
 checks if the selected data source is read only More...
 
virtual css::uno::Reference< css::frame::XController > getXController ()=0
 provides access to the model of the controller More...
 
virtual bool interceptUserInput (const NotifyEvent &_rEvent)=0
 allows interception of user input, aka mouse clicks and key events More...
 
virtual void SAL_CALL acquire () noexcept=0
 
virtual void SAL_CALL release () noexcept=0
 

Protected Member Functions

 ~IController ()
 

Detailed Description

Definition at line 46 of file IController.hxx.

Constructor & Destructor Documentation

◆ ~IController()

dbaui::IController::~IController ( )
inlineprotected

Definition at line 115 of file IController.hxx.

Member Function Documentation

◆ acquire()

virtual void SAL_CALL dbaui::IController::acquire ( )
pure virtualnoexcept

◆ executeChecked() [1/2]

virtual void dbaui::IController::executeChecked ( const css::util::URL &  _rCommand,
const css::uno::Sequence< css::beans::PropertyValue > &  aArgs 
)
pure virtual

executes the given command only when it is allowed

Parameters
_rCommandthe URL of the command

Implemented in dbaui::OGenericUnoController.

◆ executeChecked() [2/2]

virtual void dbaui::IController::executeChecked ( sal_uInt16  _nCommandId,
const css::uno::Sequence< css::beans::PropertyValue > &  aArgs 
)
pure virtual

executes the given command only when it is allowed

Parameters
_nCommandIdthe id of the command URL

Implemented in dbaui::OGenericUnoController.

◆ executeUnChecked() [1/2]

virtual void dbaui::IController::executeUnChecked ( const css::util::URL &  _rCommand,
const css::uno::Sequence< css::beans::PropertyValue > &  aArgs 
)
pure virtual

executes the given command without checking if it is allowed

Parameters
_rCommandthe URL of the command

Implemented in dbaui::OGenericUnoController.

◆ executeUnChecked() [2/2]

virtual void dbaui::IController::executeUnChecked ( sal_uInt16  _nCommandId,
const css::uno::Sequence< css::beans::PropertyValue > &  aArgs 
)
pure virtual

executes the given command without checking if it is allowed

Parameters
_nCommandIdthe id of the command URL

Implemented in dbaui::OGenericUnoController.

◆ getXController()

virtual css::uno::Reference< css::frame::XController > dbaui::IController::getXController ( )
pure virtual

provides access to the model of the controller

This must be the same model as returned by XController::getModel, and might be <NULL> when the controller does not have an own model.

Exceptions
css::uno::RuntimeException

Implemented in dbaui::OGenericUnoController.

Referenced by dbaui::lcl_notifyFocusChange_nothrow(), dbaui::lcl_setFrame_nothrow(), and dbaui::lcl_updateActiveComponents_nothrow().

◆ interceptUserInput()

virtual bool dbaui::IController::interceptUserInput ( const NotifyEvent _rEvent)
pure virtual

allows interception of user input, aka mouse clicks and key events

Implemented in dbaui::OGenericUnoController.

◆ isCommandEnabled() [1/2]

virtual bool dbaui::IController::isCommandEnabled ( const OUString &  _rCompleteCommandURL) const
pure virtual

checks if the given Command is enabled

Parameters
_rCompleteCommandURLthe URL of the command
Returns
<TRUE> if the command is allowed, otherwise <FALSE>.

Implemented in dbaui::OGenericUnoController.

◆ isCommandEnabled() [2/2]

virtual bool dbaui::IController::isCommandEnabled ( sal_uInt16  _nCommandId) const
pure virtual

checks if the given Command is enabled

Parameters
_nCommandIdthe id of the command URL
Returns
<TRUE> if the command is allowed, otherwise <FALSE>.

Implemented in dbaui::OGenericUnoController.

Referenced by dbaui::OApplicationDetailView::impl_createPage().

◆ isDataSourceReadOnly()

virtual bool dbaui::IController::isDataSourceReadOnly ( ) const
pure virtual

checks if the selected data source is read only

Returns
<TRUE> if read only, otherwise <FALSE>

Implemented in dbaui::OApplicationController, and dbaui::OGenericUnoController.

Referenced by dbaui::OApplicationDetailView::OApplicationDetailView().

◆ release()

virtual void SAL_CALL dbaui::IController::release ( )
pure virtualnoexcept

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