include/editeng/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 #ifndef INCLUDED_EDITENG_ACCESSIBLECONTEXTBASE_HXX
  21 #define INCLUDED_EDITENG_ACCESSIBLECONTEXTBASE_HXX
  22
  23 #include <com/sun/star/accessibility/XAccessible.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 <osl/mutex.hxx>
  29 #include <cppuhelper/compbase.hxx>
  30 #include <editeng/editengdllapi.h>
  31
  32 namespace com::sun::star::accessibility { class XAccessibleStateSet; }
  33 namespace com::sun::star::accessibility { class XAccessibleRelationSet; }
  34 namespace com::sun::star::accessibility { struct AccessibleEventObject; }
  35
  36 namespace accessibility {
  37
  38 struct MutexOwner {mutable ::osl::Mutex maMutex;};
  39
  40 /** @descr
  41         This base class provides an implementation of the
  42         AccessibleContext service. Apart from the
  43         <type>XXAccessible<type> and XAccessibleContextContext
  44         interfaces it supports the XServiceInfo interface.
  45 */
  46 class EDITENG_DLLPUBLIC AccessibleContextBase
  47     :   public MutexOwner,
  48         public cppu::WeakComponentImplHelper<
  49         css::accessibility::XAccessible,
  50         css::accessibility::XAccessibleContext,
  51         css::accessibility::XAccessibleEventBroadcaster,
  52         css::lang::XServiceInfo
  53         >
  54 {
  55 public:
  56
  57     //=====  internal  ========================================================
  58
  59     /** The origin of the accessible name or description.
  60     */
  61     enum StringOrigin {
  62         ManuallySet,
  63         FromShape,
  64         AutomaticallyCreated,
  65         NotSet
  66     };
  67
  68     AccessibleContextBase (
  69         const css::uno::Reference< css::accessibility::XAccessible>& rxParent,
  70         const sal_Int16 aRole);
  71     virtual ~AccessibleContextBase() override;
  72
  73
  74     /** Call all accessibility event listeners to inform them about the
  75         specified event.
  76         @param aEventId
  77             Id of the event type.
  78         @param rNewValue
  79             New value of the modified attribute.  Pass empty structure if
  80             not applicable.
  81         @param rOldValue
  82             Old value of the modified attribute.  Pass empty structure if
  83             not applicable.
  84     */
  85     void CommitChange (sal_Int16 aEventId,
  86         const css::uno::Any& rNewValue,
  87         const css::uno::Any& rOldValue);
  88
  89     /** Set a new description and, provided that the new name differs from
  90         the old one, broadcast an accessibility event.
  91         @param rsDescription
  92             The new description.
  93         @param eDescriptionOrigin
  94             The origin of the description.  This is used to determine
  95             whether the given description overrules the existing one.  An
  96             origin with a lower numerical value overrides one with a higher
  97             value.
  98         @throws css::uno::RuntimeException
  99     */
 100     void SetAccessibleDescription (
 101         const OUString& rsDescription,
 102         StringOrigin eDescriptionOrigin);
 103
 104     /** Set a new description and, provided that the new name differs from
 105         the old one, broadcast an accessibility event.
 106         @param rsName
 107             The new name.
 108         @param eNameOrigin
 109             The origin of the name.  This is used to determine whether the
 110             given name overrules the existing one.  An origin with a lower
 111             numerical value overrides one with a higher value.
 112         @throws css::uno::RuntimeException
 113     */
 114     void SetAccessibleName (
 115         const OUString& rsName,
 116         StringOrigin eNameOrigin);
 117
 118     /** Set the specified state (turn it on) and send events to all
 119         listeners to inform them of the change.
 120
 121         @param aState
 122             The state to turn on.
 123
 124         @return
 125             If the specified state changed its value due to this call
 126             <TRUE/> is returned, otherwise <FALSE/>.
 127     */
 128     virtual bool SetState (sal_Int16 aState);
 129
 130     /** Reset the specified state (turn it off) and send events to all
 131         listeners to inform them of the change.
 132
 133         @param aState
 134             The state to turn off.
 135
 136         @return
 137             If the specified state changed its value due to this call
 138             <TRUE/> is returned, otherwise <FALSE/>.
 139     */
 140     virtual bool ResetState (sal_Int16 aState);
 141
 142     /** Return the state of the specified state.
 143
 144         @param aState
 145             The state for which to return its value.
 146
 147         @return
 148             A value of <TRUE/> indicates that the state is set.  A <FALSE/>
 149             value indicates an unset state.
 150     */
 151     bool GetState (sal_Int16 aState);
 152
 153     /** Replace the current relation set with the specified one.  Send
 154         events for relations that are not in both sets.
 155
 156         @param rRelationSet
 157             The new relation set that replaces the old one.
 158
 159         @throws css::uno::RuntimeException
 160     */
 161     void SetRelationSet (
 162         const css::uno::Reference< css::accessibility::XAccessibleRelationSet>& rxRelationSet);
 163
 164
 165     //=====  XAccessible  =====================================================
 166
 167     /// Return the XAccessibleContext.
 168     virtual css::uno::Reference< css::accessibility::XAccessibleContext> SAL_CALL
 169         getAccessibleContext() override;
 170
 171
 172     //=====  XAccessibleContext  ==============================================
 173
 174     /// Return the number of currently visible children.
 175     virtual sal_Int32 SAL_CALL
 176         getAccessibleChildCount() override;
 177
 178     /// Return the specified child or throw exception.
 179     virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
 180         getAccessibleChild (sal_Int32 nIndex) override;
 181
 182     /// Return a reference to the parent.
 183     virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
 184         getAccessibleParent() override;
 185
 186     /// Return this objects index among the parents children.
 187     virtual sal_Int32 SAL_CALL
 188         getAccessibleIndexInParent() override;
 189
 190     /// Return this object's role.
 191     virtual sal_Int16 SAL_CALL
 192         getAccessibleRole() override;
 193
 194     /// Return this object's description.
 195     virtual OUString SAL_CALL
 196         getAccessibleDescription() override;
 197
 198     /// Return the object's current name.
 199     virtual OUString SAL_CALL
 200         getAccessibleName() override;
 201
 202     /// Return NULL to indicate that an empty relation set.
 203     virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet> SAL_CALL
 204         getAccessibleRelationSet() override;
 205
 206     /// Return the set of current states.
 207     virtual css::uno::Reference< css::accessibility::XAccessibleStateSet> SAL_CALL
 208         getAccessibleStateSet() override;
 209
 210     /** Return the parents locale or throw exception if this object has no
 211         parent yet/anymore.
 212     */
 213     virtual css::lang::Locale SAL_CALL
 214         getLocale() override;
 215
 216     //=====  XAccessibleEventBroadcaster  ========================================
 217
 218     virtual void SAL_CALL
 219         addAccessibleEventListener (
 220             const css::uno::Reference< css::accessibility::XAccessibleEventListener >& xListener) override;
 221
 222     virtual void SAL_CALL
 223         removeAccessibleEventListener (
 224             const css::uno::Reference< css::accessibility::XAccessibleEventListener >& xListener) override;
 225
 226
 227     //=====  XServiceInfo  ====================================================
 228
 229     /** Returns an identifier for the implementation of this object.
 230     */
 231     virtual OUString SAL_CALL
 232         getImplementationName() override;
 233
 234     /** Return whether the specified service is supported by this class.
 235     */
 236     virtual sal_Bool SAL_CALL
 237         supportsService (const OUString& sServiceName) override;
 238
 239     /** Returns a list of all supported services.  In this case that is just
 240         the AccessibleContext service.
 241     */
 242     virtual css::uno::Sequence< OUString> SAL_CALL
 243         getSupportedServiceNames() override;
 244
 245
 246     //=====  XTypeProvider  ===================================================
 247
 248     /** Returns an implementation id.
 249     */
 250     virtual css::uno::Sequence<sal_Int8> SAL_CALL
 251         getImplementationId() override;
 252
 253     /** Check whether or not the object has been disposed (or is in the
 254         state of being disposed).
 255
 256         @return TRUE, if the object is disposed or in the course
 257         of being disposed. Otherwise, FALSE is returned.
 258     */
 259     bool IsDisposed() const;
 260
 261 protected:
 262     /** The state set.
 263     */
 264     css::uno::Reference< css::accessibility::XAccessibleStateSet> mxStateSet;
 265
 266     /** The relation set.  Relations can be set or removed by calling the
 267         <member>AddRelation</member> and <member>RemoveRelation</member> methods.
 268     */
 269     css::uno::Reference< css::accessibility::XAccessibleRelationSet> mxRelationSet;
 270
 271     // This method is called from the component helper base class while disposing.
 272     virtual void SAL_CALL disposing() override;
 273
 274     /** Create the accessible object's name.  This method may be called more
 275         than once for a single object.
 276         @return
 277             The returned string is a unique (among the accessible object's
 278             siblings) name.
 279         @throws css::uno::RuntimeException
 280     */
 281     virtual OUString CreateAccessibleName();
 282
 283     void FireEvent (const css::accessibility::AccessibleEventObject& aEvent);
 284
 285     /** Check whether or not the object has been disposed (or is in the
 286         state of being disposed).  If that is the case then
 287         DisposedException is thrown to inform the (indirect) caller of the
 288         foul deed.
 289         @throws css::lang::DisposedException
 290     */
 291     void ThrowIfDisposed();
 292
 293     /** sets the role as returned by XaccessibleContext::getAccessibleRole
 294
 295         <p>Caution: This is only to be used in the construction phase (means within
 296         the ctor or late ctor), <em>never</em> when the object is still alive and part
 297         of an Accessibility hierarchy.</p>
 298     */
 299     void SetAccessibleRole( sal_Int16 _nRole );
 300
 301 private:
 302     /// Reference to the parent object.
 303     css::uno::Reference< css::accessibility::XAccessible> mxParent;
 304
 305     /** Description of this object.  This is not a constant because it can
 306         be set from the outside.  Furthermore, it changes according to the
 307         draw page's display mode.
 308     */
 309     OUString msDescription;
 310
 311     /** The origin of the description is used to determine whether new
 312         descriptions given to the SetAccessibleDescription is ignored or
 313         whether that replaces the old value in msDescription.
 314     */
 315     StringOrigin meDescriptionOrigin;
 316
 317     /** Name of this object.  It changes according the draw page's
 318         display mode.
 319     */
 320     OUString msName;
 321
 322     /** The origin of the name is used to determine whether new
 323         name given to the SetAccessibleName is ignored or
 324         whether that replaces the old value in msName.
 325     */
 326     StringOrigin meNameOrigin;
 327
 328     /** client id in the AccessibleEventNotifier queue
 329     */
 330     sal_uInt32 mnClientId;
 331
 332     /** This is the role of this object.
 333     */
 334     sal_Int16 maRole;
 335 };
 336
 337 }
 338
 339 #endif
 340
 341 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */