357 lines
12 KiB
C++
357 lines
12 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "accframe.hxx"
|
|
#include <accmap.hxx>
|
|
#include <com/sun/star/accessibility/XAccessibleComponent.hpp>
|
|
#include <com/sun/star/accessibility/XAccessibleContext3.hpp>
|
|
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
|
|
#include <com/sun/star/lang/XServiceInfo.hpp>
|
|
#include <cppuhelper/implbase.hxx>
|
|
#include <unotools/resmgr.hxx>
|
|
|
|
#include <memory>
|
|
#include <mutex>
|
|
|
|
namespace vcl { class Window; }
|
|
class SwCursorShell;
|
|
class SdrObject;
|
|
class SwPaM;
|
|
namespace accessibility {
|
|
class AccessibleShape;
|
|
}
|
|
|
|
inline constexpr OUString sAccessibleServiceName = u"com.sun.star.accessibility.Accessible"_ustr;
|
|
|
|
class SwAccessibleContext :
|
|
public ::cppu::WeakImplHelper<
|
|
css::accessibility::XAccessible,
|
|
css::accessibility::XAccessibleContext,
|
|
css::accessibility::XAccessibleContext3,
|
|
css::accessibility::XAccessibleComponent,
|
|
css::accessibility::XAccessibleEventBroadcaster,
|
|
css::lang::XServiceInfo
|
|
>,
|
|
public SwAccessibleFrame
|
|
{
|
|
// The implements for the XAccessibleSelection interface has been
|
|
// 'externalized' and wants access to the protected members like
|
|
// GetMap, GetChild, GetParent, and GetFrame.
|
|
friend class SwAccessibleSelectionHelper;
|
|
#if OSL_DEBUG_LEVEL > 0
|
|
friend class SwAccessibleMap;
|
|
#endif
|
|
|
|
protected:
|
|
mutable std::mutex m_Mutex;
|
|
|
|
private:
|
|
OUString m_sName; // immutable outside constructor
|
|
|
|
// The parent if it has been retrieved. This is always an
|
|
// SwAccessibleContext. (protected by Mutex)
|
|
unotools::WeakReference< SwAccessibleContext > m_xWeakParent;
|
|
|
|
SwAccessibleMap *m_pMap; // must be protected by solar mutex
|
|
/// note: the m_pMap is guaranteed to be valid until we hit the
|
|
/// dtor ~SwAccessibleContext, then m_wMap must be checked if it's still
|
|
/// alive, after locking SolarMutex (alternatively, Dispose clears m_pMap)
|
|
std::weak_ptr<SwAccessibleMap> m_wMap;
|
|
|
|
sal_uInt32 m_nClientId; // client id in the AccessibleEventNotifier queue
|
|
sal_Int16 m_nRole; // immutable outside constructor
|
|
|
|
// The current states (protected by mutex)
|
|
bool m_isShowingState : 1;
|
|
bool m_isEditableState : 1;
|
|
bool m_isOpaqueState : 1;
|
|
bool m_isDefuncState : 1;
|
|
|
|
// Are we currently disposing that object (protected by solar mutex)?
|
|
bool m_isDisposing : 1;
|
|
|
|
// #i85634# - boolean, indicating if the accessible context is
|
|
// in general registered at the accessible map.
|
|
bool m_isRegisteredAtAccessibleMap;
|
|
|
|
void InitStates();
|
|
|
|
protected:
|
|
void SetName( const OUString& rName ) { m_sName = rName; }
|
|
sal_Int16 GetRole() const
|
|
{
|
|
return m_nRole;
|
|
}
|
|
//This flag is used to mark the object's selected state.
|
|
bool m_isSelectedInDoc;
|
|
void SetParent( SwAccessibleContext *pParent );
|
|
rtl::Reference<SwAccessibleContext> GetWeakParent() const;
|
|
|
|
bool IsDisposing() const { return m_isDisposing; }
|
|
|
|
vcl::Window *GetWindow();
|
|
SwAccessibleMap *GetMap() { return m_pMap; }
|
|
const SwAccessibleMap *GetMap() const { return m_pMap; }
|
|
|
|
/** convenience method to get the SwViewShell through accessibility map */
|
|
SwViewShell* GetShell()
|
|
{
|
|
return GetMap()->GetShell();
|
|
}
|
|
const SwViewShell* GetShell() const
|
|
{
|
|
return GetMap()->GetShell();
|
|
}
|
|
|
|
/** convenience method to get SwCursorShell through accessibility map
|
|
* @returns SwCursorShell, or NULL if none is found */
|
|
SwCursorShell* GetCursorShell();
|
|
const SwCursorShell* GetCursorShell() const;
|
|
|
|
// Notify all children that the visible area has changed.
|
|
// The SwFrame might belong to the current object or to any other child or
|
|
// grandchild.
|
|
void ChildrenScrolled( const SwFrame *pFrame, const SwRect& rOldVisArea );
|
|
|
|
// The context's showing state changed. May only be called for context that
|
|
// exist even if they aren't visible.
|
|
void Scrolled( const SwRect& rOldVisArea );
|
|
|
|
// A child has been moved while setting the visible area
|
|
void ScrolledWithin( const SwRect& rOldVisArea );
|
|
|
|
// The has been added while setting the visible area
|
|
void ScrolledIn();
|
|
|
|
// The context has to be removed while setting the visible area
|
|
void ScrolledOut( const SwRect& rOldVisArea );
|
|
|
|
// Invalidate the states of all children of the specified SwFrame. The
|
|
// SwFrame might belong the current object or to any child or grandchild!
|
|
// #i27301# - use new type definition for <_nStates>
|
|
void InvalidateChildrenStates( const SwFrame* _pFrame,
|
|
AccessibleStates _nStates );
|
|
|
|
// Dispose children of the specified SwFrame. The SwFrame might belong to
|
|
// the current object or to any other child or grandchild.
|
|
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_();
|
|
|
|
public:
|
|
void FireAccessibleEvent( css::accessibility::AccessibleEventObject& rEvent );
|
|
|
|
protected:
|
|
// broadcast visual data event
|
|
void FireVisibleDataEvent();
|
|
|
|
// broadcast state change event
|
|
void FireStateChangedEvent( sal_Int64 nState, bool bNewState );
|
|
|
|
// Set states for getAccessibleStateSet.
|
|
// This base class sets DEFUNC(0/1), EDITABLE(0/1), ENABLED(1),
|
|
// SHOWING(0/1), OPAQUE(0/1) and VISIBLE(1).
|
|
virtual void GetStates( sal_Int64& rStateSet );
|
|
|
|
bool IsEditableState();
|
|
|
|
/// @throws css::uno::RuntimeException
|
|
css::awt::Rectangle
|
|
getBoundsImpl(bool bRelative);
|
|
|
|
// #i85634#
|
|
void NotRegisteredAtAccessibleMap()
|
|
{
|
|
m_isRegisteredAtAccessibleMap = false;
|
|
}
|
|
void RemoveFrameFromAccessibleMap();
|
|
|
|
void ThrowIfDisposed();
|
|
|
|
virtual ~SwAccessibleContext() override;
|
|
|
|
// Return a reference to the parent.
|
|
rtl::Reference<SwAccessibleContext> getAccessibleParentImpl();
|
|
|
|
public:
|
|
SwAccessibleContext( std::shared_ptr<SwAccessibleMap> const& pMap,
|
|
sal_Int16 nRole, const SwFrame *pFrame );
|
|
|
|
// XAccessible
|
|
|
|
// Return the XAccessibleContext.
|
|
virtual css::uno::Reference< css::accessibility::XAccessibleContext> SAL_CALL
|
|
getAccessibleContext() override;
|
|
|
|
// XAccessibleContext
|
|
|
|
// Return the number of currently visible children.
|
|
virtual sal_Int64 SAL_CALL getAccessibleChildCount() override;
|
|
|
|
// Return the specified child or NULL if index is invalid.
|
|
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;
|
|
|
|
// Return a reference to the parent.
|
|
virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
|
|
getAccessibleParent() override;
|
|
|
|
// Return this objects index among the parents children.
|
|
virtual sal_Int64 SAL_CALL
|
|
getAccessibleIndexInParent() override;
|
|
|
|
// Return this object's role.
|
|
virtual sal_Int16 SAL_CALL
|
|
getAccessibleRole() override;
|
|
|
|
// getAccessibleDescription() is abstract
|
|
|
|
// Return the object's current name.
|
|
virtual OUString SAL_CALL
|
|
getAccessibleName() override;
|
|
|
|
// Return NULL to indicate that an empty relation set.
|
|
virtual css::uno::Reference<
|
|
css::accessibility::XAccessibleRelationSet> SAL_CALL
|
|
getAccessibleRelationSet() override;
|
|
|
|
// Return the set of current states.
|
|
virtual sal_Int64 SAL_CALL getAccessibleStateSet() override;
|
|
|
|
/** Return the parents locale or throw exception if this object has no
|
|
parent yet/anymore. */
|
|
virtual css::lang::Locale SAL_CALL
|
|
getLocale() override;
|
|
|
|
// XAccessibleEventBroadcaster
|
|
|
|
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;
|
|
|
|
// XAccessibleComponent
|
|
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;
|
|
|
|
// XServiceInfo
|
|
|
|
// getImplementationName() and getSupportedServiceNames are abstract
|
|
|
|
/** Return whether the specified service is supported by this class. */
|
|
virtual sal_Bool SAL_CALL
|
|
supportsService (const OUString& sServiceName) override;
|
|
|
|
// thread safe C++ interface
|
|
|
|
// The object is not visible any longer and should be destroyed
|
|
virtual void Dispose(bool bRecursive, bool bCanSkipInvisible = true);
|
|
|
|
// The child object is not visible any longer and should be destroyed
|
|
virtual void DisposeChild(const sw::access::SwAccessibleChild& rFrameOrObj, bool bRecursive, bool bCanSkipInvisible);
|
|
|
|
// The object has been moved by the layout
|
|
virtual void InvalidatePosOrSize( const SwRect& rFrame );
|
|
|
|
// The child object has been moved by the layout
|
|
virtual void InvalidateChildPosOrSize( const sw::access::SwAccessibleChild& rFrameOrObj,
|
|
const SwRect& rFrame );
|
|
|
|
// The content may have changed (but it hasn't to have changed)
|
|
void InvalidateContent();
|
|
|
|
// The caretPos has changed
|
|
void InvalidateCursorPos();
|
|
|
|
// The Focus state has changed
|
|
void InvalidateFocus();
|
|
|
|
// Check states
|
|
// #i27301# - use new type definition for <_nStates>
|
|
void InvalidateStates( AccessibleStates _nStates );
|
|
|
|
// the XAccessibleRelationSet may have changed
|
|
void InvalidateRelation( sal_uInt16 nType );
|
|
|
|
void InvalidateTextSelection(); // #i27301# - text selection has changed
|
|
void InvalidateAttr(); // #i88069# - attributes has changed
|
|
|
|
bool HasAdditionalAccessibleChildren();
|
|
|
|
// #i88070# - get additional child by index
|
|
vcl::Window* GetAdditionalAccessibleChild( const sal_Int32 nIndex );
|
|
|
|
// #i88070# - get all additional accessible children
|
|
void GetAdditionalAccessibleChildren( std::vector< vcl::Window* >* pChildren );
|
|
|
|
const OUString& GetName() const { return m_sName; }
|
|
|
|
virtual bool HasCursor(); // required by map to remember that object
|
|
|
|
bool Select( SwPaM *pPaM, SdrObject *pObj, bool bAdd );
|
|
bool Select( SwPaM& rPaM )
|
|
{
|
|
return Select( &rPaM, nullptr, false );
|
|
}
|
|
bool Select( SdrObject *pObj, bool bAdd )
|
|
{
|
|
return Select( nullptr, pObj, bAdd );
|
|
}
|
|
|
|
//This method is used to update the selected state and fire the selected state changed event.
|
|
virtual bool SetSelectedState(bool bSelected);
|
|
bool IsSelectedInDoc() const { return m_isSelectedInDoc; }
|
|
|
|
bool IsDisposed() const;
|
|
|
|
static OUString GetResource(TranslateId pResId,
|
|
const OUString *pArg1 = nullptr,
|
|
const OUString *pArg2 = nullptr);
|
|
};
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|