a helper class for implementing an AccessibleExtendedComponent which at the same time supports an XAccessibleText interface More...

#include <accessibletexthelper.hxx>

Inheritance diagram for comphelper::OAccessibleTextHelper:

[legend]

Collaboration diagram for comphelper::OAccessibleTextHelper:

[legend]

Public Member Functions
virtual OUString SAL_CALL	getSelectedText () override

virtual sal_Int32 SAL_CALL	getSelectionStart () override

virtual sal_Int32 SAL_CALL	getSelectionEnd () override

virtual css::accessibility::TextSegment SAL_CALL	getTextAtIndex (sal_Int32 nIndex, sal_Int16 aTextType) override

virtual css::accessibility::TextSegment SAL_CALL	getTextBeforeIndex (sal_Int32 nIndex, sal_Int16 aTextType) override

virtual css::accessibility::TextSegment SAL_CALL	getTextBehindIndex (sal_Int32 nIndex, sal_Int16 aTextType) override

Public Member Functions inherited from comphelper::OAccessibleExtendedComponentHelper
virtual sal_Bool SAL_CALL	containsPoint (const css::awt::Point &aPoint) override

virtual css::awt::Point SAL_CALL	getLocation () override

virtual css::awt::Point SAL_CALL	getLocationOnScreen () override

virtual css::awt::Size SAL_CALL	getSize () override

virtual css::awt::Rectangle SAL_CALL	getBounds () override

Public Member Functions inherited from comphelper::OAccessibleContextHelper
virtual void SAL_CALL	addAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &xListener) override

virtual void SAL_CALL	removeAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &xListener) override

virtual sal_Int32 SAL_CALL	getAccessibleChildCount () override=0

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleChild (sal_Int32 i) override=0

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleParent () override=0

virtual sal_Int16 SAL_CALL	getAccessibleRole () override=0

virtual OUString SAL_CALL	getAccessibleDescription () override=0

virtual OUString SAL_CALL	getAccessibleName () override=0

virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL	getAccessibleRelationSet () override=0

virtual sal_Int64 SAL_CALL	getAccessibleStateSet () override=0

virtual OUString SAL_CALL	getAccessibleId () override

virtual sal_Int32 SAL_CALL	getAccessibleIndexInParent () override
	default implementation for retrieving the index of this object within the parent More...

virtual css::lang::Locale SAL_CALL	getLocale () override
	default implementation for retrieving the locale More...

Public Member Functions inherited from cppu::WeakAggComponentImplHelper2< class Ifc1, class Ifc2 >
	WeakAggComponentImplHelper2 (::osl::Mutex &rMutex) SAL_NOEXCEPT

virtual css::uno::Any SAL_CALL	queryInterface (css::uno::Type const &rType) SAL_OVERRIDE

virtual css::uno::Any SAL_CALL	queryAggregation (css::uno::Type const &rType) SAL_OVERRIDE

virtual void SAL_CALL	acquire () SAL_NOEXCEPT SAL_OVERRIDE

virtual void SAL_CALL	release () SAL_NOEXCEPT SAL_OVERRIDE

virtual css::uno::Sequence< css::uno::Type > SAL_CALL	getTypes () SAL_OVERRIDE

virtual css::uno::Sequence< sal_Int8 > SAL_CALL	getImplementationId () SAL_OVERRIDE

Public Member Functions inherited from cppu::ImplHelper1< class Ifc1 >
virtual css::uno::Any SAL_CALL	queryInterface (css::uno::Type const &rType) SAL_OVERRIDE

virtual css::uno::Sequence< css::uno::Type > SAL_CALL	getTypes () SAL_OVERRIDE

virtual css::uno::Sequence< sal_Int8 > SAL_CALL	getImplementationId () SAL_OVERRIDE

Protected Member Functions
	OAccessibleTextHelper ()

Protected Member Functions inherited from comphelper::OAccessibleExtendedComponentHelper
	OAccessibleExtendedComponentHelper ()

Protected Member Functions inherited from comphelper::OCommonAccessibleComponent
	OCommonAccessibleComponent ()
	see the respective base class ctor for an extensive comment on this, please More...

virtual	~OCommonAccessibleComponent () override

virtual css::awt::Rectangle	implGetBounds ()=0
	implements the calculation of the bounding rectangle - still waiting to be overwritten More...

bool	containsPoint (const css::awt::Point &aPoint)
	non-virtual versions of the methods which can be implemented using <method>implGetBounds</method> note: getLocationOnScreen relies on a valid parent (XAccessibleContext::getParent()->getAccessibleContext()), which itself implements XAccessibleComponent More...

css::awt::Point	getLocation ()

css::awt::Point	getLocationOnScreen ()

css::awt::Size	getSize ()

css::awt::Rectangle	getBounds ()

Protected Member Functions inherited from comphelper::OAccessibleContextHelper
virtual	~OAccessibleContextHelper () override

	OAccessibleContextHelper ()

void	lateInit (const css::uno::Reference< css::accessibility::XAccessible > &_rxAccessible)
	late construction More...

css::uno::Reference< css::accessibility::XAccessible >	getAccessibleCreator () const
	retrieves the creator previously set with <method>lateInit</method> More...

virtual void SAL_CALL	disposing () override

void	NotifyAccessibleEvent (const sal_Int16 _nEventId, const css::uno::Any &_rOldValue, const css::uno::Any &_rNewValue)
	notifies all AccessibleEventListeners of a certain event More...

bool	isAlive () const
	checks whether the object is alive (returns <TRUE> then) or disposed More...

void	ensureAlive () const
	checks for being alive. If the object is already disposed (i.e. not alive), an exception is thrown. More...

void	ensureDisposed ()
	ensures that the object is disposed. More...

