include/unotools/accessiblestatesethelper.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 #ifndef INCLUDED_UNOTOOLS_ACCESSIBLESTATESETHELPER_HXX
  20 #define INCLUDED_UNOTOOLS_ACCESSIBLESTATESETHELPER_HXX
  21
  22 #include <unotools/unotoolsdllapi.h>
  23
  24 #include <com/sun/star/accessibility/XAccessibleStateSet.hpp>
  25 #include <osl/mutex.hxx>
  26 #include <cppuhelper/implbase.hxx>
  27
  28 //= XAccessibleStateSet helper classes
  29
  30 //... namespace utl .......................................................
  31 namespace utl
  32 {
  33 /** @descr
  34         This base class provides an implementation of the
  35         <code>AccessibleStateSet</code> service.
  36 */
  37 class UNOTOOLS_DLLPUBLIC AccessibleStateSetHelper final
  38     : public cppu::WeakImplHelper<css::accessibility::XAccessibleStateSet>
  39 {
  40 public:
  41     //=====  internal  ========================================================
  42
  43     AccessibleStateSetHelper();
  44     /** constructs an object with some states initially set
  45
  46         <p>This ctor is compatible with
  47         <method scope="comphelper">OAccessibleImplementationAccess::implGetForeignControlledStates</method></p>
  48
  49         @param _nInitialStates
  50             is a bit mask. Every bit 2^n means that the state number n (as got from the
  51             AccessibleStateType constants) should be set initially.
  52     */
  53     AccessibleStateSetHelper(const sal_Int64 _nInitialStates);
  54
  55     AccessibleStateSetHelper(const AccessibleStateSetHelper& rHelper);
  56
  57 private:
  58     virtual ~AccessibleStateSetHelper() override;
  59
  60 public:
  61     //=====  XAccessibleStateSet  ==============================================
  62
  63     /** Checks whether the current state set is empty.
  64
  65         @return
  66             Returns <TRUE/> if there is no state in this state set and
  67             <FALSE/> if there is at least one state set in it.
  68     */
  69     virtual sal_Bool SAL_CALL isEmpty() override;
  70
  71     /** Checks if the given state is a member of the state set of this
  72         object.
  73
  74         @param aState
  75             The state for which to check membership.  This has to be one of
  76             the constants of AccessibleStateType.
  77
  78         @return
  79             Returns <TRUE/> if the given state is a member of this object's
  80             state set and <FALSE/> otherwise.
  81     */
  82     virtual sal_Bool SAL_CALL contains(sal_Int16 aState) override;
  83
  84     /** Checks if all of the given states are in this object's state
  85         set.
  86
  87         @param aStateSet
  88             This sequence of states is interpreted as set and every of its
  89             members, duplicates are ignored, is checked for membership in
  90             this object's state set.  Each state has to be one of the
  91             constants of AccessibleStateType.
  92
  93         @return
  94             Returns <TRUE/> if all states of the given state set are members
  95             of this object's state set.  <FALSE/> is returned if at least
  96             one of the states in the given state is not a member of this
  97             object's state set.
  98     */
  99     virtual sal_Bool SAL_CALL containsAll(const css::uno::Sequence<sal_Int16>& rStateSet) override;
 100
 101     /** Returns a sequence of all states.
 102     */
 103     virtual css::uno::Sequence<sal_Int16> SAL_CALL getStates() override;
 104
 105     /** Adds a state to the set.
 106
 107         @throws css::uno::RuntimeException
 108     */
 109     void AddState(sal_Int16 aState);
 110
 111     /** Removes a state from the set if the set contains the state, otherwise nothing is done.
 112
 113         @throws css::uno::RuntimeException
 114     */
 115     void RemoveState(sal_Int16 aState);
 116
 117     //=====  XTypeProvider  ===================================================
 118
 119     /** Returns a sequence of all supported interfaces.
 120     */
 121     virtual css::uno::Sequence<css::uno::Type> SAL_CALL getTypes() override;
 122
 123     /** Returns an implementation id.
 124     */
 125     virtual css::uno::Sequence<sal_Int8> SAL_CALL getImplementationId() override;
 126
 127 private:
 128     /// Mutex guarding this object.
 129     ::osl::Mutex maMutex;
 130     /// The implementation of this helper interface.
 131     sal_uInt64 maStates;
 132 };
 133 }
 134 //... namespace utl .......................................................
 135 #endif
 136
 137 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */