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

CAccHyperLink implements IAccessibleHyperlink interface. More...

#include <AccHyperLink.h>

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

Public Member Functions

 CAccHyperLink ()
 
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_name (long actionIndex, BSTR __RPC_FAR *name) override
 
STDMETHOD() get_localizedName (long actionIndex, BSTR __RPC_FAR *localizedName) override
 
STDMETHOD() get_description (long actionIndex, BSTR __RPC_FAR *description) override
 Gets description of specified action. More...
 
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() get_anchor (long index, VARIANT __RPC_FAR *anchor) override
 get an object More...
 
STDMETHOD() get_anchorTarget (long index, VARIANT __RPC_FAR *anchorTarget) override
 get an object More...
 
STDMETHOD() get_startIndex (long __RPC_FAR *index) override
 Get start index. More...
 
STDMETHOD() get_endIndex (long __RPC_FAR *index) override
 Get start index. More...
 
STDMETHOD() get_valid (boolean __RPC_FAR *valid) override
 Judge if the hyperlink is valid. More...
 
STDMETHOD() put_XInterface (hyper pXInterface) override
 Put UNO interface. 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)
 

Private Member Functions

css::accessibility::XAccessibleHyperlink * GetXInterface ()
 

Private Attributes

css::uno::Reference< css::accessibility::XAccessibleHyperlink > pRXLink
 

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

CAccHyperLink implements IAccessibleHyperlink interface.

Definition at line 31 of file AccHyperLink.h.

Constructor & Destructor Documentation

◆ CAccHyperLink()

CAccHyperLink::CAccHyperLink ( )
inline

Definition at line 38 of file AccHyperLink.h.

Member Function Documentation

◆ doAction()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHyperLink::doAction ( long  actionIndex)
override

Performs specified action on the object.

Parameters
actionIndexthe index of action.

Implements IAccessibleAction.

Definition at line 50 of file AccHyperLink.cxx.

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

◆ get_anchor()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHyperLink::get_anchor ( long  index,
VARIANT __RPC_FAR *  anchor 
)
override

get an object

Parameters

return Result.

Definition at line 105 of file AccHyperLink.cxx.

References CMAccessible::ConvertAnyToVariant(), GetXInterface(), index, and pRXLink.

◆ get_anchorTarget()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHyperLink::get_anchorTarget ( long  index,
VARIANT __RPC_FAR *  anchorTarget 
)
override

get an object

Parameters

return Result.

Definition at line 137 of file AccHyperLink.cxx.

References IAccessibleHyperlink::anchorTarget, CMAccessible::ConvertAnyToVariant(), GetXInterface(), index, and pRXLink.

◆ get_description()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHyperLink::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 62 of file AccHyperLink.cxx.

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

◆ get_endIndex()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHyperLink::get_endIndex ( long __RPC_FAR *  index)
override

Get start index.

Parameters
indexVariant to get end index.
Returns
Result.

Definition at line 193 of file AccHyperLink.cxx.

References GetXInterface(), index, and pRXLink.

◆ get_keyBinding()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHyperLink::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 90 of file AccHyperLink.cxx.

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

◆ get_localizedName()

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

◆ get_name()

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

◆ get_startIndex()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHyperLink::get_startIndex ( long __RPC_FAR *  index)
override

Get start index.

Parameters
indexVariant to get start index.
Returns
Result.

Definition at line 170 of file AccHyperLink.cxx.

References GetXInterface(), and index.

◆ get_valid()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHyperLink::get_valid ( boolean __RPC_FAR *  valid)
override

Judge if the hyperlink is valid.

Parameters
validVariant to get validity.
Returns
Result.

Definition at line 221 of file AccHyperLink.cxx.

References GetXInterface(), pRXLink, and IAccessibleHyperlink::valid.

◆ GetXInterface()

css::accessibility::XAccessibleHyperlink * CAccHyperLink::GetXInterface ( )
inlineprivate

Definition at line 129 of file AccHyperLink.h.

Referenced by get_anchor(), get_anchorTarget(), get_endIndex(), get_startIndex(), and get_valid().

◆ nActions()

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

Returns the number of action.

Parameters
nActionsthe number of action.

Implements IAccessibleAction.

Definition at line 39 of file AccHyperLink.cxx.

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

Referenced by nActions().

◆ put_XInterface()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHyperLink::put_XInterface ( hyper  pXInterface)
override

Put UNO interface.

Parameters
pXInterfaceXAccessibleContext interface.
Returns
Result.

Implements IUNOXWrapper.

Definition at line 249 of file AccHyperLink.cxx.

References pRXLink, CUNOXWrapper::pUNOInterface, and CAccActionBase::put_XInterface().

◆ put_XSubInterface()

COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHyperLink::put_XSubInterface ( hyper  pXSubInterface)
override

Put UNO interface.

Parameters
pXSubInterfaceXAccessibleHyperlink interface.
Returns
Result.

Implements IUNOXWrapper.

Definition at line 282 of file AccHyperLink.cxx.

References CAccActionBase::pRXAct, and pRXLink.

◆ SmartQI()

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

Definition at line 63 of file AccHyperLink.h.

◆ SmartQI_()

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

Definition at line 57 of file AccHyperLink.h.

Member Data Documentation

◆ pRXLink

css::uno::Reference<css::accessibility::XAccessibleHyperlink> CAccHyperLink::pRXLink
private

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