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

A page shape represents the actual page as seen on the screen. More...

#include <AccessiblePageShape.hxx>

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

Public Member Functions

 AccessiblePageShape (css::uno::Reference< css::drawing::XDrawPage > xPage, const css::uno::Reference< css::accessibility::XAccessible > &rxParent, const AccessibleShapeTreeInfo &rShapeTreeInfo)
 Create a new accessible object that makes the given shape accessible. More...
 
virtual ~AccessiblePageShape () override
 
virtual sal_Int64 SAL_CALL getAccessibleChildCount () override
 Returns always 0 because there can be no children. More...
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild (sal_Int64 nIndex) override
 Return the specified child. More...
 
virtual css::awt::Rectangle SAL_CALL getBounds () override
 
virtual sal_Int32 SAL_CALL getForeground () override
 
virtual sal_Int32 SAL_CALL getBackground () override
 Extract the background color from the Background property of the draw page or its master page. More...
 
virtual void SAL_CALL dispose () override
 
virtual OUString SAL_CALL getImplementationName () override
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames () override
 
void disposing (const css::lang::EventObject &Source)
 
virtual void SAL_CALL disposing () override
 
- Public Member Functions inherited from accessibility::AccessibleShape
 AccessibleShape (const AccessibleShapeInfo &rShapeInfo, const AccessibleShapeTreeInfo &rShapeTreeInfo)
 
virtual OUString SAL_CALL getAccessibleName () override
 
virtual OUString SAL_CALL getAccessibleDescription () override
 
virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet () 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 nSelectedChildIndex) override
 
virtual css::uno::Any SAL_CALL getExtendedAttributes () override
 
virtual sal_Int16 SAL_CALL getAccessibleRole () override
 
virtual css::uno::Sequence< sal_Int32 > SAL_CALL getGroupPosition (const css::uno::Any &rAny) override
 
virtual OUString SAL_CALL getObjectLink (const css::uno::Any &accoject) override
 
virtual ~AccessibleShape () override
 
virtual void Init ()
 
virtual bool SetState (sal_Int64 aState) override
 
virtual bool ResetState (sal_Int64 aState) override
 
bool GetState (sal_Int64 aState)
 
virtual sal_Int64 SAL_CALL getAccessibleChildCount () override
 
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild (sal_Int64 nIndex) override
 
virtual sal_Int64 SAL_CALL getAccessibleStateSet () override
 
virtual sal_Int64 SAL_CALL getAccessibleIndexInParent () 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 sal_Int32 SAL_CALL getForeground () override
 
virtual sal_Int32 SAL_CALL getBackground () override
 
virtual void SAL_CALL addAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &rxListener) override
 
virtual void SAL_CALL removeAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &rxListener) 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
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames () override
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () override
 
virtual void ViewForwarderChanged () override
 
void disposing (const css::lang::EventObject &Source)
 
virtual void SAL_CALL notifyShapeEvent (const css::document::EventObject &rEventObject) override
 
virtual sal_Int32 SAL_CALL getHyperLinkCount () override
 
virtual css::uno::Reference< css::accessibility::XAccessibleHyperlink > SAL_CALL getHyperLink (sal_Int32 nLinkIndex) override
 
virtual sal_Int32 SAL_CALL getHyperLinkIndex (sal_Int32 nCharIndex) override
 
virtual sal_Int32 SAL_CALL getCaretPosition () override
 
virtual sal_Bool SAL_CALL setCaretPosition (sal_Int32 nIndex) override
 
virtual sal_Unicode SAL_CALL getCharacter (sal_Int32 nIndex) override
 
virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL getCharacterAttributes (sal_Int32 nIndex, const css::uno::Sequence< OUString > &aRequestedAttributes) override
 
virtual css::awt::Rectangle SAL_CALL getCharacterBounds (sal_Int32 nIndex) override
 
virtual sal_Int32 SAL_CALL getCharacterCount () override
 
virtual sal_Int32 SAL_CALL getIndexAtPoint (const css::awt::Point &aPoint) override
 
virtual OUString SAL_CALL getSelectedText () override
 
virtual sal_Int32 SAL_CALL getSelectionStart () override
 
virtual sal_Int32 SAL_CALL getSelectionEnd () override
 
virtual sal_Bool SAL_CALL setSelection (sal_Int32 nStartIndex, sal_Int32 nEndIndex) override
 
virtual OUString SAL_CALL getText () override
 
virtual OUString SAL_CALL getTextRange (sal_Int32 nStartIndex, sal_Int32 nEndIndex) override
 
virtual css::accessibility::TextSegment SAL_CALL getTextAtIndex (sal_Int32 nIndex, sal_Int16 aTextType) override
 
virtual css::accessibility::TextSegment SAL_CALL getTextBeforeIndex (sal_Int32 nIndex, sal_Int16 aTextType) override
 
virtual css::accessibility::TextSegment SAL_CALL getTextBehindIndex (sal_Int32 nIndex, sal_Int16 aTextType) override
 
virtual sal_Bool SAL_CALL copyText (sal_Int32 nStartIndex, sal_Int32 nEndIndex) override
 
virtual sal_Bool SAL_CALL scrollSubstringTo (sal_Int32 nStartIndex, sal_Int32 nEndIndex, css::accessibility::AccessibleScrollType aScrollType) override
 
const css::uno::Reference< css::drawing::XShape > & GetXShape () const
 
void setIndexInParent (sal_Int32 _nIndex)
 
virtual void ViewForwarderChanged ()=0
 

Protected Member Functions

virtual OUString CreateAccessibleBaseName () override
 Create a base name string that contains the accessible name. More...
 
virtual OUString CreateAccessibleName () override
 
- Protected Member Functions inherited from accessibility::AccessibleShape
virtual void SAL_CALL disposing () override
 
virtual OUString CreateAccessibleBaseName ()
 
virtual OUString CreateAccessibleName () override
 
OUString GetFullAccessibleName (AccessibleShape *shape)
 
virtual OUString GetStyle () const
 
void UpdateStates ()
 
- Protected Member Functions inherited from accessibility::IAccessibleViewForwarderListener
 ~IAccessibleViewForwarderListener ()
 

Private Member Functions

 AccessiblePageShape (const AccessiblePageShape &)=delete
 
AccessibleShapeoperator= (const AccessiblePageShape &)=delete
 

Private Attributes

css::uno::Reference< css::drawing::XDrawPage > mxPage
 

Additional Inherited Members

- Protected Attributes inherited from accessibility::AccessibleShape
std::unique_ptr< ChildrenManagermpChildrenManager
 
css::uno::Reference< css::drawing::XShape > mxShape
 
AccessibleShapeTreeInfo maShapeTreeInfo
 
sal_Int32 m_nIndexInParent
 
std::unique_ptr< AccessibleTextHelpermpText
 
IAccessibleParentmpParent
 
SdrObjectm_pShape
 

Detailed Description

A page shape represents the actual page as seen on the screen.

Definition at line 32 of file AccessiblePageShape.hxx.

Constructor & Destructor Documentation

◆ AccessiblePageShape() [1/2]

accessibility::AccessiblePageShape::AccessiblePageShape ( css::uno::Reference< css::drawing::XDrawPage >  xPage,
const css::uno::Reference< css::accessibility::XAccessible > &  rxParent,
const AccessibleShapeTreeInfo rShapeTreeInfo 
)

Create a new accessible object that makes the given shape accessible.

Parameters
rxParentThe accessible parent object. It will be used, for example when the <member>getIndexInParent</member> method is called.
rShapeTreeInfoBundle of information passed to this shape and all of its descendants.
Attention: \n
Always call the <member>init</member> method after creating a new accessible shape. This is one way to overcome the potential problem of registering the new object with e.g. event broadcasters. That would delete the new object if a broadcaster would not keep a strong reference to the new object.

◆ ~AccessiblePageShape()

accessibility::AccessiblePageShape::~AccessiblePageShape ( )
overridevirtual

Definition at line 52 of file AccessiblePageShape.cxx.

◆ AccessiblePageShape() [2/2]

accessibility::AccessiblePageShape::AccessiblePageShape ( const AccessiblePageShape )
privatedelete

Member Function Documentation

◆ CreateAccessibleBaseName()

OUString accessibility::AccessiblePageShape::CreateAccessibleBaseName ( )
overrideprotectedvirtual

Create a base name string that contains the accessible name.

Reimplemented from accessibility::AccessibleShape.

Definition at line 234 of file AccessiblePageShape.cxx.

◆ CreateAccessibleName()

OUString accessibility::AccessiblePageShape::CreateAccessibleName ( )
overrideprotectedvirtual

Reimplemented from accessibility::AccessibleShape.

Definition at line 240 of file AccessiblePageShape.cxx.

◆ dispose()

void accessibility::AccessiblePageShape::dispose ( void  )
overridevirtual

Definition at line 222 of file AccessiblePageShape.cxx.

References mxShape.

◆ disposing() [1/2]

virtual void SAL_CALL accessibility::AccessibleShape::disposing ( )
virtual

Reimplemented from accessibility::AccessibleShape.

◆ disposing() [2/2]

void accessibility::AccessibleShape::disposing ( const css::lang::EventObject &  Source)

◆ getAccessibleChild()

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

Return the specified child.

Forward the request to the shape.

Parameters
nIndexIndex of the requested child.
Returns
Reference of the requested child which is the accessible object of a visible shape.
Exceptions
IndexOutOfBoundsExceptionThrows always an exception because there are no children.

Return the requested shape or throw an exception for a wrong index.

Reimplemented from accessibility::AccessibleShape.

Definition at line 68 of file AccessiblePageShape.cxx.

◆ getAccessibleChildCount()

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

Returns always 0 because there can be no children.

Reimplemented from accessibility::AccessibleShape.

Definition at line 59 of file AccessiblePageShape.cxx.

◆ getBackground()

sal_Int32 SAL_CALL accessibility::AccessiblePageShape::getBackground ( )
overridevirtual

Extract the background color from the Background property of the draw page or its master page.

Reimplemented from accessibility::AccessibleShape.

Definition at line 161 of file AccessiblePageShape.cxx.

References SAL_WARN, TOOLS_WARN_EXCEPTION, and xTarget.

◆ getBounds()

awt::Rectangle SAL_CALL accessibility::AccessiblePageShape::getBounds ( )
overridevirtual

◆ getForeground()

sal_Int32 SAL_CALL accessibility::AccessiblePageShape::getForeground ( )
overridevirtual

Reimplemented from accessibility::AccessibleShape.

Definition at line 137 of file AccessiblePageShape.cxx.

◆ getImplementationName()

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

Reimplemented from accessibility::AccessibleShape.

Definition at line 207 of file AccessiblePageShape.cxx.

◆ getSupportedServiceNames()

css::uno::Sequence< OUString > SAL_CALL accessibility::AccessiblePageShape::getSupportedServiceNames ( )
overridevirtual

Reimplemented from accessibility::AccessibleShape.

Definition at line 214 of file AccessiblePageShape.cxx.

◆ operator=()

AccessibleShape & accessibility::AccessiblePageShape::operator= ( const AccessiblePageShape )
privatedelete

Member Data Documentation

◆ mxPage

css::uno::Reference<css::drawing::XDrawPage> accessibility::AccessiblePageShape::mxPage
private

Definition at line 109 of file AccessiblePageShape.hxx.


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