sc/source/ui/inc/AccessibleContextBase.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 <com/sun/star/accessibility/XAccessible.hpp>
  23 #include <com/sun/star/accessibility/XAccessibleComponent.hpp>
  24 #include <com/sun/star/accessibility/XAccessibleContext.hpp>
  25 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
  26 #include <com/sun/star/uno/Reference.hxx>
  27 #include <com/sun/star/lang/XServiceInfo.hpp>
  28 #include <cppuhelper/interfacecontainer.h>
  29
  30 #include <svl/lstner.hxx>
  31 #include <cppuhelper/basemutex.hxx>
  32 #include <cppuhelper/compbase.hxx>
  33 #include <cppuhelper/implbase1.hxx>
  34 #include <rtl/ref.hxx>
  35
  36 namespace tools { class Rectangle; }
  37 class AbsoluteScreenPixelRectangle;
  38
  39 /** @descr
  40         This base class provides an implementation of the
  41         <code>AccessibleContext</code> service.
  42 */
  43 typedef cppu::WeakComponentImplHelper<
  44                 css::accessibility::XAccessible,
  45                 css::accessibility::XAccessibleComponent,
  46                 css::accessibility::XAccessibleContext,
  47                 css::accessibility::XAccessibleEventBroadcaster,
  48                 css::lang::XServiceInfo
  49                 > ScAccessibleContextBaseWeakImpl;
  50
  51 class ScAccessibleContextBase
  52     :   public cppu::BaseMutex,
  53         public ScAccessibleContextBaseWeakImpl,
  54         public SfxListener
  55 {
  56 class ScAccessibleContextBaseEventListener;
  57
  58 public:
  59     //=====  internal  ========================================================
  60     ScAccessibleContextBase(
  61         css::uno::Reference<css::accessibility::XAccessible> xParent,
  62         const sal_Int16 aRole);
  63
  64     virtual void Init();
  65     virtual void SAL_CALL disposing() override;
  66 protected:
  67     virtual ~ScAccessibleContextBase() override;
  68 public:
  69
  70     /// @throws css::uno::RuntimeException
  71     bool isShowing();
  72
  73     /// @throws css::uno::RuntimeException
  74     virtual bool isVisible();
  75
  76     ///=====  SfxListener  =====================================================
  77
  78     virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
  79
  80     ///=====  XAccessible  =====================================================
  81
  82     /// Return the XAccessibleContext.
  83     virtual css::uno::Reference< css::accessibility::XAccessibleContext> SAL_CALL
  84         getAccessibleContext() override;
  85
  86     ///=====  XAccessibleComponent  ============================================
  87
  88     virtual sal_Bool SAL_CALL containsPoint(
  89         const css::awt::Point& rPoint ) override;
  90
  91     virtual css::uno::Reference< css::accessibility::XAccessible >
  92         SAL_CALL getAccessibleAtPoint(
  93         const css::awt::Point& rPoint ) override;
  94
  95     virtual css::awt::Rectangle SAL_CALL getBounds(  ) override;
  96
  97     virtual css::awt::Point SAL_CALL getLocation(  ) override;
  98
  99     virtual css::awt::Point SAL_CALL getLocationOnScreen(  ) override;
 100
 101     virtual css::awt::Size SAL_CALL getSize(  ) override;
 102
 103     virtual void SAL_CALL grabFocus(  ) override;
 104
 105     virtual sal_Int32 SAL_CALL getForeground(  ) override;
 106
 107     virtual sal_Int32 SAL_CALL getBackground(  ) override;
 108
 109     ///=====  XAccessibleContext  ==============================================
 110
 111     /// Return the number of currently visible children.
 112     virtual sal_Int64 SAL_CALL getAccessibleChildCount() override;
 113
 114     /// Return the specified child or NULL if index is invalid.
 115     virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
 116         getAccessibleChild(sal_Int64 nIndex) override;
 117
 118     /// Return a reference to the parent.
 119     virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
 120         getAccessibleParent() override;
 121
 122     /// Return this objects index among the parents children.
 123     virtual sal_Int64 SAL_CALL
 124         getAccessibleIndexInParent() override;
 125
 126     /// Return this object's role.
 127     virtual sal_Int16 SAL_CALL
 128         getAccessibleRole() override;
 129
 130     /// Return this object's description.
 131     virtual OUString SAL_CALL
 132         getAccessibleDescription() override;
 133
 134     /// Return the object's current name.
 135     virtual OUString SAL_CALL
 136         getAccessibleName() override;
 137
 138     /// Return NULL to indicate that an empty relation set.
 139     virtual css::uno::Reference<css::accessibility::XAccessibleRelationSet> SAL_CALL
 140         getAccessibleRelationSet() override;
 141
 142     /// Return the set of current states.
 143     virtual sal_Int64 SAL_CALL getAccessibleStateSet() override;
 144
 145     /** Return the parents locale or throw exception if this object has no
 146         parent yet/anymore.
 147     */
 148     virtual css::lang::Locale SAL_CALL
 149         getLocale() override;
 150
 151     ///=====  XAccessibleEventBroadcaster  =====================================
 152
 153     /** Add listener that is informed of future changes of name,
 154           description and so on events.
 155     */
 156     virtual void SAL_CALL
 157         addAccessibleEventListener(
 158             const css::uno::Reference<css::accessibility::XAccessibleEventListener>& xListener) override;
 159
 160     //  Remove an existing event listener.
 161     virtual void SAL_CALL
 162         removeAccessibleEventListener(
 163             const css::uno::Reference<css::accessibility::XAccessibleEventListener>& xListener) override;
 164
 165     ///=====  XServiceInfo  ====================================================
 166
 167     /** Returns an identifier for the implementation of this object.
 168     */
 169     virtual OUString SAL_CALL
 170         getImplementationName() override;
 171
 172     /** Return whether the specified service is supported by this class.
 173     */
 174     virtual sal_Bool SAL_CALL
 175         supportsService(const OUString& sServiceName) override;
 176
 177     /** Returns a list of all supported services.  In this case that is just
 178         the AccessibleContext and Accessible service.
 179     */
 180     virtual css::uno::Sequence< OUString> SAL_CALL
 181         getSupportedServiceNames() override;
 182
 183 protected:
 184     /// Return this object's description.
 185     ///
 186     /// @throws css::uno::RuntimeException
 187     virtual OUString
 188         createAccessibleDescription();
 189
 190     /// Return the object's current name.
 191     ///
 192     /// @throws css::uno::RuntimeException
 193     virtual OUString
 194         createAccessibleName();
 195
 196     /// Return the object's current bounding box relative to the desktop.
 197     ///
 198     /// @throws css::uno::RuntimeException
 199     virtual AbsoluteScreenPixelRectangle GetBoundingBoxOnScreen() const;
 200
 201     /// Return the object's current bounding box relative to the parent object.
 202     ///
 203     /// @throws css::uno::RuntimeException
 204     virtual tools::Rectangle GetBoundingBox() const;
 205
 206 public:
 207     /// Calls all Listener to tell they the change.
 208     void
 209         CommitChange(const css::accessibility::AccessibleEventObject& rEvent) const;
 210
 211     /// Use this method to set initial Name without notification
 212     void SetName(const OUString& rName) { msName = rName; }
 213
 214     /// Use this method to set initial Description without notification
 215     void SetDescription(const OUString& rDesc) { msDescription = rDesc; }
 216
 217     void SetParent(const css::uno::Reference<css::accessibility::XAccessible>& rParent) { mxParent = rParent; }
 218
 219 protected:
 220     /// Calls all FocusListener to tell they that the focus is gained.
 221     void CommitFocusGained() const;
 222
 223     /// Calls all FocusListener to tell they that the focus is lost.
 224     void CommitFocusLost() const;
 225
 226     bool IsDefunc() const { return rBHelper.bDisposed; }
 227
 228     /// @throws css::lang::DisposedException
 229     void IsObjectValid() const;
 230
 231     /// Reference to the parent object.
 232     css::uno::Reference<css::accessibility::XAccessible> mxParent;
 233
 234 private:
 235     /** Description of this object.  This is not a constant because it can
 236         be set from the outside.  Furthermore, it changes according to the
 237         draw page's display mode.
 238     */
 239     OUString msDescription;
 240
 241     /** Name of this object.  It changes according the draw page's
 242         display mode.
 243     */
 244     OUString msName;
 245
 246     /// client id in the AccessibleEventNotifier queue
 247     sal_uInt32 mnClientId;
 248
 249     /** This is the role of this object.
 250     */
 251     sal_Int16 maRole;
 252
 253     rtl::Reference<ScAccessibleContextBaseEventListener> mxEventListener;
 254 };
 255
 256 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */