access to an accessible Writer document More...

#include <accdoc.hxx>

Inheritance diagram for SwAccessibleDocument:

Collaboration diagram for SwAccessibleDocument:

Public Member Functions
	SwAccessibleDocument (std::shared_ptr< SwAccessibleMap > const &pInitMap)

	DECL_LINK (WindowChildEventListener, VclWindowEvent &, void)

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::Any SAL_CALL	queryInterface (const css::uno::Type &aType) override

virtual void SAL_CALL	acquire () noexcept override

virtual void SAL_CALL	release () noexcept override

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

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

virtual void SAL_CALL	selectAccessibleChild (sal_Int64 nChildIndex) override

virtual sal_Bool SAL_CALL	isAccessibleChildSelected (sal_Int64 nChildIndex) override

virtual void SAL_CALL	clearAccessibleSelection () override

virtual void SAL_CALL	selectAllAccessibleChildren () override

virtual sal_Int64 SAL_CALL	getSelectedAccessibleChildCount () override

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getSelectedAccessibleChild (sal_Int64 nSelectedChildIndex) override

virtual void SAL_CALL	deselectAccessibleChild (sal_Int64 nChildIndex) override

virtual css::uno::Any SAL_CALL	getExtendedAttributes () override

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

sal_Int32 SAL_CALL	getBackground () override

Public Member Functions inherited from SwAccessibleDocumentBase
	SwAccessibleDocumentBase (std::shared_ptr< SwAccessibleMap > const &pInitMap)

void	SetVisArea ()

void	AddChild (vcl::Window *pWin, bool bFireEvent=true)

void	RemoveChild (vcl::Window *pWin)

virtual sal_Int64 SAL_CALL	getAccessibleChildCount () override

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

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

virtual sal_Int64 SAL_CALL	getAccessibleIndexInParent () override

virtual OUString SAL_CALL	getAccessibleDescription () override

virtual OUString SAL_CALL	getAccessibleName () 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

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	~SwAccessibleDocument () override

Protected Member Functions inherited from SwAccessibleDocumentBase
virtual	~SwAccessibleDocumentBase () 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 Attributes
SwAccessibleSelectionHelper	maSelectionHelper

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

access to an accessible Writer document

Definition at line 92 of file accdoc.hxx.

Constructor & Destructor Documentation

◆ ~SwAccessibleDocument()

SwAccessibleDocument::~SwAccessibleDocument ( )

overrideprotectedvirtual

Definition at line 369 of file accdoc.cxx.

References SwAccessibleContext::GetMap(), SwAccessibleMap::GetShell(), SwViewShell::GetWin(), LINK, and vcl::Window::RemoveChildEventListener().

◆ SwAccessibleDocument()

SwAccessibleDocument::SwAccessibleDocument ( std::shared_ptr< SwAccessibleMap > const & pInitMap )

Definition at line 348 of file accdoc.cxx.

References SwAccessibleDocumentBase::AddChild(), vcl::Window::AddChildEventListener(), vcl::Window::GetAccessibleRole(), vcl::Window::GetChild(), vcl::Window::GetChildCount(), i, LINK, nCount, and SwAccessibleContext::SetName().

Member Function Documentation

◆ acquire()

virtual void SAL_CALL SwAccessibleDocument::acquire ( )

inlineoverridevirtualnoexcept

Definition at line 135 of file accdoc.hxx.

◆ clearAccessibleSelection()

void SwAccessibleDocument::clearAccessibleSelection ( )

overridevirtual

Definition at line 485 of file accdoc.cxx.

◆ DECL_LINK()

SwAccessibleDocument::DECL_LINK	(	WindowChildEventListener	,
		VclWindowEvent &	,
		void
	)

◆ deselectAccessibleChild()

void SwAccessibleDocument::deselectAccessibleChild ( sal_Int64 nChildIndex )

overridevirtual

Definition at line 506 of file accdoc.cxx.

References SwAccessibleSelectionHelper::deselectAccessibleChild(), and maSelectionHelper.

◆ Dispose()

void SwAccessibleDocument::Dispose	(	bool	bRecursive,
		bool	bCanSkipInvisible = `true`
	)

overridevirtual

Reimplemented from SwAccessibleContext.

Definition at line 376 of file accdoc.cxx.

References SwAccessibleContext::Dispose(), SwAccessibleFrame::GetFrame(), SwAccessibleContext::GetMap(), SwAccessibleMap::GetShell(), SwViewShell::GetWin(), LINK, and vcl::Window::RemoveChildEventListener().

◆ getBackground()

sal_Int32 SAL_CALL SwAccessibleDocument::getBackground ( )

overridevirtual

Reimplemented from SwAccessibleContext.

Definition at line 715 of file accdoc.cxx.

References SW_MOD.

◆ getExtendedAttributes()

uno::Any SAL_CALL SwAccessibleDocument::getExtendedAttributes ( )

overridevirtual

Definition at line 512 of file accdoc.cxx.

References SwLayoutFrame::ContainsContent(), SwFrame::FindFlyFrame(), SwFormat::GetAnchor(), SwAnchoredObject::GetAnchorFrame(), SwFormatAnchor::GetAnchorId(), SwFrame::GetAttrSet(), SwAttrSet::GetCol(), SwFormatAnchor::GetContentAnchor(), SwNode::GetContentNode(), SwCursorShell::GetCurrFrame(), SwCursorShell::GetCursor(), SwCursorShell::GetCursorPagePos(), SwAccessibleContext::GetCursorShell(), SwViewShell::GetDoc(), SwViewShellImp::GetDrawView(), SwFlyFrame::GetFormat(), GetFormat(), SwContentNode::getLayoutFrame(), SwTextFrame::GetLineCount(), SwAccessibleContext::GetMap(), SdrMarkList::GetMark(), SdrMarkList::GetMarkCount(), SdrMarkView::GetMarkedObjectList(), SdrMark::GetMarkedSdrObj(), SwFrame::GetNext(), SwContentFrame::GetNextContentFrame(), SwPosition::GetNode(), SwFormatCol::GetNumCols(), SwCursorShell::GetPageCnt(), SwFEShell::GetPageNumber(), SwPaM::GetPoint(), SwFrame::getRootFrame(), SwSectionFrame::GetSection(), SwSection::GetSectionName(), SwAccessibleContext::GetShell(), SwTextFrame::GetThisLines(), SwFrame::GetUpper(), SdrObject::GetUserCall(), i, SwViewShell::Imp(), SwTextFrame::IsEmpty(), SwFrame::IsFooterFrame(), SwFrame::IsHeaderFrame(), SwFrame::IsInFly(), SwFrame::IsInFootnote(), SwFrame::IsInTab(), SwFrame::IsPageFrame(), SwFrame::IsTextFrame(), SwLayoutFrame::Lower(), SwTextFrame::MapModelToViewPos(), Point, and sDisplay.

◆ getImplementationId()

uno::Sequence< sal_Int8 > SAL_CALL SwAccessibleDocument::getImplementationId ( )

overridevirtual

Definition at line 466 of file accdoc.cxx.

◆ getImplementationName()

OUString SAL_CALL SwAccessibleDocument::getImplementationName ( )

overridevirtual

Definition at line 422 of file accdoc.cxx.

References sImplementationName.

◆ getSelectedAccessibleChild()

uno::Reference< XAccessible > SwAccessibleDocument::getSelectedAccessibleChild ( sal_Int64 nSelectedChildIndex )

overridevirtual

Definition at line 499 of file accdoc.cxx.

References SwAccessibleSelectionHelper::getSelectedAccessibleChild(), and maSelectionHelper.

◆ getSelectedAccessibleChildCount()

sal_Int64 SwAccessibleDocument::getSelectedAccessibleChildCount ( )

overridevirtual

Definition at line 494 of file accdoc.cxx.

References SwAccessibleSelectionHelper::getSelectedAccessibleChildCount(), and maSelectionHelper.

◆ GetStates()

void SwAccessibleDocument::GetStates ( sal_Int64 & rStateSet )

overrideprotectedvirtual

Reimplemented from SwAccessibleContext.

Definition at line 339 of file accdoc.cxx.

References SwAccessibleContext::GetStates().

◆ getSupportedServiceNames()

uno::Sequence< OUString > SAL_CALL SwAccessibleDocument::getSupportedServiceNames ( )

overridevirtual

Definition at line 432 of file accdoc.cxx.

References sAccessibleServiceName, and sServiceName.

◆ getTypes()

uno::Sequence< uno::Type > SAL_CALL SwAccessibleDocument::getTypes ( )

overridevirtual

Definition at line 459 of file accdoc.cxx.

References cppu::OTypeCollection::getTypes().

◆ isAccessibleChildSelected()

sal_Bool SwAccessibleDocument::isAccessibleChildSelected ( sal_Int64 nChildIndex )

overridevirtual

Definition at line 479 of file accdoc.cxx.

References SwAccessibleSelectionHelper::isAccessibleChildSelected(), and maSelectionHelper.

◆ queryInterface()

uno::Any SwAccessibleDocument::queryInterface ( const css::uno::Type & aType )

overridevirtual

Definition at line 439 of file accdoc.cxx.

◆ release()

virtual void SAL_CALL SwAccessibleDocument::release ( )

inlineoverridevirtualnoexcept

Definition at line 138 of file accdoc.hxx.

◆ selectAccessibleChild()

void SwAccessibleDocument::selectAccessibleChild ( sal_Int64 nChildIndex )

overridevirtual

Definition at line 473 of file accdoc.cxx.

References maSelectionHelper, and SwAccessibleSelectionHelper::selectAccessibleChild().

◆ selectAllAccessibleChildren()

void SwAccessibleDocument::selectAllAccessibleChildren ( )

overridevirtual

Definition at line 489 of file accdoc.cxx.

References maSelectionHelper, and SwAccessibleSelectionHelper::selectAllAccessibleChildren().

◆ supportsService()

sal_Bool SAL_CALL SwAccessibleDocument::supportsService ( const OUString & sServiceName )

overridevirtual

Return whether the specified service is supported by this class.

Reimplemented from SwAccessibleContext.

Definition at line 427 of file accdoc.cxx.

References cppu::supportsService().

Member Data Documentation

◆ maSelectionHelper

SwAccessibleSelectionHelper SwAccessibleDocument::maSelectionHelper

private

Definition at line 97 of file accdoc.hxx.

Referenced by deselectAccessibleChild(), getSelectedAccessibleChild(), getSelectedAccessibleChildCount(), isAccessibleChildSelected(), selectAccessibleChild(), and selectAllAccessibleChildren().

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SwAccessibleDocument()

◆ SwAccessibleDocument()

Member Function Documentation

◆ acquire()

◆ clearAccessibleSelection()

◆ DECL_LINK()

◆ deselectAccessibleChild()

◆ Dispose()

◆ getBackground()

◆ getExtendedAttributes()

◆ getImplementationId()

◆ getImplementationName()

◆ getSelectedAccessibleChild()

◆ getSelectedAccessibleChildCount()

◆ GetStates()

◆ getSupportedServiceNames()

◆ getTypes()

◆ isAccessibleChildSelected()

◆ queryInterface()

◆ release()

◆ selectAccessibleChild()

◆ selectAllAccessibleChildren()

◆ supportsService()

Member Data Documentation

◆ maSelectionHelper