LibreOffice Module sd (master) 1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
accessibility::AccessibleOutlineView Class Referencefinal

This class makes the Impress outline view accessible. More...

#include <AccessibleOutlineView.hxx>

Inheritance diagram for accessibility::AccessibleOutlineView:
[legend]
Collaboration diagram for accessibility::AccessibleOutlineView:
[legend]

Public Member Functions

 AccessibleOutlineView (::sd::Window *pSdWindow, ::sd::OutlineViewShell *pViewShell, const css::uno::Reference< css::frame::XController > &rxController, const css::uno::Reference< css::accessibility::XAccessible > &rxParent)
 
virtual ~AccessibleOutlineView () override
 
virtual void Init () override
 Complete the initialization begun in the constructor. More...
 
virtual void ViewForwarderChanged () override
 A view forwarder change is signalled for instance when any of the window events is received. More...
 
virtual sal_Int64 SAL_CALL getAccessibleChildCount () override
 This implementation returns either 1 or 0 depending on whether there is an active accessible OLE object or not. More...
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild (sal_Int64 nIndex) override
 This implementation either returns the active accessible OLE object if it exists and the given index is 0 or throws an exception. More...
 
virtual OUString SAL_CALL getAccessibleName () override
 
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 OUString SAL_CALL getImplementationName () override
 Returns an identifier for the implementation of this object. More...
 
virtual void SAL_CALL propertyChange (const css::beans::PropertyChangeEvent &rEventObject) override
 
virtual void SAL_CALL disposing (const css::lang::EventObject &rEventObject) override
 
virtual void SAL_CALL disposing () override
 
- Public Member Functions inherited from accessibility::AccessibleDocumentViewBase
 AccessibleDocumentViewBase (::sd::Window *pSdWindow, ::sd::ViewShell *pViewShell, css::uno::Reference< css::frame::XController > xController, const css::uno::Reference< css::accessibility::XAccessible > &rxParent)
 Create a new object. More...
 
virtual ~AccessibleDocumentViewBase () override
 
virtual void Init ()
 Initialize a new object. More...
 
 DECL_LINK (WindowChildEventListener, VclWindowEvent &, void)
 Define callback for listening to window child events of VCL. More...
 
virtual void ViewForwarderChanged () override
 A view forwarder change is signalled for instance when any of the window events is received. More...
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent () override
 
virtual sal_Int64 SAL_CALL getAccessibleChildCount () override
 This implementation returns either 1 or 0 depending on whether there is an active accessible OLE object or not. More...
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild (sal_Int64 nIndex) override
 This implementation either returns the active accessible OLE object if it exists and the given index is 0 or throws an exception. More...
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint (const css::awt::Point &aPoint) override
 Iterate over all children and test whether the specified point lies within one of their bounding boxes. More...
 
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 css::uno::Any SAL_CALL queryInterface (const css::uno::Type &rType) override
 
virtual void SAL_CALL acquire () noexcept override
 
virtual void SAL_CALL release () noexcept override
 
virtual OUString SAL_CALL getImplementationName () override
 Returns an identifier for the implementation of this object. More...
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames () override
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () override
 
virtual void SAL_CALL disposing (const css::lang::EventObject &rEventObject) override
 
virtual void SAL_CALL propertyChange (const css::beans::PropertyChangeEvent &rEventObject) override
 
virtual void SAL_CALL windowResized (const css::awt::WindowEvent &e) override
 
virtual void SAL_CALL windowMoved (const css::awt::WindowEvent &e) override
 
virtual void SAL_CALL windowShown (const css::lang::EventObject &e) override
 
virtual void SAL_CALL windowHidden (const css::lang::EventObject &e) override
 
virtual void SAL_CALL focusGained (const css::awt::FocusEvent &e) override
 
virtual void SAL_CALL focusLost (const css::awt::FocusEvent &e) override
 
virtual css::uno::Any SAL_CALL getExtendedAttributes () override
 
void SwitchViewActivated ()
 
virtual sal_Int32 SAL_CALL getForeground () override
 
virtual sal_Int32 SAL_CALL getBackground () override
 
virtual void impl_dispose ()
 
- Public Member Functions inherited from accessibility::AccessibleContextBase
 AccessibleContextBase (css::uno::Reference< css::accessibility::XAccessible > xParent, const sal_Int16 aRole)
 
virtual ~AccessibleContextBase () override
 
void CommitChange (sal_Int16 aEventId, const css::uno::Any &rNewValue, const css::uno::Any &rOldValue, sal_Int32 nValueIndex)
 
void SetAccessibleDescription (const OUString &rsDescription, StringOrigin eDescriptionOrigin)
 
void SetAccessibleName (const OUString &rsName, StringOrigin eNameOrigin)
 
virtual bool SetState (sal_Int64 aState)
 
virtual bool ResetState (sal_Int64 aState)
 
bool GetState (sal_Int64 aState)
 
void SetRelationSet (const css::uno::Reference< css::accessibility::XAccessibleRelationSet > &rxRelationSet)
 
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::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 getAccessibleDescription () 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
 
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 OUString SAL_CALL getImplementationName () override
 
virtual sal_Bool SAL_CALL supportsService (const OUString &sServiceName) override
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames () override
 
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId () override
 
bool IsDisposed () const
 
- Public Member Functions inherited from accessibility::AccessibleComponentBase
 AccessibleComponentBase ()
 
virtual ~AccessibleComponentBase ()
 
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 css::uno::Reference< css::awt::XFont > SAL_CALL getFont () override
 
virtual OUString SAL_CALL getTitledBorderText () override
 
virtual OUString SAL_CALL getToolTipText () override
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes ()
 
- Public Member Functions inherited from accessibility::AccessibleSelectionBase
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 nSelectedChildIndex) override
 
 AccessibleSelectionBase ()
 
virtual ~AccessibleSelectionBase ()
 
virtual void ViewForwarderChanged ()=0
 

Private Member Functions

virtual void Activated () override
 This method is called when (after) the frame containing this document has been activated. More...
 
virtual void Deactivated () override
 This method is called when (before or after?) the frame containing this document has been deactivated. More...
 
 AccessibleOutlineView (const AccessibleOutlineView &)
 
AccessibleOutlineViewoperator= (const AccessibleOutlineView &)
 
virtual void SAL_CALL disposing () override
 
virtual OUString CreateAccessibleName () override
 Create an accessible name that contains the current view mode. More...
 
void UpdateChildren ()
 Invalidate text helper, updates visible children. More...
 

Private Attributes

AccessibleTextHelper maTextHelper
 

Additional Inherited Members

- Public Types inherited from accessibility::AccessibleContextBase
enum  StringOrigin
 
- Public Attributes inherited from accessibility::AccessibleDocumentViewBase
::sd::ViewShellmpViewShell
 
- Public Attributes inherited from accessibility::AccessibleContextBase
 ManuallySet
 
 FromShape
 
 AutomaticallyCreated
 
 NotSet
 
- Protected Member Functions inherited from accessibility::AccessibleDocumentViewBase
virtual void SAL_CALL disposing () override
 
virtual OUString CreateAccessibleName () override
 Create a name string. More...
 
virtual void Activated ()
 This method is called when (after) the frame containing this document has been activated. More...
 
virtual void Deactivated ()
 This method is called when (before or after?) the frame containing this document has been deactivated. More...
 
void SetAccessibleOLEObject (const css::uno::Reference< css::accessibility::XAccessible > &xOLEObject)
 Set or remove the currently active accessible OLE object. More...
 
- Protected Member Functions inherited from accessibility::AccessibleContextBase
virtual void SAL_CALL disposing () override
 
virtual OUString CreateAccessibleName ()
 
void FireEvent (const css::accessibility::AccessibleEventObject &aEvent)
 
void ThrowIfDisposed ()
 
void SetAccessibleRole (sal_Int16 _nRole)
 
virtual ::osl::Mutex & implGetMutex ()=0
 
- Protected Member Functions inherited from accessibility::IAccessibleViewForwarderListener
 ~IAccessibleViewForwarderListener ()
 
- Protected Attributes inherited from accessibility::AccessibleDocumentViewBase
css::uno::Reference< css::awt::XWindow > mxWindow
 The API window that is made accessible. More...
 
css::uno::Reference< css::frame::XController > mxController
 The controller of the window in which this view is displayed. More...
 
css::uno::Reference< css::frame::XModel > mxModel
 Model of the document. More...
 
AccessibleShapeTreeInfo maShapeTreeInfo
 
AccessibleViewForwarder maViewForwarder
 The view forwarder passed to the children manager. More...
 
css::uno::Reference< css::accessibility::XAccessible > mxAccessibleOLEObject
 Accessible OLE object. More...
 
Link< VclWindowEvent &, void > maWindowLink
 
- Protected Attributes inherited from accessibility::AccessibleContextBase
sal_Int64 mnStateSet
 
css::uno::Reference< css::accessibility::XAccessibleRelationSet > mxRelationSet
 

Detailed Description

This class makes the Impress outline view accessible.

Please see the documentation of the base class for further explanations of the individual methods. This class is a mere wrapper around the AccessibleTextHelper class; as basically the Outline View is a big Outliner.

Definition at line 36 of file AccessibleOutlineView.hxx.

Constructor & Destructor Documentation

◆ AccessibleOutlineView() [1/2]

accessibility::AccessibleOutlineView::AccessibleOutlineView ( ::sd::Window pSdWindow,
::sd::OutlineViewShell pViewShell,
const css::uno::Reference< css::frame::XController > &  rxController,
const css::uno::Reference< css::accessibility::XAccessible > &  rxParent 
)

◆ ~AccessibleOutlineView()

accessibility::AccessibleOutlineView::~AccessibleOutlineView ( )
overridevirtual

Definition at line 75 of file AccessibleOutlineView.cxx.

◆ AccessibleOutlineView() [2/2]

accessibility::AccessibleOutlineView::AccessibleOutlineView ( const AccessibleOutlineView )
private

Member Function Documentation

◆ Activated()

void accessibility::AccessibleOutlineView::Activated ( )
overrideprivatevirtual

This method is called when (after) the frame containing this document has been activated.

Can be used to send FOCUSED state changes for the currently selected element.

Note: Currently used as a substitute for FocusGained. Should be renamed in the future.

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 170 of file AccessibleOutlineView.cxx.

◆ addAccessibleEventListener()

void SAL_CALL accessibility::AccessibleOutlineView::addAccessibleEventListener ( const css::uno::Reference< css::accessibility::XAccessibleEventListener > &  xListener)
overridevirtual

Reimplemented from accessibility::AccessibleContextBase.

Definition at line 142 of file AccessibleOutlineView.cxx.

◆ CreateAccessibleName()

OUString accessibility::AccessibleOutlineView::CreateAccessibleName ( )
overrideprivatevirtual

Create an accessible name that contains the current view mode.

Create a name for this view.

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 223 of file AccessibleOutlineView.cxx.

References SdResId().

◆ Deactivated()

void accessibility::AccessibleOutlineView::Deactivated ( )
overrideprivatevirtual

This method is called when (before or after?) the frame containing this document has been deactivated.

Can be used to send FOCUSED state changes for the currently selected element.

Note: Currently used as a substitute for FocusLost. Should be renamed in the future.

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 178 of file AccessibleOutlineView.cxx.

◆ disposing() [1/3]

void SAL_CALL accessibility::AccessibleDocumentViewBase::disposing ( )
overridevirtual

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 270 of file AccessibleDocumentViewBase.cxx.

◆ disposing() [2/3]

void SAL_CALL accessibility::AccessibleOutlineView::disposing ( )
overrideprivatevirtual

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 186 of file AccessibleOutlineView.cxx.

◆ disposing() [3/3]

virtual void SAL_CALL accessibility::AccessibleDocumentViewBase::disposing ( const css::lang::EventObject &  rEventObject)
overridevirtual

◆ getAccessibleChild()

uno::Reference< XAccessible > SAL_CALL accessibility::AccessibleOutlineView::getAccessibleChild ( sal_Int64  nIndex)
overridevirtual

This implementation either returns the active accessible OLE object if it exists and the given index is 0 or throws an exception.

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 106 of file AccessibleOutlineView.cxx.

References nIndex.

◆ getAccessibleChildCount()

sal_Int64 SAL_CALL accessibility::AccessibleOutlineView::getAccessibleChildCount ( )
overridevirtual

This implementation returns either 1 or 0 depending on whether there is an active accessible OLE object or not.

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 97 of file AccessibleOutlineView.cxx.

◆ getAccessibleName()

OUString SAL_CALL accessibility::AccessibleOutlineView::getAccessibleName ( )
overridevirtual

◆ getImplementationName()

OUString SAL_CALL accessibility::AccessibleOutlineView::getImplementationName ( )
overridevirtual

Returns an identifier for the implementation of this object.

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 161 of file AccessibleOutlineView.cxx.

◆ Init()

void accessibility::AccessibleOutlineView::Init ( void  )
overridevirtual

Complete the initialization begun in the constructor.

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 79 of file AccessibleOutlineView.cxx.

◆ operator=()

AccessibleOutlineView & accessibility::AccessibleOutlineView::operator= ( const AccessibleOutlineView )
private

◆ propertyChange()

void SAL_CALL accessibility::AccessibleOutlineView::propertyChange ( const css::beans::PropertyChangeEvent &  rEventObject)
overridevirtual

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 197 of file AccessibleOutlineView.cxx.

References SAL_INFO.

◆ removeAccessibleEventListener()

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

Reimplemented from accessibility::AccessibleContextBase.

Definition at line 150 of file AccessibleOutlineView.cxx.

◆ UpdateChildren()

void accessibility::AccessibleOutlineView::UpdateChildren ( )
private

Invalidate text helper, updates visible children.

Definition at line 228 of file AccessibleOutlineView.cxx.

◆ ViewForwarderChanged()

void accessibility::AccessibleOutlineView::ViewForwarderChanged ( )
overridevirtual

A view forwarder change is signalled for instance when any of the window events is received.

Thus, instead of overriding the four windowResized... methods it will be sufficient in most cases just to override this method.

Reimplemented from accessibility::AccessibleDocumentViewBase.

Definition at line 87 of file AccessibleOutlineView.cxx.

Member Data Documentation

◆ maTextHelper

AccessibleTextHelper accessibility::AccessibleOutlineView::maTextHelper
private

Definition at line 113 of file AccessibleOutlineView.hxx.


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