LibreOffice Module forms (master) 1
Public Member Functions | Protected Member Functions | List of all members
frm::IFeatureDispatcher Class Referenceabstract

#include <featuredispatcher.hxx>

Inheritance diagram for frm::IFeatureDispatcher:
[legend]

Public Member Functions

virtual void dispatch (sal_Int16 _nFeatureId) const =0
 dispatches a feature More...
 
virtual void dispatchWithArgument (sal_Int16 _nFeatureId, const char *_pParamName, const css::uno::Any &_rParamValue) const =0
 dispatches a feature, with an additional named parameter More...
 
virtual bool isEnabled (sal_Int16 _nFeatureId) const =0
 checks whether a given feature is enabled More...
 
virtual bool getBooleanState (sal_Int16 _nFeatureId) const =0
 returns the boolean state of a feature More...
 
virtual OUString getStringState (sal_Int16 _nFeatureId) const =0
 returns the string state of a feature More...
 
virtual sal_Int32 getIntegerState (sal_Int16 _nFeatureId) const =0
 returns the integer state of a feature More...
 

Protected Member Functions

 ~IFeatureDispatcher ()
 

Detailed Description

Definition at line 29 of file inc/featuredispatcher.hxx.

Constructor & Destructor Documentation

◆ ~IFeatureDispatcher()

frm::IFeatureDispatcher::~IFeatureDispatcher ( )
inlineprotected

Definition at line 94 of file inc/featuredispatcher.hxx.

Member Function Documentation

◆ dispatch()

virtual void frm::IFeatureDispatcher::dispatch ( sal_Int16  _nFeatureId) const
pure virtual

dispatches a feature

Parameters
_nFeatureIdthe id of the feature to dispatch

Implemented in frm::OFormNavigationHelper.

Referenced by frm::ImplNavToolBar::Select().

◆ dispatchWithArgument()

virtual void frm::IFeatureDispatcher::dispatchWithArgument ( sal_Int16  _nFeatureId,
const char *  _pParamName,
const css::uno::Any &  _rParamValue 
) const
pure virtual

dispatches a feature, with an additional named parameter

Parameters
_nFeatureIdthe id of the feature to dispatch
_pParamAsciiNamethe Ascii name of the parameter of the dispatch call
_rParamValuethe value of the parameter of the dispatch call

Implemented in frm::OFormNavigationHelper.

Referenced by frm::RecordPositionInput::PositionFired().

◆ getBooleanState()

virtual bool frm::IFeatureDispatcher::getBooleanState ( sal_Int16  _nFeatureId) const
pure virtual

returns the boolean state of a feature

Certain features may support more status information than only the enabled/disabled state. The type of such additional information is fixed relative to a given feature, but may differ between different features.

This method allows retrieving status information about features which have an additional boolean information associated with it.

Implemented in frm::OFormNavigationHelper.

◆ getIntegerState()

virtual sal_Int32 frm::IFeatureDispatcher::getIntegerState ( sal_Int16  _nFeatureId) const
pure virtual

returns the integer state of a feature

Certain features may support more status information than only the enabled/disabled state. The type of such additional information is fixed relative to a given feature, but may differ between different features.

This method allows retrieving status information about features which have an additional integer information associated with it.

Implemented in frm::OFormNavigationHelper.

◆ getStringState()

virtual OUString frm::IFeatureDispatcher::getStringState ( sal_Int16  _nFeatureId) const
pure virtual

returns the string state of a feature

Certain features may support more status information than only the enabled/disabled state. The type of such additional information is fixed relative to a given feature, but may differ between different features.

This method allows retrieving status information about features which have an additional string information associated with it.

Implemented in frm::OFormNavigationHelper.

◆ isEnabled()

virtual bool frm::IFeatureDispatcher::isEnabled ( sal_Int16  _nFeatureId) const
pure virtual

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