sd/source/ui/inc/AccessibleSlideSorterView.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 #pragma once
  21
  22 #include <cppuhelper/basemutex.hxx>
  23 #include <cppuhelper/compbase.hxx>
  24 #include <com/sun/star/accessibility/XAccessible.hpp>
  25 #include <com/sun/star/accessibility/XAccessibleContext.hpp>
  26 #include <com/sun/star/accessibility/XAccessibleComponent.hpp>
  27 #include <com/sun/star/accessibility/XAccessibleSelection.hpp>
  28 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
  29 #include <com/sun/star/lang/XServiceInfo.hpp>
  30 #include <vcl/vclptr.hxx>
  31 #include <vcl/window.hxx>
  32
  33 #include <memory>
  34
  35 namespace sd::slidesorter { class SlideSorter; }
  36
  37 namespace accessibility {
  38
  39 class AccessibleSlideSorterObject;
  40
  41 typedef ::cppu::WeakComponentImplHelper<
  42     css::accessibility::XAccessible,
  43     css::accessibility::XAccessibleEventBroadcaster,
  44     css::accessibility::XAccessibleContext,
  45     css::accessibility::XAccessibleComponent,
  46     css::accessibility::XAccessibleSelection,
  47     css::lang::XServiceInfo
  48     > AccessibleSlideSorterViewBase;
  49
  50 /** This class makes the SlideSorterViewShell accessible.  It uses objects
  51     of the AccessibleSlideSorterObject class to the make the page objects
  52     accessible.
  53 */
  54 class AccessibleSlideSorterView
  55     : public cppu::BaseMutex,
  56       public AccessibleSlideSorterViewBase
  57 {
  58 public:
  59     AccessibleSlideSorterView(
  60         ::sd::slidesorter::SlideSorter& rSlideSorter,
  61         vcl::Window* pParentWindow);
  62
  63     void Init();
  64
  65     virtual ~AccessibleSlideSorterView() override;
  66
  67     /** This method acts like a dispose call.  It sends a disposing to all
  68         of its listeners.  It may be called twice.
  69     */
  70     void Destroyed();
  71
  72     void FireAccessibleEvent (
  73         short nEventId,
  74         const css::uno::Any& rOldValue,
  75         const css::uno::Any& rNewValue);
  76
  77     virtual void SAL_CALL disposing() override;
  78
  79     /** Return the implementation object of the specified child.
  80         @param nIndex
  81             Index of the child for which to return the implementation object.
  82     */
  83     AccessibleSlideSorterObject* GetAccessibleChildImplementation (sal_Int32 nIndex);
  84
  85     //===== XAccessible =======================================================
  86
  87     virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL
  88         getAccessibleContext() override;
  89
  90     //===== XAccessibleEventBroadcaster =======================================
  91     virtual void SAL_CALL
  92         addAccessibleEventListener(
  93             const css::uno::Reference< css::accessibility::XAccessibleEventListener >& rxListener) override;
  94
  95     virtual void SAL_CALL
  96         removeAccessibleEventListener(
  97             const css::uno::Reference< css::accessibility::XAccessibleEventListener >& rxListener ) override;
  98
  99     //=====  XAccessibleContext  ==============================================
 100
 101     /// Return the number of currently visible children.
 102     virtual sal_Int64 SAL_CALL
 103         getAccessibleChildCount() override;
 104
 105     /// Return the specified child or throw exception.
 106     virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
 107         getAccessibleChild (sal_Int64 nIndex) override;
 108
 109     /// Return a reference to the parent.
 110     virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
 111         getAccessibleParent() override;
 112
 113     /// Return this objects index among the parents children.
 114     virtual sal_Int64 SAL_CALL
 115         getAccessibleIndexInParent() override;
 116
 117     /// Return this object's role.
 118     virtual sal_Int16 SAL_CALL
 119         getAccessibleRole() override;
 120
 121     /// Return this object's description.
 122     virtual OUString SAL_CALL
 123         getAccessibleDescription() override;
 124
 125     /// Return the object's current name.
 126     virtual OUString SAL_CALL
 127         getAccessibleName() override;
 128
 129     /// Return NULL to indicate that an empty relation set.
 130     virtual css::uno::Reference<
 131             css::accessibility::XAccessibleRelationSet> SAL_CALL
 132         getAccessibleRelationSet() override;
 133
 134     /// Return the set of current states.
 135     virtual sal_Int64 SAL_CALL getAccessibleStateSet() override;
 136
 137     /** Return the parents locale or throw exception if this object has no
 138         parent yet/anymore.
 139     */
 140     virtual css::lang::Locale SAL_CALL
 141         getLocale() override;
 142
 143     //=====  XAccessibleComponent  ================================================
 144
 145     /** The default implementation uses the result of
 146         <member>getBounds</member> to determine whether the given point lies
 147         inside this object.
 148     */
 149     virtual sal_Bool SAL_CALL containsPoint (
 150         const css::awt::Point& aPoint) override;
 151
 152     /** The default implementation returns an empty reference.
 153     */
 154     virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
 155         getAccessibleAtPoint (
 156             const css::awt::Point& aPoint) override;
 157
 158     /** The default implementation returns an empty rectangle.
 159     */
 160     virtual css::awt::Rectangle SAL_CALL getBounds() override;
 161
 162     /** The default implementation uses the result of
 163         <member>getBounds</member> to determine the location.
 164     */
 165     virtual css::awt::Point SAL_CALL getLocation() override;
 166
 167     /** The default implementation returns an empty position, i.e. the
 168     * result of the default constructor of <type>css::awt::Point</type>.
 169     */
 170     virtual css::awt::Point SAL_CALL getLocationOnScreen() override;
 171
 172     /** The default implementation uses the result of
 173         <member>getBounds</member> to determine the size.
 174     */
 175     virtual css::awt::Size SAL_CALL getSize() override;
 176
 177     /** The default implementation does nothing.
 178     */
 179     virtual void SAL_CALL grabFocus() override;
 180
 181     /** Returns black as the default foreground color.
 182     */
 183     virtual sal_Int32 SAL_CALL getForeground() override;
 184
 185     /** Returns white as the default background color.
 186     */
 187     virtual sal_Int32 SAL_CALL getBackground() override;
 188
 189     //===== XAccessibleSelection ==============================================
 190
 191     virtual void SAL_CALL
 192         selectAccessibleChild (sal_Int64 nChildIndex) override;
 193
 194     virtual sal_Bool SAL_CALL
 195         isAccessibleChildSelected( sal_Int64 nChildIndex ) override;
 196
 197     virtual void SAL_CALL
 198         clearAccessibleSelection(  ) override;
 199
 200     virtual void SAL_CALL
 201         selectAllAccessibleChildren(  ) override;
 202
 203     virtual sal_Int64 SAL_CALL
 204         getSelectedAccessibleChildCount(  ) override;
 205
 206     virtual css::uno::Reference<
 207         css::accessibility::XAccessible > SAL_CALL
 208         getSelectedAccessibleChild( sal_Int64 nSelectedChildIndex ) override;
 209
 210     virtual void SAL_CALL
 211         deselectAccessibleChild( sal_Int64 nSelectedChildIndex ) override;
 212
 213     //=====  XServiceInfo  ====================================================
 214
 215     /** Returns an identifier for the implementation of this object.
 216     */
 217     virtual OUString SAL_CALL
 218         getImplementationName() override;
 219
 220     /** Return whether the specified service is supported by this class.
 221     */
 222     virtual sal_Bool SAL_CALL
 223         supportsService (const OUString& sServiceName) override;
 224
 225     /** Returns a list of all supported services.
 226     */
 227     virtual css::uno::Sequence< OUString> SAL_CALL
 228         getSupportedServiceNames() override;
 229
 230     void SwitchViewActivated();
 231 private:
 232     class Implementation;
 233     ::std::unique_ptr<Implementation> mpImpl;
 234
 235     ::sd::slidesorter::SlideSorter& mrSlideSorter;
 236
 237     sal_uInt32 mnClientId;
 238
 239     VclPtr<vcl::Window> mpContentWindow;
 240
 241     /** Check whether or not the object has been disposed (or is in the
 242         state of being disposed).  If that is the case then
 243         DisposedException is thrown to inform the (indirect) caller of the
 244         foul deed.
 245
 246         @throws css::lang::DisposedException
 247     */
 248     void ThrowIfDisposed();
 249 };
 250
 251 } // end of namespace ::accessibility
 252
 253 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */