sd/source/ui/inc/AccessiblePageShape.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessiblePageShape.hxx,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31
  32 #ifndef _SD_ACCESSIBILITY_ACCESSIBLE_PAGE_SHAPE_HXX
  33 #define _SD_ACCESSIBILITY_ACCESSIBLE_PAGE_SHAPE_HXX
  34
  35 #include <svx/AccessibleShape.hxx>
  36 #include <svx/AccessibleShapeTreeInfo.hxx>
  37 #include <svx/IAccessibleViewForwarderListener.hxx>
  38 #include <com/sun/star/accessibility/XAccessible.hpp>
  39 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.hpp>
  40 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  41 #include <com/sun/star/drawing/XDrawPage.hpp>
  42 #include <com/sun/star/lang/XEventListener.hpp>
  43
  44 #include <svx/AccessibleTextHelper.hxx>
  45
  46 namespace accessibility {
  47
  48 /** A page shape represents the actual page as seen on the screen.
  49 */
  50 class AccessiblePageShape
  51     :   public AccessibleShape
  52 {
  53 public:
  54     //=====  internal  ========================================================
  55
  56     /** Create a new accessible object that makes the given shape accessible.
  57         @param rxParent
  58             The accessible parent object.  It will be used, for example when
  59             the <member>getIndexInParent</member> method is called.
  60         @param rShapeTreeInfo
  61             Bundel of information passed to this shape and all of its desendants.
  62         @param nIndex
  63             Index used to disambiguate between objects that have the same
  64             name.  Passing a value of -1 leads to the use of the object's
  65             z-order instead.  Because that is not a good substitute, better
  66             pass an ever increasing counter.
  67         @attention
  68             Always call the <member>init</member> method after creating a
  69             new accessible shape.  This is one way to overcome the potential
  70             problem of registering the new object with e.g. event
  71             broadcasters.  That would delete the new object if a broadcaster
  72             would not keep a strong reference to the new object.
  73     */
  74     AccessiblePageShape (
  75         const ::com::sun::star::uno::Reference<
  76             ::com::sun::star::drawing::XDrawPage>& rxPage,
  77         const ::com::sun::star::uno::Reference<
  78             ::com::sun::star::accessibility::XAccessible>& rxParent,
  79         const AccessibleShapeTreeInfo& rShapeTreeInfo,
  80         long nIndex = -1);
  81
  82     virtual ~AccessiblePageShape (void);
  83
  84     /** Initialize a new shape.  See the documentation of the constructor
  85         for the reason of this method's existence.
  86     */
  87     virtual void Init (void);
  88
  89     //=====  XAccessibleContext  ==============================================
  90
  91     /// Returns always 0 because there can be no children.
  92     virtual sal_Int32 SAL_CALL
  93         getAccessibleChildCount (void)
  94         throw ();
  95
  96     /** Return the specified child.
  97         @param nIndex
  98             Index of the requested child.
  99         @return
 100             Reference of the requested child which is the accessible object
 101             of a visible shape.
 102         @raises IndexOutOfBoundsException
 103             Throws always an exception because there are no children.
 104     */
 105     virtual ::com::sun::star::uno::Reference<
 106             ::com::sun::star::accessibility::XAccessible> SAL_CALL
 107         getAccessibleChild (sal_Int32 nIndex)
 108         throw (::com::sun::star::uno::RuntimeException);
 109
 110
 111     //=====  XAccessibleComponent  ============================================
 112
 113     virtual ::com::sun::star::awt::Rectangle SAL_CALL getBounds (void)
 114         throw (::com::sun::star::uno::RuntimeException);
 115
 116     virtual sal_Int32 SAL_CALL getForeground (void)
 117         throw (::com::sun::star::uno::RuntimeException);
 118
 119     virtual sal_Int32 SAL_CALL getBackground (void)
 120         throw (::com::sun::star::uno::RuntimeException);
 121
 122     //=====  XComponent  ======================================================
 123
 124     virtual void SAL_CALL
 125         dispose (void)
 126         throw (::com::sun::star::uno::RuntimeException);
 127
 128
 129     //=====  XServiceInfo  ====================================================
 130
 131     virtual ::rtl::OUString SAL_CALL
 132         getImplementationName (void)
 133         throw (::com::sun::star::uno::RuntimeException);
 134
 135     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString> SAL_CALL
 136         getSupportedServiceNames (void)
 137         throw (::com::sun::star::uno::RuntimeException);
 138
 139
 140     //=====  lang::XEventListener  ============================================
 141
 142     virtual void SAL_CALL
 143         disposing (const ::com::sun::star::lang::EventObject& Source)
 144         throw (::com::sun::star::uno::RuntimeException);
 145
 146
 147     using AccessibleShape::disposing;
 148
 149 protected:
 150     /** Create a base name string that contains the accessible name.
 151     */
 152     virtual ::rtl::OUString
 153         CreateAccessibleBaseName (void)
 154         throw (::com::sun::star::uno::RuntimeException);
 155
 156     virtual ::rtl::OUString
 157         CreateAccessibleName (void)
 158         throw (::com::sun::star::uno::RuntimeException);
 159
 160     /// Create a description string that contains the accessible description.
 161     virtual ::rtl::OUString
 162         CreateAccessibleDescription (void)
 163         throw (::com::sun::star::uno::RuntimeException);
 164
 165 private:
 166     ::com::sun::star::uno::Reference<
 167         ::com::sun::star::drawing::XDrawPage> mxPage;
 168
 169     /** Don't use the default constructor.  Use the public constructor that
 170         takes the original shape and the parent as arguments instead.
 171     */
 172     explicit AccessiblePageShape (void);
 173     /// Don't use the copy constructor.  Is there any use for it?
 174     explicit AccessiblePageShape (const AccessiblePageShape&);
 175     /// Don't use the assignment operator.  Do we need this?
 176     AccessibleShape& operator= (const AccessiblePageShape&);
 177 };
 178
 179 } // end of namespace accessibility
 180
 181 #endif