LibreOffice Module comphelper (master)  1
Protected Member Functions | List of all members
comphelper::OCommonAccessibleComponent Class Referenceabstract

base class encapsulating common functionality for the helper classes implementing the XAccessibleComponent respectively XAccessibleExtendendComponent More...

#include <accessiblecomponenthelper.hxx>

Inheritance diagram for comphelper::OCommonAccessibleComponent:
[legend]
Collaboration diagram for comphelper::OCommonAccessibleComponent:
[legend]

Protected Member Functions

 OCommonAccessibleComponent ()
 see the respective base class ctor for an extensive comment on this, please More...
 
virtual ~OCommonAccessibleComponent () override
 
virtual css::awt::Rectangle implGetBounds ()=0
 implements the calculation of the bounding rectangle - still waiting to be overwritten More...
 
bool containsPoint (const css::awt::Point &aPoint)
 non-virtual versions of the methods which can be implemented using <method>implGetBounds</method> note: getLocationOnScreen relies on a valid parent (XAccessibleContext::getParent()->getAccessibleContext()), which itself implements XAccessibleComponent More...
 
css::awt::Point getLocation ()
 
css::awt::Point getLocationOnScreen ()
 
css::awt::Size getSize ()
 
css::awt::Rectangle getBounds ()
 
- Protected Member Functions inherited from comphelper::OAccessibleContextHelper
virtual ~OAccessibleContextHelper () override
 
 OAccessibleContextHelper ()
 
void lateInit (const css::uno::Reference< css::accessibility::XAccessible > &_rxAccessible)
 late construction More...
 
css::uno::Reference< css::accessibility::XAccessible > getAccessibleCreator () const
 retrieves the creator previously set with <method>lateInit</method> More...
 
virtual void SAL_CALL disposing () override
 
void NotifyAccessibleEvent (const sal_Int16 _nEventId, const css::uno::Any &_rOldValue, const css::uno::Any &_rNewValue)
 notifies all AccessibleEventListeners of a certain event More...
 
bool isAlive () const
 checks whether the object is alive (returns <TRUE> then) or disposed More...
 
void ensureAlive () const
 checks for being alive. If the object is already disposed (i.e. not alive), an exception is thrown. More...
 
void ensureDisposed ()
 ensures that the object is disposed. More...
 
css::uno::Reference< css::accessibility::XAccessibleContext > implGetParentContext ()
 shortcut for retrieving the context of the parent (returned by getAccessibleParent) More...
 
::osl::Mutex & GetMutex ()
 

Additional Inherited Members

- Public Member Functions inherited from comphelper::OAccessibleContextHelper
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_Int32 SAL_CALL getAccessibleChildCount () override=0
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild (sal_Int32 i) override=0
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent () override=0
 
virtual sal_Int16 SAL_CALL getAccessibleRole () override=0
 
virtual OUString SAL_CALL getAccessibleDescription () override=0
 
virtual OUString SAL_CALL getAccessibleName () override=0
 
virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet () override=0
 
virtual css::uno::Reference< css::accessibility::XAccessibleStateSet > SAL_CALL getAccessibleStateSet () override=0
 
virtual OUString SAL_CALL getAccessibleId () override
 
virtual sal_Int32 SAL_CALL getAccessibleIndexInParent () override
 default implementation for retrieving the index of this object within the parent More...
 
virtual css::lang::Locale SAL_CALL getLocale () override
 default implementation for retrieving the locale More...
 
- Public Member Functions inherited from cppu::WeakAggComponentImplHelper2< class, class >
 WeakAggComponentImplHelper2 (::osl::Mutex &rMutex)
 
virtual css::uno::Any SAL_CALL queryInterface (css::uno::Type const &rType) SAL_OVERRIDE
 
virtual css::uno::Any SAL_CALL queryAggregation (css::uno::Type const &rType) SAL_OVERRIDE
 
virtual void SAL_CALL acquire () SAL_OVERRIDE
 
virtual void SAL_CALL release () SAL_OVERRIDE
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () SAL_OVERRIDE
 
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId () SAL_OVERRIDE
 
- Protected Attributes inherited from cppu::BaseMutex
mutable::osl::Mutex m_aMutex
 

Detailed Description

base class encapsulating common functionality for the helper classes implementing the XAccessibleComponent respectively XAccessibleExtendendComponent

Definition at line 40 of file accessiblecomponenthelper.hxx.

Constructor & Destructor Documentation

comphelper::OCommonAccessibleComponent::OCommonAccessibleComponent ( )
protected

see the respective base class ctor for an extensive comment on this, please

Definition at line 32 of file accessiblecomponenthelper.cxx.

comphelper::OCommonAccessibleComponent::~OCommonAccessibleComponent ( )
overrideprotectedvirtual

Definition at line 37 of file accessiblecomponenthelper.cxx.

Member Function Documentation

bool comphelper::OCommonAccessibleComponent::containsPoint ( const css::awt::Point &  aPoint)
protected

non-virtual versions of the methods which can be implemented using <method>implGetBounds</method> note: getLocationOnScreen relies on a valid parent (XAccessibleContext::getParent()->getAccessibleContext()), which itself implements XAccessibleComponent

Exceptions
css::uno::RuntimeException

Definition at line 42 of file accessiblecomponenthelper.cxx.

References implGetBounds().

Referenced by comphelper::OAccessibleComponentHelper::containsPoint(), and comphelper::OAccessibleExtendedComponentHelper::containsPoint().

awt::Rectangle comphelper::OCommonAccessibleComponent::getBounds ( )
protected
Exceptions
css::uno::RuntimeException

Definition at line 89 of file accessiblecomponenthelper.cxx.

References implGetBounds().

Referenced by comphelper::OAccessibleComponentHelper::getBounds(), and comphelper::OAccessibleExtendedComponentHelper::getBounds().

awt::Point comphelper::OCommonAccessibleComponent::getLocation ( )
protected
awt::Point comphelper::OCommonAccessibleComponent::getLocationOnScreen ( )
protected
awt::Size comphelper::OCommonAccessibleComponent::getSize ( )
protected
Exceptions
css::uno::RuntimeException

Definition at line 81 of file accessiblecomponenthelper.cxx.

References implGetBounds().

Referenced by comphelper::OAccessibleComponentHelper::getSize(), and comphelper::OAccessibleExtendedComponentHelper::getSize().

virtual css::awt::Rectangle comphelper::OCommonAccessibleComponent::implGetBounds ( )
protectedpure virtual

implements the calculation of the bounding rectangle - still waiting to be overwritten

Exceptions
css::uno::RuntimeException

Referenced by containsPoint(), getBounds(), getLocation(), and getSize().


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