accessibility implementation for the page (SwPageFrame) The page is only visible in the page preview. More...

#include <accpage.hxx>

Inheritance diagram for SwAccessiblePage:

Collaboration diagram for SwAccessiblePage:

Public Member Functions
	SwAccessiblePage (std::shared_ptr< SwAccessibleMap > const &pInitMap, const SwFrame *pFrame)

virtual OUString SAL_CALL	getAccessibleDescription () override

virtual OUString SAL_CALL	getImplementationName () override

virtual sal_Bool SAL_CALL	supportsService (const OUString &sServiceName) override
	Return whether the specified service is supported by this class. More...

virtual css::uno::Sequence< OUString > SAL_CALL	getSupportedServiceNames () override

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

virtual bool	HasCursor () override

Public Member Functions inherited from SwAccessibleContext
void	FireAccessibleEvent (css::accessibility::AccessibleEventObject &rEvent)

	SwAccessibleContext (std::shared_ptr< SwAccessibleMap > const &pMap, sal_Int16 nRole, const SwFrame *pFrame)

virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL	getAccessibleContext () override

virtual sal_Int64 SAL_CALL	getAccessibleChildCount () override

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleChild (sal_Int64 nIndex) override

virtual css::uno::Sequence< css::uno::Reference< css::accessibility::XAccessible > > SAL_CALL	getAccessibleChildren () override

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

virtual sal_Int64 SAL_CALL	getAccessibleIndexInParent () override

virtual sal_Int16 SAL_CALL	getAccessibleRole () override

virtual OUString SAL_CALL	getAccessibleName () override

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

virtual sal_Int64 SAL_CALL	getAccessibleStateSet () override

virtual css::lang::Locale SAL_CALL	getLocale () override
	Return the parents locale or throw exception if this object has no parent yet/anymore. More...

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_Bool SAL_CALL	containsPoint (const css::awt::Point &aPoint) override

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleAtPoint (const css::awt::Point &aPoint) override

virtual css::awt::Rectangle SAL_CALL	getBounds () 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 void SAL_CALL	grabFocus () override

virtual sal_Int32 SAL_CALL	getForeground () override

virtual sal_Int32 SAL_CALL	getBackground () override

virtual sal_Bool SAL_CALL	supportsService (const OUString &sServiceName) override
	Return whether the specified service is supported by this class. More...

virtual void	Dispose (bool bRecursive, bool bCanSkipInvisible=true)

virtual void	DisposeChild (const sw::access::SwAccessibleChild &rFrameOrObj, bool bRecursive, bool bCanSkipInvisible)

virtual void	InvalidatePosOrSize (const SwRect &rFrame)

virtual void	InvalidateChildPosOrSize (const sw::access::SwAccessibleChild &rFrameOrObj, const SwRect &rFrame)

void	InvalidateContent ()

void	InvalidateCursorPos ()

void	InvalidateFocus ()

void	InvalidateStates (AccessibleStates _nStates)

void	InvalidateRelation (sal_uInt16 nType)

void	InvalidateTextSelection ()
	#i27301# - text selection has changed More...

void	InvalidateAttr ()
	#i88069# - attributes has changed More...

bool	HasAdditionalAccessibleChildren ()

vcl::Window *	GetAdditionalAccessibleChild (const sal_Int32 nIndex)
	#i88070# - get additional accessible child by index More...

void	GetAdditionalAccessibleChildren (std::vector< vcl::Window * > *pChildren)
	#i88070# - get all additional accessible children More...

const OUString &	GetName () const

virtual bool	HasCursor ()

bool	Select (SwPaM pPaM, SdrObject pObj, bool bAdd)

bool	Select (SwPaM &rPaM)

bool	Select (SdrObject *pObj, bool bAdd)

virtual bool	SetSelectedState (bool bSelected)

bool	IsSelectedInDoc () const

bool	IsDisposed () const

Public Member Functions inherited from SwAccessibleFrame
bool	IsShowing (const SwAccessibleMap &rAccMap, const sw::access::SwAccessibleChild &rFrameOrObj) const

bool	IsShowing (const SwRect &rFrame) const

bool	IsShowing (const SwAccessibleMap &rAccMap) const

const SwFrame *	GetFrame () const

sal_Int32	GetChildIndex (SwAccessibleMap &rAccMap, const sw::access::SwAccessibleChild &rChild) const

Protected Member Functions
virtual void	GetStates (sal_Int64 &rStateSet) override

virtual void	InvalidateCursorPos_ () override

virtual void	InvalidateFocus_ () override

virtual	~SwAccessiblePage () override

Protected Member Functions inherited from SwAccessibleContext
void	SetName (const OUString &rName)

sal_Int16	GetRole () const

void	SetParent (SwAccessibleContext *pParent)

css::uno::Reference< css::accessibility::XAccessible >	GetWeakParent () const

bool	IsDisposing () const

vcl::Window *	GetWindow ()

SwAccessibleMap *	GetMap ()

const SwAccessibleMap *	GetMap () const

SwViewShell *	GetShell ()
	convenience method to get the SwViewShell through accessibility map More...

const SwViewShell *	GetShell () const

SwCursorShell *	GetCursorShell ()
	convenience method to get SwCursorShell through accessibility map More...

const SwCursorShell *	GetCursorShell () const

void	ChildrenScrolled (const SwFrame *pFrame, const SwRect &rOldVisArea)

void	Scrolled (const SwRect &rOldVisArea)

void	ScrolledWithin (const SwRect &rOldVisArea)

void	ScrolledIn ()

void	ScrolledOut (const SwRect &rOldVisArea)

void	InvalidateChildrenStates (const SwFrame *_pFrame, AccessibleStates _nStates)

void	DisposeChildren (const SwFrame *pFrame, bool bRecursive, bool bCanSkipInvisible)

void	DisposeShape (const SdrObject pObj, ::accessibility::AccessibleShape pAccImpl)

void	ScrolledInShape (::accessibility::AccessibleShape *pAccImpl)

virtual void	InvalidateContent_ (bool bVisibleDataFired)

virtual void	InvalidateCursorPos_ ()

virtual void	InvalidateFocus_ ()

void	FireVisibleDataEvent ()

void	FireStateChangedEvent (sal_Int64 nState, bool bNewState)

virtual void	GetStates (sal_Int64 &rStateSet)

bool	IsEditableState ()

css::awt::Rectangle	getBoundsImpl (bool bRelative)
	Get bounding box. More...

void	NotRegisteredAtAccessibleMap ()

void	RemoveFrameFromAccessibleMap ()

void	ThrowIfDisposed ()

virtual	~SwAccessibleContext () override

css::uno::Reference< css::accessibility::XAccessible >	getAccessibleParentImpl ()

Protected Member Functions inherited from SwAccessibleFrame
bool	IsEditable (SwViewShell const *pVSh) const

bool	IsOpaque (SwViewShell const *pVSh) const

bool	IsInPagePreview () const

void	ClearFrame ()

	SwAccessibleFrame (const SwRect &rVisArea, const SwFrame *pFrame, bool bIsPagePreview)

virtual	~SwAccessibleFrame ()

SwRect	GetBounds (const SwAccessibleMap &rAccMap, const SwFrame *pFrame=nullptr)

const SwFrame *	GetParent () const

sal_Int32	GetChildCount (SwAccessibleMap &rAccMap) const

sw::access::SwAccessibleChild	GetChild (SwAccessibleMap &rAccMap, sal_Int32 nPos) const

sw::access::SwAccessibleChild	GetChildAtPixel (const Point &rPos, SwAccessibleMap &rAccMap) const

void	GetChildren (SwAccessibleMap &rAccMap, std::list< sw::access::SwAccessibleChild > &rChildren) const

void	SetVisArea (const SwRect &rNewVisArea)

const SwRect &	GetVisArea () const

OUString	GetFormattedPageNumber () const

Private Member Functions
bool	IsSelected ()

SwRect	GetBounds (const SwAccessibleMap &rAccMap, const SwFrame *pFrame=nullptr)

Private Attributes
bool	m_bIsSelected

Additional Inherited Members
Static Public Member Functions inherited from SwAccessibleContext
static OUString	GetResource (TranslateId pResId, const OUString pArg1=nullptr, const OUString pArg2=nullptr)

Static Public Member Functions inherited from SwAccessibleFrame
static const SwFrame *	GetParent (const sw::access::SwAccessibleChild &rFrameOrObj, bool bInPagePreview)

Static Protected Member Functions inherited from SwAccessibleFrame
static sal_Int32	GetChildCount (SwAccessibleMap &rAccMap, const SwRect &rVisArea, const SwFrame *pFrame, bool bInPagePreviewr)

static sw::access::SwAccessibleChild	GetChild (SwAccessibleMap &rAccMap, const SwRect &rVisArea, const SwFrame &rFrame, sal_Int32 &rPos, bool bInPagePreview)

static bool	GetChildIndex (SwAccessibleMap &rAccMap, const SwRect &rVisArea, const SwFrame &rFrame, const sw::access::SwAccessibleChild &rChild, sal_Int32 &rPos, bool bInPagePreview)

static sw::access::SwAccessibleChild	GetChildAtPixel (const SwRect &rVisArea, const SwFrame &rFrame, const Point &rPos, bool bInPagePreview, SwAccessibleMap &rAccMap)

static void	GetChildren (SwAccessibleMap &rAccMap, const SwRect &rVisArea, const SwFrame &rFrame, std::list< sw::access::SwAccessibleChild > &rChildren, bool bInPagePreview)

Protected Attributes inherited from SwAccessibleContext
std::mutex	m_Mutex

bool	m_isSelectedInDoc

Detailed Description

accessibility implementation for the page (SwPageFrame) The page is only visible in the page preview.

For the regular document view, it doesn't make sense to add this additional element into the hierarchy. For the page preview, however, the page is the important.

Definition at line 32 of file accpage.hxx.

Constructor & Destructor Documentation

◆ ~SwAccessiblePage()

SwAccessiblePage::~SwAccessiblePage ( )

overrideprotectedvirtual

Definition at line 120 of file accpage.cxx.

◆ SwAccessiblePage()

SwAccessiblePage::SwAccessiblePage	(	std::shared_ptr< SwAccessibleMap > const &	pInitMap,
		const SwFrame *	pFrame
	)

Definition at line 106 of file accpage.cxx.

References SwAccessibleFrame::GetFrame(), SwAccessibleContext::GetResource(), SwFrame::IsPageFrame(), and SwAccessibleContext::SetName().

Member Function Documentation

◆ getAccessibleDescription()

OUString SwAccessiblePage::getAccessibleDescription ( )

overridevirtual

Definition at line 150 of file accpage.cxx.

References SwAccessibleFrame::GetFormattedPageNumber(), SwAccessibleContext::GetResource(), and SwAccessibleContext::ThrowIfDisposed().

◆ GetBounds()

SwRect SwAccessibleFrame::GetBounds	(	const SwAccessibleMap &	rAccMap,
		const SwFrame *	pFrame = `nullptr`
	)

private

Definition at line 113 of file accframe.cxx.

References SwAccessibleFrame::GetChild(), sw::access::SwAccessibleChild::GetSwFrame(), and sw::access::SwAccessibleChild::IsAccessible().

◆ getImplementationId()

Sequence< sal_Int8 > SAL_CALL SwAccessiblePage::getImplementationId ( )

overridevirtual

Definition at line 145 of file accpage.cxx.

◆ getImplementationName()

OUString SwAccessiblePage::getImplementationName ( )

overridevirtual

Definition at line 130 of file accpage.cxx.

References sImplementationName.

◆ GetStates()

void SwAccessiblePage::GetStates ( sal_Int64 & rStateSet )

overrideprotectedvirtual

Reimplemented from SwAccessibleContext.

Definition at line 41 of file accpage.cxx.

References SwAccessibleContext::GetMap(), SwAccessibleContext::GetStates(), SwAccessibleContext::GetWindow(), vcl::Window::HasFocus(), IsSelected(), m_bIsSelected, and SwAccessibleMap::SetCursorContext().

◆ getSupportedServiceNames()

Sequence< OUString > SwAccessiblePage::getSupportedServiceNames ( )

overridevirtual

Definition at line 140 of file accpage.cxx.

References sAccessibleServiceName.

◆ HasCursor()

bool SwAccessiblePage::HasCursor ( )

overridevirtual

Reimplemented from SwAccessibleContext.

Definition at line 124 of file accpage.cxx.

References m_bIsSelected, and SwAccessibleContext::m_Mutex.

◆ InvalidateCursorPos_()

void SwAccessiblePage::InvalidateCursorPos_ ( )

overrideprotectedvirtual

Reimplemented from SwAccessibleContext.

Definition at line 61 of file accpage.cxx.

References SwAccessibleContext::FireStateChangedEvent(), SwAccessibleContext::GetMap(), SwAccessibleContext::GetWindow(), vcl::Window::HasFocus(), IsSelected(), m_bIsSelected, SwAccessibleContext::m_Mutex, and SwAccessibleMap::SetCursorContext().

◆ InvalidateFocus_()

void SwAccessiblePage::InvalidateFocus_ ( )

overrideprotectedvirtual

Reimplemented from SwAccessibleContext.

Definition at line 88 of file accpage.cxx.

References SwAccessibleContext::FireStateChangedEvent(), SwAccessibleContext::GetWindow(), vcl::Window::HasFocus(), m_bIsSelected, and SwAccessibleContext::m_Mutex.

◆ IsSelected()

bool SwAccessiblePage::IsSelected ( )

private

Definition at line 36 of file accpage.cxx.

References SwAccessibleFrame::GetFrame(), SwAccessibleContext::GetMap(), and SwAccessibleMap::IsPageSelected().

Referenced by GetStates(), and InvalidateCursorPos_().

◆ supportsService()

sal_Bool SwAccessiblePage::supportsService ( const OUString & sServiceName )

overridevirtual

Return whether the specified service is supported by this class.

Reimplemented from SwAccessibleContext.

Definition at line 135 of file accpage.cxx.

References cppu::supportsService().

Member Data Documentation

◆ m_bIsSelected

bool SwAccessiblePage::m_bIsSelected

private

Definition at line 34 of file accpage.hxx.

Referenced by GetStates(), HasCursor(), InvalidateCursorPos_(), and InvalidateFocus_().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SwAccessiblePage()

◆ SwAccessiblePage()

Member Function Documentation

◆ getAccessibleDescription()

◆ GetBounds()

◆ getImplementationId()

◆ getImplementationName()

◆ GetStates()

◆ getSupportedServiceNames()

◆ HasCursor()

◆ InvalidateCursorPos_()

◆ InvalidateFocus_()

◆ IsSelected()

◆ supportsService()

Member Data Documentation

◆ m_bIsSelected