sd/source/ui/inc/AccessiblePageShape.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SD_SOURCE_UI_INC_ACCESSIBLEPAGESHAPE_HXX
  21 #define INCLUDED_SD_SOURCE_UI_INC_ACCESSIBLEPAGESHAPE_HXX
  22
  23 #include <svx/AccessibleShape.hxx>
  24 #include <svx/AccessibleShapeTreeInfo.hxx>
  25 #include <svx/IAccessibleViewForwarderListener.hxx>
  26 #include <com/sun/star/accessibility/XAccessible.hpp>
  27 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.hpp>
  28 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  29 #include <com/sun/star/drawing/XDrawPage.hpp>
  30 #include <com/sun/star/lang/XEventListener.hpp>
  31
  32 #include <svx/AccessibleTextHelper.hxx>
  33
  34 namespace accessibility {
  35
  36 /** A page shape represents the actual page as seen on the screen.
  37 */
  38 class AccessiblePageShape
  39     :   public AccessibleShape
  40 {
  41 public:
  42     //=====  internal  ========================================================
  43
  44     /** Create a new accessible object that makes the given shape accessible.
  45         @param rxParent
  46             The accessible parent object.  It will be used, for example when
  47             the <member>getIndexInParent</member> method is called.
  48         @param rShapeTreeInfo
  49             Bundel of information passed to this shape and all of its desendants.
  50         @param nIndex
  51             Index used to disambiguate between objects that have the same
  52             name.  Passing a value of -1 leads to the use of the object's
  53             z-order instead.  Because that is not a good substitute, better
  54             pass an ever increasing counter.
  55         @attention
  56             Always call the <member>init</member> method after creating a
  57             new accessible shape.  This is one way to overcome the potential
  58             problem of registering the new object with e.g. event
  59             broadcasters.  That would delete the new object if a broadcaster
  60             would not keep a strong reference to the new object.
  61     */
  62     AccessiblePageShape (
  63         const ::com::sun::star::uno::Reference<
  64             ::com::sun::star::drawing::XDrawPage>& rxPage,
  65         const ::com::sun::star::uno::Reference<
  66             ::com::sun::star::accessibility::XAccessible>& rxParent,
  67         const AccessibleShapeTreeInfo& rShapeTreeInfo,
  68         long nIndex = -1);
  69
  70     virtual ~AccessiblePageShape();
  71
  72     /** Initialize a new shape.  See the documentation of the constructor
  73         for the reason of this method's existence.
  74     */
  75     virtual void Init() SAL_OVERRIDE;
  76
  77     //=====  XAccessibleContext  ==============================================
  78
  79     /// Returns always 0 because there can be no children.
  80     virtual sal_Int32 SAL_CALL
  81         getAccessibleChildCount()
  82         throw (std::exception) SAL_OVERRIDE;
  83
  84     /** Return the specified child.
  85         @param nIndex
  86             Index of the requested child.
  87         @return
  88             Reference of the requested child which is the accessible object
  89             of a visible shape.
  90         @raises IndexOutOfBoundsException
  91             Throws always an exception because there are no children.
  92     */
  93     virtual ::com::sun::star::uno::Reference<
  94             ::com::sun::star::accessibility::XAccessible> SAL_CALL
  95         getAccessibleChild (sal_Int32 nIndex)
  96         throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  97
  98     //=====  XAccessibleComponent  ============================================
  99
 100     virtual ::com::sun::star::awt::Rectangle SAL_CALL getBounds()
 101         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 102
 103     virtual sal_Int32 SAL_CALL getForeground()
 104         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 105
 106     virtual sal_Int32 SAL_CALL getBackground()
 107         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 108
 109     //=====  XComponent  ======================================================
 110
 111     virtual void SAL_CALL
 112         dispose()
 113         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 114
 115     //=====  XServiceInfo  ====================================================
 116
 117     virtual OUString SAL_CALL
 118         getImplementationName()
 119         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 120
 121     virtual ::com::sun::star::uno::Sequence< OUString> SAL_CALL
 122         getSupportedServiceNames()
 123         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 124
 125     //=====  lang::XEventListener  ============================================
 126
 127     virtual void SAL_CALL
 128         disposing (const ::com::sun::star::lang::EventObject& Source)
 129         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 130
 131     using AccessibleShape::disposing;
 132
 133 protected:
 134     /** Create a base name string that contains the accessible name.
 135     */
 136     virtual OUString
 137         CreateAccessibleBaseName()
 138         throw (::com::sun::star::uno::RuntimeException) SAL_OVERRIDE;
 139
 140     virtual OUString
 141         CreateAccessibleName()
 142         throw (::com::sun::star::uno::RuntimeException) SAL_OVERRIDE;
 143
 144     /// Create a description string that contains the accessible description.
 145     virtual OUString
 146         CreateAccessibleDescription()
 147         throw (::com::sun::star::uno::RuntimeException) SAL_OVERRIDE;
 148
 149 private:
 150     ::com::sun::star::uno::Reference<
 151         ::com::sun::star::drawing::XDrawPage> mxPage;
 152
 153     AccessiblePageShape (const AccessiblePageShape&) SAL_DELETED_FUNCTION;
 154     AccessibleShape& operator= (const AccessiblePageShape&) SAL_DELETED_FUNCTION;
 155 };
 156
 157 } // end of namespace accessibility
 158
 159 #endif
 160
 161 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */