office-gobmx/include/unotools/accessiblestatesethelper.hxx
Noel Grandin 2721cd2e9c loplugin:finalclasses in unotools
Change-Id: I0fa349db5dab3406aa93d40d4d2f41e517bf60fa
Reviewed-on: https://gerrit.libreoffice.org/81799
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2019-10-31 07:03:06 +01:00

144 lines
4.9 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_UNOTOOLS_ACCESSIBLESTATESETHELPER_HXX
#define INCLUDED_UNOTOOLS_ACCESSIBLESTATESETHELPER_HXX
#include <unotools/unotoolsdllapi.h>
#include <com/sun/star/accessibility/XAccessibleStateSet.hpp>
#include <osl/mutex.hxx>
#include <cppuhelper/implbase.hxx>
#include <memory>
class AccessibleStateSetHelperImpl;
//= XAccessibleStateSet helper classes
//... namespace utl .......................................................
namespace utl
{
/** @descr
This base class provides an implementation of the
<code>AccessibleStateSet</code> service.
*/
class UNOTOOLS_DLLPUBLIC AccessibleStateSetHelper final
: public cppu::WeakImplHelper< css::accessibility::XAccessibleStateSet >
{
public:
//===== internal ========================================================
AccessibleStateSetHelper ();
/** constructs an object with some states initially set
<p>This ctor is compatible with
<method scope="comphelper">OAccessibleImplementationAccess::implGetForeignControlledStates</method></p>
@param _nInitialStates
is a bit mask. Every bit 2^n means that the state number n (as got from the
AccessibleStateType constants) should be set initially.
*/
AccessibleStateSetHelper ( const sal_Int64 _nInitialStates );
AccessibleStateSetHelper ( const AccessibleStateSetHelper& rHelper );
private:
virtual ~AccessibleStateSetHelper() override;
public:
//===== XAccessibleStateSet ==============================================
/** Checks whether the current state set is empty.
@return
Returns <TRUE/> if there is no state in this state set and
<FALSE/> if there is at least one state set in it.
*/
virtual sal_Bool SAL_CALL isEmpty () override;
/** Checks if the given state is a member of the state set of this
object.
@param aState
The state for which to check membership. This has to be one of
the constants of AccessibleStateType.
@return
Returns <TRUE/> if the given state is a member of this object's
state set and <FALSE/> otherwise.
*/
virtual sal_Bool SAL_CALL contains (sal_Int16 aState) override;
/** Checks if all of the given states are in this object's state
set.
@param aStateSet
This sequence of states is interpreted as set and every of its
members, duplicates are ignored, is checked for membership in
this object's state set. Each state has to be one of the
constants of AccessibleStateType.
@return
Returns <TRUE/> if all states of the given state set are members
of this object's state set. <FALSE/> is returned if at least
one of the states in the given state is not a member of this
object's state set.
*/
virtual sal_Bool SAL_CALL containsAll (
const css::uno::Sequence<sal_Int16>& rStateSet) override;
/** Returns a sequence of all states.
*/
virtual css::uno::Sequence<sal_Int16> SAL_CALL getStates() override;
/** Adds a state to the set.
@throws css::uno::RuntimeException
*/
void AddState(sal_Int16 aState);
/** Removes a state from the set if the set contains the state, otherwise nothing is done.
@throws css::uno::RuntimeException
*/
void RemoveState(sal_Int16 aState);
//===== XTypeProvider ===================================================
/** Returns a sequence of all supported interfaces.
*/
virtual css::uno::Sequence< css::uno::Type> SAL_CALL
getTypes() override;
/** Returns an implementation id.
*/
virtual css::uno::Sequence<sal_Int8> SAL_CALL
getImplementationId() override;
private:
/// Mutex guarding this object.
::osl::Mutex maMutex;
/// The implementation of this helper interface.
std::unique_ptr<AccessibleStateSetHelperImpl> mpHelperImpl;
};
}
//... namespace utl .......................................................
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */