LibreOffice Module winaccessibility (master) 1
Public Member Functions | Static Public Member Functions | List of all members
CAccAction Class Reference

CAccAction implements IAccessibleAction interface. More...

#include <AccAction.h>

Inheritance diagram for CAccAction:
[legend]
Collaboration diagram for CAccAction:
[legend]

Public Member Functions

 CAccAction ()
 
HRESULT SmartQI (REFIID iid, void **ppvObject)
 
STDMETHOD() nActions (long *nActions) override
 Returns the number of action. More...
 
STDMETHOD() doAction (long actionIndex) override
 Performs specified action on the object. More...
 
STDMETHOD() get_description (long actionIndex, BSTR __RPC_FAR *description) override
 Gets description of specified action. More...
 
STDMETHOD() get_name (long actionIndex, BSTR __RPC_FAR *name) override
 
STDMETHOD() get_localizedName (long actionIndex, BSTR __RPC_FAR *localizedName) override
 
STDMETHOD() get_keyBinding (long actionIndex, long nMaxBinding, BSTR __RPC_FAR *__RPC_FAR *keyBinding, long __RPC_FAR *nBinding) override
 Returns key binding object (if any) associated with specified action key binding is string. More...
 
STDMETHOD() put_XSubInterface (hyper pXSubInterface) override
 Put UNO interface. More...
 
HRESULT nActions ([out, retval] long *nActions)
 Returns the number of accessible actions available in this object. More...
 
HRESULT doAction ([in] long actionIndex)
 Performs the specified Action on the object. More...
 
- Public Member Functions inherited from CAccActionBase
 CAccActionBase ()
 
virtual ~CAccActionBase ()
 
STDMETHOD() nActions (long *nActions)
 Returns the number of action. More...
 
STDMETHOD() doAction (long actionIndex)
 Performs specified action on the object. More...
 
STDMETHOD() get_description (long actionIndex, BSTR __RPC_FAR *description)
 Gets description of specified action. More...
 
STDMETHOD() get_name (long actionIndex, BSTR __RPC_FAR *name)
 
STDMETHOD() get_localizedName (long actionIndex, BSTR __RPC_FAR *localizedName)
 
STDMETHOD() put_XInterface (hyper pXInterface) override
 Override of IUNOXWrapper. More...
 
- Public Member Functions inherited from CUNOXWrapper
 CUNOXWrapper ()
 
STDMETHOD() put_XInterface (hyper pXInterface) override
 
STDMETHOD() put_XSubInterface (hyper) override
 
HRESULT put_XInterface (hyper pXInterface)
 
HRESULT put_XSubInterface (hyper pXSubInterface)
 

Static Public Member Functions

static HRESULT WINAPI SmartQI_ (void *pv, REFIID iid, void **ppvObject, DWORD_PTR)
 

Additional Inherited Members

- Public Attributes inherited from CAccActionBase
long actionIndex
 
long long nMaxBinding
 
long long BSTR __RPC_FAR *__RPC_FAR * keyBinding
 
long long BSTR __RPC_FAR *__RPC_FAR long __RPC_FAR * nBinding
 
- Protected Member Functions inherited from CUNOXWrapper
 ~CUNOXWrapper ()
 
- Protected Attributes inherited from CAccActionBase
css::uno::Reference< css::accessibility::XAccessibleAction > pRXAct
 
- Protected Attributes inherited from CUNOXWrapper
css::accessibility::XAccessible * pUNOInterface
 
- Properties inherited from IAccessibleAction
BSTR description ([in] long actionIndex) [get]
 Returns a description of the specified action of the object. More...
 
long keyBinding ([in] long actionIndex,[in] long nMaxBindings,[out, size_is(, nMaxBindings), length_is(, *nBindings)] BSTR keyBindings) [get]
 Returns an array of BSTRs describing one or more key bindings, if there are any, associated with the specified action. More...
 
BSTR name ([in] long actionIndex) [get]
 Returns the non-localized name of specified action. More...
 
BSTR localizedName ([in] long actionIndex) [get]
 Returns the localized name of specified action. More...
 

Detailed Description

CAccAction implements IAccessibleAction interface.

Definition at line 28 of file AccAction.h.

Constructor & Destructor Documentation

◆ CAccAction()

CAccAction::CAccAction ( )
inline

Definition at line 35 of file AccAction.h.

Member Function Documentation

◆ doAction()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccAction::doAction ( long  actionIndex)
override

Performs specified action on the object.

Parameters
actionIndexthe index of action.

Implements IAccessibleAction.

Definition at line 46 of file AccAction.cxx.

References CAccActionBase::actionIndex, and CAccActionBase::doAction().

◆ get_description()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccAction::get_description ( long  actionIndex,
BSTR __RPC_FAR *  description 
)
override

Gets description of specified action.

Parameters
actionIndexthe index of action.
descriptionthe description string of the specified action.

Definition at line 58 of file AccAction.cxx.

References CAccActionBase::actionIndex, IAccessibleAction::description, and CAccActionBase::get_description().

◆ get_keyBinding()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccAction::get_keyBinding ( long  actionIndex,
long  nMaxBinding,
BSTR __RPC_FAR *__RPC_FAR *  keyBinding,
long __RPC_FAR *  nBinding 
)
override

Returns key binding object (if any) associated with specified action key binding is string.

e.g. "alt+d" (like IAccessible::get_accKeyboardShortcut).

Parameters
actionIndexthe index of action.
nMaxBindingthe max number of key binding.
keyBindingthe key binding array.
nBindingthe actual number of key binding returned.

Definition at line 86 of file AccAction.cxx.

References CAccActionBase::actionIndex, CAccActionBase::keyBinding, CAccActionBase::nBinding, and CAccActionBase::nMaxBinding.

◆ get_localizedName()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccAction::get_localizedName ( long  actionIndex,
BSTR __RPC_FAR *  localizedName 
)
override

◆ get_name()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccAction::get_name ( long  actionIndex,
BSTR __RPC_FAR *  name 
)
override

◆ nActions()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccAction::nActions ( long *  nActions)
override

Returns the number of action.

Parameters
nActionsthe number of action.

Implements IAccessibleAction.

Definition at line 35 of file AccAction.cxx.

References CAccActionBase::nActions(), and nActions().

Referenced by nActions().

◆ put_XSubInterface()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccAction::put_XSubInterface ( hyper  pXSubInterface)
override

Put UNO interface.

Parameters
pXSubInterfaceXAccessibleHyperlink interface.
Returns
Result.

Implements IUNOXWrapper.

Definition at line 101 of file AccAction.cxx.

References CAccActionBase::pRXAct.

◆ SmartQI()

HRESULT CAccAction::SmartQI ( REFIID  iid,
void **  ppvObject 
)
inline

Definition at line 61 of file AccAction.h.

◆ SmartQI_()

static HRESULT WINAPI CAccAction::SmartQI_ ( void *  pv,
REFIID  iid,
void **  ppvObject,
DWORD_PTR   
)
inlinestatic

Definition at line 55 of file AccAction.h.


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