css::uno::Reference< css::accessibility::XAccessibleContext >	implGetParentContext ()
	shortcut for retrieving the context of the parent (returned by getAccessibleParent) More...

::osl::Mutex &	GetMutex ()

Protected Member Functions inherited from cppu::ImplHelper1< class Ifc1 >
	~ImplHelper1 () SAL_NOEXCEPT

Protected Member Functions inherited from comphelper::OCommonAccessibleText
	OCommonAccessibleText ()

virtual	~OCommonAccessibleText ()

css::uno::Reference< css::i18n::XBreakIterator > const &	implGetBreakIterator ()

css::uno::Reference< css::i18n::XCharacterClassification > const &	implGetCharacterClassification ()

virtual OUString	implGetText ()=0

virtual css::lang::Locale	implGetLocale ()=0

virtual void	implGetSelection (sal_Int32 &nStartIndex, sal_Int32 &nEndIndex)=0

void	implGetGlyphBoundary (const OUString &rText, css::i18n::Boundary &rBoundary, sal_Int32 nIndex)

bool	implGetWordBoundary (const OUString &rText, css::i18n::Boundary &rBoundary, sal_Int32 nIndex)

void	implGetSentenceBoundary (const OUString &rText, css::i18n::Boundary &rBoundary, sal_Int32 nIndex)

virtual void	implGetParagraphBoundary (const OUString &rText, css::i18n::Boundary &rBoundary, sal_Int32 nIndex)

virtual void	implGetLineBoundary (const OUString &rText, css::i18n::Boundary &rBoundary, sal_Int32 nIndex)

OUString	getSelectedText ()
	non-virtual versions of the methods More...

sal_Int32	getSelectionStart ()

sal_Int32	getSelectionEnd ()

css::accessibility::TextSegment	getTextAtIndex (sal_Int32 nIndex, sal_Int16 aTextType)

css::accessibility::TextSegment	getTextBeforeIndex (sal_Int32 nIndex, sal_Int16 aTextType)

css::accessibility::TextSegment	getTextBehindIndex (sal_Int32 nIndex, sal_Int16 aTextType)

Additional Inherited Members
Static Public Member Functions inherited from comphelper::OCommonAccessibleText
static bool	implInitTextChangedEvent (std::u16string_view rOldString, std::u16string_view rNewString, css::uno::Any &rDeleted, css::uno::Any &rInserted)
	Helper method, that detects the difference between two strings and returns the deleted selection and the inserted selection if available. More...

Static Protected Member Functions inherited from comphelper::OCommonAccessibleText
static bool	implIsValidBoundary (css::i18n::Boundary const &rBoundary, sal_Int32 nLength)

static bool	implIsValidIndex (sal_Int32 nIndex, sal_Int32 nLength)

static bool	implIsValidRange (sal_Int32 nStartIndex, sal_Int32 nEndIndex, sal_Int32 nLength)

static sal_Unicode	implGetCharacter (std::u16string_view rText, sal_Int32 nIndex)

static OUString	implGetTextRange (std::u16string_view rText, sal_Int32 nStartIndex, sal_Int32 nEndIndex)

Protected Attributes inherited from cppu::BaseMutex
mutable::osl::Mutex	m_aMutex

Detailed Description

a helper class for implementing an AccessibleExtendedComponent which at the same time supports an XAccessibleText interface

Definition at line 120 of file accessibletexthelper.hxx.

Constructor & Destructor Documentation

◆ OAccessibleTextHelper()

comphelper::OAccessibleTextHelper::OAccessibleTextHelper ( )

protected

Definition at line 729 of file accessibletexthelper.cxx.

Member Function Documentation

◆ getSelectedText()

OUString comphelper::OAccessibleTextHelper::getSelectedText ( )

overridevirtual

Definition at line 749 of file accessibletexthelper.cxx.

References comphelper::OCommonAccessibleText::getSelectedText().

◆ getSelectionEnd()

sal_Int32 comphelper::OAccessibleTextHelper::getSelectionEnd ( )

overridevirtual

Definition at line 765 of file accessibletexthelper.cxx.

References comphelper::OCommonAccessibleText::getSelectionEnd().

◆ getSelectionStart()

sal_Int32 comphelper::OAccessibleTextHelper::getSelectionStart ( )

overridevirtual

Definition at line 757 of file accessibletexthelper.cxx.

References comphelper::OCommonAccessibleText::getSelectionStart().

◆ getTextAtIndex()

TextSegment comphelper::OAccessibleTextHelper::getTextAtIndex	(	sal_Int32	nIndex,
		sal_Int16	aTextType
	)

overridevirtual

Definition at line 773 of file accessibletexthelper.cxx.

References comphelper::OCommonAccessibleText::getTextAtIndex(), and nIndex.

◆ getTextBeforeIndex()

TextSegment comphelper::OAccessibleTextHelper::getTextBeforeIndex	(	sal_Int32	nIndex,
		sal_Int16	aTextType
	)

overridevirtual

Definition at line 781 of file accessibletexthelper.cxx.

References comphelper::OCommonAccessibleText::getTextBeforeIndex(), and nIndex.

◆ getTextBehindIndex()

TextSegment comphelper::OAccessibleTextHelper::getTextBehindIndex	(	sal_Int32	nIndex,
		sal_Int16	aTextType
	)

overridevirtual

Definition at line 789 of file accessibletexthelper.cxx.

References comphelper::OCommonAccessibleText::getTextBehindIndex(), and nIndex.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OAccessibleTextHelper()

Member Function Documentation

◆ getSelectedText()

◆ getSelectionEnd()

◆ getSelectionStart()

◆ getTextAtIndex()

◆ getTextBeforeIndex()

◆ getTextBehindIndex()