LibreOffice Module sc (master)  1
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
ScAccessibleContextBase Class Reference

#include <AccessibleContextBase.hxx>

Inheritance diagram for ScAccessibleContextBase:
[legend]
Collaboration diagram for ScAccessibleContextBase:
[legend]

Public Member Functions

 ScAccessibleContextBase (const css::uno::Reference< css::accessibility::XAccessible > &rxParent, const sal_Int16 aRole)
 
virtual void Init ()
 
virtual void SAL_CALL disposing () override
 
bool isShowing ()
 
virtual bool isVisible ()
 
virtual void Notify (SfxBroadcaster &rBC, const SfxHint &rHint) override
 ===== SfxListener ===================================================== More...
 
virtual css::uno::Any SAL_CALL queryInterface (css::uno::Type const &rType) override
 ===== XInterface ===================================================== More...
 
virtual void SAL_CALL acquire () override throw ()
 
virtual void SAL_CALL release () override throw ()
 
virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext () override
 ===== XAccessible ===================================================== More...
 
virtual sal_Bool SAL_CALL containsPoint (const css::awt::Point &rPoint) override
 ===== XAccessibleComponent ============================================ More...
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint (const css::awt::Point &rPoint) 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_Int32 SAL_CALL getAccessibleChildCount () override
 ===== XAccessibleContext ============================================== More...
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild (sal_Int32 nIndex) override
 Return the specified child or NULL if index is invalid. More...
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent () override
 Return a reference to the parent. More...
 
virtual sal_Int32 SAL_CALL getAccessibleIndexInParent () override
 Return this objects index among the parents children. More...
 
virtual sal_Int16 SAL_CALL getAccessibleRole () override
 Return this object's role. More...
 
virtual OUString SAL_CALL getAccessibleDescription () override
 Return this object's description. More...
 
virtual OUString SAL_CALL getAccessibleName () override
 Return the object's current name. More...
 
virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet () override
 Return NULL to indicate that an empty relation set. More...
 
virtual css::uno::Reference< css::accessibility::XAccessibleStateSet > SAL_CALL getAccessibleStateSet () override
 Return the set of current states. More...
 
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
 ===== XAccessibleEventBroadcaster ===================================== More...
 
virtual void SAL_CALL removeAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &xListener) override
 
virtual void SAL_CALL disposing (const css::lang::EventObject &Source) override
 ===== XAccessibleEventListener ======================================== More...
 
virtual void SAL_CALL notifyEvent (const css::accessibility::AccessibleEventObject &aEvent) override
 
virtual OUString SAL_CALL getImplementationName () override
 ===== XServiceInfo ==================================================== More...
 
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
 Returns a list of all supported services. More...
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () override
 ===== XTypeProvider =================================================== More...
 
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId () override
 Returns an implementation id. More...
 
void CommitChange (const css::accessibility::AccessibleEventObject &rEvent) const
 Calls all Listener to tell they the change. More...
 
void SetName (const OUString &rName)
 Use this method to set initial Name without notification. More...
 
void SetDescription (const OUString &rDesc)
 Use this method to set initial Description without notification. More...
 
void SetParent (const css::uno::Reference< css::accessibility::XAccessible > &rParent)
 
- Public Member Functions inherited from cppu::WeakAggComponentImplHelper5< class, class, class, class, class >
 WeakAggComponentImplHelper5 (::osl::Mutex &rMutex)
 
virtual css::uno::Any SAL_CALL queryAggregation (css::uno::Type const &rType) SAL_OVERRIDE
 
- Public Member Functions inherited from SfxListener
 SfxListener ()
 
 SfxListener (const SfxListener &rCopy)
 
virtual ~SfxListener () COVERITY_NOEXCEPT_FALSE
 
void StartListening (SfxBroadcaster &rBroadcaster, DuplicateHandling eDuplicateHanding=DuplicateHandling::Unexpected)
 
void EndListening (SfxBroadcaster &rBroadcaster, bool bRemoveAllDuplicates=false)
 
void EndListeningAll ()
 
bool IsListening (SfxBroadcaster &rBroadcaster) const
 
sal_uInt16 GetBroadcasterCount () const
 
SfxBroadcasterGetBroadcasterJOE (sal_uInt16 nNo) const
 
void RemoveBroadcaster_Impl (SfxBroadcaster &rBC)
 

Protected Member Functions

virtual ~ScAccessibleContextBase () override
 
virtual OUString createAccessibleDescription ()
 Return this object's description. More...
 
virtual OUString createAccessibleName ()
 Return the object's current name. More...
 
virtual tools::Rectangle GetBoundingBoxOnScreen () const
 Return the object's current bounding box relative to the desktop. More...
 
virtual tools::Rectangle GetBoundingBox () const
 Return the object's current bounding box relative to the parent object. More...
 
void CommitFocusGained () const
 Calls all FocusListener to tell they that the focus is gained. More...
 
void CommitFocusLost () const
 Calls all FocusListener to tell they that the focus is lost. More...
 
bool IsDefunc () const
 
void IsObjectValid () const
 
- Protected Member Functions inherited from cppu::ImplHelper1< class >
 ~ImplHelper1 ()
 

Protected Attributes

css::uno::Reference< css::accessibility::XAccessible > mxParent
 Reference to the parent object. More...
 
- Protected Attributes inherited from cppu::BaseMutex
mutable::osl::Mutex m_aMutex
 

Private Attributes

OUString msDescription
 Description of this object. More...
 
OUString msName
 Name of this object. More...
 
sal_uInt32 mnClientId
 client id in the AccessibleEventNotifier queue More...
 
sal_Int16 maRole
 This is the role of this object. More...
 

Detailed Description

Definition at line 55 of file AccessibleContextBase.hxx.

Constructor & Destructor Documentation

ScAccessibleContextBase::ScAccessibleContextBase ( const css::uno::Reference< css::accessibility::XAccessible > &  rxParent,
const sal_Int16  aRole 
)

Definition at line 38 of file AccessibleContextBase.cxx.

References m_aMutex, and mxParent.

ScAccessibleContextBase::~ScAccessibleContextBase ( )
overrideprotectedvirtual

Definition at line 49 of file AccessibleContextBase.cxx.

References dispose(), IsDefunc(), and m_refCount.

Member Function Documentation

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

===== XAccessibleEventBroadcaster =====================================

Add listener that is informed of future changes of name, description and so on events.

Reimplemented in ScAccessibleSpreadsheet, and ScAccessibleEditObject.

Definition at line 363 of file AccessibleContextBase.cxx.

References comphelper::AccessibleEventNotifier::addEventListener(), IsDefunc(), IsObjectValid(), mnClientId, and comphelper::AccessibleEventNotifier::registerClient().

Referenced by ScAccessibleEditObject::addAccessibleEventListener(), and ScAccessibleSpreadsheet::addAccessibleEventListener().

void ScAccessibleContextBase::CommitChange ( const css::accessibility::AccessibleEventObject &  rEvent) const
void ScAccessibleContextBase::CommitFocusGained ( ) const
protected
void ScAccessibleContextBase::CommitFocusLost ( ) const
protected
sal_Bool SAL_CALL ScAccessibleContextBase::containsPoint ( const css::awt::Point &  rPoint)
overridevirtual
OUString ScAccessibleContextBase::createAccessibleDescription ( )
protectedvirtual
OUString ScAccessibleContextBase::createAccessibleName ( )
protectedvirtual
void SAL_CALL ScAccessibleContextBase::disposing ( )
overridevirtual
virtual void SAL_CALL ScAccessibleContextBase::disposing ( const css::lang::EventObject &  Source)
overridevirtual

===== XAccessibleEventListener ========================================

Reimplemented in ScAccessibleDocument.

uno::Reference< XAccessible > SAL_CALL ScAccessibleContextBase::getAccessibleAtPoint ( const css::awt::Point &  rPoint)
overridevirtual
uno::Reference< XAccessible > SAL_CALL ScAccessibleContextBase::getAccessibleChild ( sal_Int32  nIndex)
overridevirtual
sal_Int32 SAL_CALL ScAccessibleContextBase::getAccessibleChildCount ( )
overridevirtual

===== XAccessibleContext ==============================================

Return the number of currently visible children.

Reimplemented in ScAccessibleTableBase, ScAccessibleEditObject, ScAccessibleCell, ScAccessibleDocument, ScAccessiblePreviewTable, ScAccessiblePreviewHeaderCell, ScAccessibleDocumentPagePreview, ScAccessiblePageHeaderArea, ScAccessiblePreviewCell, and ScAccessiblePageHeader.

Definition at line 224 of file AccessibleContextBase.cxx.

uno::Reference< XAccessibleContext > SAL_CALL ScAccessibleContextBase::getAccessibleContext ( )
overridevirtual
OUString SAL_CALL ScAccessibleContextBase::getAccessibleDescription ( )
overridevirtual

Return this object's description.

Definition at line 280 of file AccessibleContextBase.cxx.

References aEvent, CommitChange(), createAccessibleDescription(), IsObjectValid(), and msDescription.

sal_Int32 SAL_CALL ScAccessibleContextBase::getAccessibleIndexInParent ( )
overridevirtual

Return this objects index among the parents children.

Reimplemented in ScAccessiblePreviewTable, ScAccessiblePreviewHeaderCell, ScAccessibleCellBase, and ScAccessiblePageHeader.

Definition at line 244 of file AccessibleContextBase.cxx.

References i, IsObjectValid(), mxParent, and nIndex.

OUString SAL_CALL ScAccessibleContextBase::getAccessibleName ( )
overridevirtual

Return the object's current name.

Reimplemented in ScAccessibleDocument, and ScAccessibleDocumentPagePreview.

Definition at line 305 of file AccessibleContextBase.cxx.

References aEvent, CommitChange(), createAccessibleName(), IsObjectValid(), msName, and sName.

Referenced by ScAccessiblePreviewHeaderCell::CreateTextHelper().

uno::Reference< XAccessible > SAL_CALL ScAccessibleContextBase::getAccessibleParent ( )
overridevirtual
uno::Reference< XAccessibleRelationSet > SAL_CALL ScAccessibleContextBase::getAccessibleRelationSet ( )
overridevirtual

Return NULL to indicate that an empty relation set.

Reimplemented in ScAccessibleEditControlObject, ScAccessibleTableBase, ScAccessibleSpreadsheet, ScAccessibleEditObject, and ScAccessibleCell.

Definition at line 331 of file AccessibleContextBase.cxx.

sal_Int16 SAL_CALL ScAccessibleContextBase::getAccessibleRole ( )
overridevirtual

Return this object's role.

Definition at line 274 of file AccessibleContextBase.cxx.

References maRole.

uno::Reference< XAccessibleStateSet > SAL_CALL ScAccessibleContextBase::getAccessibleStateSet ( )
overridevirtual
sal_Int32 SAL_CALL ScAccessibleContextBase::getBackground ( )
overridevirtual
tools::Rectangle ScAccessibleContextBase::GetBoundingBox ( ) const
protectedvirtual
tools::Rectangle ScAccessibleContextBase::GetBoundingBoxOnScreen ( ) const
protectedvirtual
awt::Rectangle SAL_CALL ScAccessibleContextBase::getBounds ( )
overridevirtual

Definition at line 156 of file AccessibleContextBase.cxx.

References AWTRectangle(), GetBoundingBox(), and IsObjectValid().

Referenced by isShowing().

sal_Int32 SAL_CALL ScAccessibleContextBase::getForeground ( )
overridevirtual
uno::Sequence< sal_Int8 > SAL_CALL ScAccessibleContextBase::getImplementationId ( )
overridevirtual
OUString SAL_CALL ScAccessibleContextBase::getImplementationName ( )
overridevirtual

===== XServiceInfo ====================================================

Returns an identifier for the implementation of this object.

Reimplemented in ScAccessibleTableBase, ScAccessibleSpreadsheet, ScAccessibleEditObject, ScAccessibleDocument, ScAccessibleCell, ScAccessiblePreviewTable, ScAccessibleCellBase, ScAccessiblePreviewHeaderCell, ScAccessibleDocumentPagePreview, ScAccessiblePageHeaderArea, ScAccessiblePreviewCell, and ScAccessiblePageHeader.

Definition at line 418 of file AccessibleContextBase.cxx.

lang::Locale SAL_CALL ScAccessibleContextBase::getLocale ( )
overridevirtual

Return the parents locale or throw exception if this object has no parent yet/anymore.

Definition at line 343 of file AccessibleContextBase.cxx.

References IsObjectValid(), and mxParent.

awt::Point SAL_CALL ScAccessibleContextBase::getLocation ( )
overridevirtual

Definition at line 163 of file AccessibleContextBase.cxx.

References AWTPoint(), GetBoundingBox(), IsObjectValid(), and TopLeft.

awt::Point SAL_CALL ScAccessibleContextBase::getLocationOnScreen ( )
overridevirtual
awt::Size SAL_CALL ScAccessibleContextBase::getSize ( )
overridevirtual

Definition at line 177 of file AccessibleContextBase.cxx.

References AWTSize(), GetBoundingBox(), and IsObjectValid().

uno::Sequence< OUString > SAL_CALL ScAccessibleContextBase::getSupportedServiceNames ( )
overridevirtual
uno::Sequence< uno::Type > SAL_CALL ScAccessibleContextBase::getTypes ( )
overridevirtual
void SAL_CALL ScAccessibleContextBase::grabFocus ( )
overridevirtual
void ScAccessibleContextBase::Init ( void  )
virtual
bool ScAccessibleContextBase::IsDefunc ( ) const
inlineprotected
void ScAccessibleContextBase::IsObjectValid ( ) const
protected
Exceptions
css::lang::DisposedException

Definition at line 505 of file AccessibleContextBase.cxx.

Referenced by addAccessibleEventListener(), ScAccessibleSpreadsheet::addAccessibleEventListener(), ScAccessibleDocument::clearAccessibleSelection(), ScAccessibleSpreadsheet::clearAccessibleSelection(), containsPoint(), ScAccessibleDocument::createAccessibleName(), ScAccessibleDocument::deselectAccessibleChild(), ScAccessibleSpreadsheet::deselectAccessibleChild(), ScAccessiblePageHeader::getAccessibleAtPoint(), ScAccessiblePreviewCell::getAccessibleAtPoint(), ScAccessiblePageHeaderArea::getAccessibleAtPoint(), ScAccessibleDocumentPagePreview::getAccessibleAtPoint(), ScAccessiblePreviewHeaderCell::getAccessibleAtPoint(), ScAccessibleEditObject::getAccessibleAtPoint(), ScAccessiblePreviewTable::getAccessibleAtPoint(), ScAccessibleDocument::getAccessibleAtPoint(), ScAccessibleSpreadsheet::getAccessibleAtPoint(), ScAccessiblePreviewTable::getAccessibleCellAt(), ScAccessibleSpreadsheet::getAccessibleCellAt(), ScAccessiblePageHeader::getAccessibleChild(), ScAccessiblePreviewCell::getAccessibleChild(), ScAccessiblePageHeaderArea::getAccessibleChild(), ScAccessibleDocumentPagePreview::getAccessibleChild(), ScAccessiblePreviewHeaderCell::getAccessibleChild(), ScAccessiblePreviewTable::getAccessibleChild(), ScAccessibleDocument::getAccessibleChild(), ScAccessibleEditObject::getAccessibleChild(), ScAccessibleTableBase::getAccessibleChild(), ScAccessiblePageHeader::getAccessibleChildCount(), ScAccessiblePreviewCell::getAccessibleChildCount(), ScAccessiblePageHeaderArea::getAccessibleChildCount(), ScAccessibleDocumentPagePreview::getAccessibleChildCount(), ScAccessiblePreviewHeaderCell::getAccessibleChildCount(), ScAccessiblePreviewTable::getAccessibleChildCount(), ScAccessibleDocument::getAccessibleChildCount(), ScAccessibleEditObject::getAccessibleChildCount(), ScAccessibleTableBase::getAccessibleChildCount(), ScAccessiblePreviewTable::getAccessibleColumn(), ScAccessibleTableBase::getAccessibleColumn(), ScAccessiblePreviewTable::getAccessibleColumnCount(), ScAccessibleTableBase::getAccessibleColumnCount(), ScAccessiblePreviewTable::getAccessibleColumnExtentAt(), ScAccessibleTableBase::getAccessibleColumnExtentAt(), ScAccessibleSpreadsheet::getAccessibleColumnHeaders(), getAccessibleDescription(), ScAccessiblePreviewTable::getAccessibleIndex(), ScAccessibleTableBase::getAccessibleIndex(), ScAccessibleCellBase::getAccessibleIndexInParent(), getAccessibleIndexInParent(), getAccessibleName(), ScAccessibleCell::getAccessibleRelationSet(), ScAccessiblePreviewTable::getAccessibleRow(), ScAccessibleTableBase::getAccessibleRow(), ScAccessiblePreviewTable::getAccessibleRowCount(), ScAccessibleTableBase::getAccessibleRowCount(), ScAccessiblePreviewTable::getAccessibleRowExtentAt(), ScAccessibleTableBase::getAccessibleRowExtentAt(), ScAccessibleSpreadsheet::getAccessibleRowHeaders(), ScAccessibleCellBase::getBackground(), ScAccessibleSpreadsheet::getBackground(), ScAccessibleDocument::getBackground(), ScAccessibleCellBase::getBorderAttrs(), getBounds(), ScAccessiblePreviewHeaderCell::getCurrentValue(), ScAccessibleCellBase::getCurrentValue(), ScAccessibleCellBase::getForeground(), getLocale(), getLocation(), getLocationOnScreen(), ScAccessiblePreviewHeaderCell::getMaximumValue(), ScAccessibleCellBase::GetNote(), ScAccessibleDocument::getSelectedAccessibleChild(), ScAccessibleSpreadsheet::getSelectedAccessibleChild(), ScAccessibleDocument::getSelectedAccessibleChildCount(), ScAccessibleSpreadsheet::getSelectedAccessibleChildCount(), ScAccessibleSpreadsheet::getSelectedAccessibleColumns(), ScAccessibleSpreadsheet::getSelectedAccessibleRows(), ScAccessibleCellBase::getShadowAttrs(), getSize(), ScAccessibleDocument::GetVisibleArea(), ScAccessiblePageHeader::grabFocus(), ScAccessiblePreviewCell::grabFocus(), ScAccessibleDocumentPagePreview::grabFocus(), ScAccessiblePreviewHeaderCell::grabFocus(), ScAccessibleCell::grabFocus(), ScAccessiblePreviewTable::grabFocus(), ScAccessibleDocument::grabFocus(), ScAccessibleDocument::isAccessibleChildSelected(), ScAccessibleSpreadsheet::isAccessibleColumnSelected(), ScAccessibleSpreadsheet::isAccessibleRowSelected(), ScAccessiblePreviewTable::isAccessibleSelected(), ScAccessibleSpreadsheet::isAccessibleSelected(), isShowing(), ScAccessibleCellBase::isVisible(), ScAccessibleDocument::LogicToPixel(), ScAccessibleDocument::selectAccessibleChild(), ScAccessibleSpreadsheet::selectAccessibleChild(), ScAccessibleDocument::selectAllAccessibleChildren(), ScAccessibleSpreadsheet::selectAllAccessibleChildren(), and ScAccessibleCellBase::setCurrentValue().

bool ScAccessibleContextBase::isShowing ( )
bool ScAccessibleContextBase::isVisible ( )
virtual
void ScAccessibleContextBase::Notify ( SfxBroadcaster rBC,
const SfxHint rHint 
)
overridevirtual
void SAL_CALL ScAccessibleContextBase::notifyEvent ( const css::accessibility::AccessibleEventObject &  aEvent)
overridevirtual

Definition at line 412 of file AccessibleContextBase.cxx.

uno::Any SAL_CALL ScAccessibleContextBase::queryInterface ( css::uno::Type const &  rType)
overridevirtual
void SAL_CALL ScAccessibleContextBase::release ( )
throw (
)
overridevirtual
void SAL_CALL ScAccessibleContextBase::removeAccessibleEventListener ( const css::uno::Reference< css::accessibility::XAccessibleEventListener > &  xListener)
overridevirtual
void ScAccessibleContextBase::SetDescription ( const OUString &  rDesc)
inline

Use this method to set initial Description without notification.

Definition at line 248 of file AccessibleContextBase.hxx.

References msDescription.

Referenced by ScAccessibleEditObject::InitAcc().

void ScAccessibleContextBase::SetName ( const OUString &  rName)
inline

Use this method to set initial Name without notification.

Definition at line 245 of file AccessibleContextBase.hxx.

References msName.

Referenced by ScAccessibleEditObject::InitAcc().

void ScAccessibleContextBase::SetParent ( const css::uno::Reference< css::accessibility::XAccessible > &  rParent)
inline

Definition at line 250 of file AccessibleContextBase.hxx.

References mxParent.

Referenced by ScAccessibleEditObject::InitAcc().

sal_Bool SAL_CALL ScAccessibleContextBase::supportsService ( const OUString &  sServiceName)
overridevirtual

Return whether the specified service is supported by this class.

Definition at line 423 of file AccessibleContextBase.cxx.

References cppu::supportsService().

Member Data Documentation

sal_Int16 ScAccessibleContextBase::maRole
private

This is the role of this object.

Definition at line 284 of file AccessibleContextBase.hxx.

Referenced by getAccessibleRole().

sal_uInt32 ScAccessibleContextBase::mnClientId
private

client id in the AccessibleEventNotifier queue

Definition at line 280 of file AccessibleContextBase.hxx.

Referenced by addAccessibleEventListener(), CommitChange(), disposing(), and removeAccessibleEventListener().

OUString ScAccessibleContextBase::msDescription
private

Description of this object.

This is not a constant because it can be set from the outside. Furthermore, it changes according to the draw page's display mode.

Definition at line 272 of file AccessibleContextBase.hxx.

Referenced by getAccessibleDescription(), Init(), and SetDescription().

OUString ScAccessibleContextBase::msName
private

Name of this object.

It changes according the draw page's display mode.

Definition at line 277 of file AccessibleContextBase.hxx.

Referenced by getAccessibleName(), Init(), and SetName().

css::uno::Reference<css::accessibility::XAccessible> ScAccessibleContextBase::mxParent
protected

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