2a3e7a751c
Change-Id: If150b8fec5350cb513550711a61923cc1a273a80 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/177052 Tested-by: Jenkins Reviewed-by: Julien Nabet <serval2412@yahoo.fr>
131 lines
5.4 KiB
C++
131 lines
5.4 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_COMPHELPER_ACCESSIBLESELECTIONHELPER_HXX
|
|
#define INCLUDED_COMPHELPER_ACCESSIBLESELECTIONHELPER_HXX
|
|
|
|
#include <config_options.h>
|
|
#include <comphelper/accessiblecomponenthelper.hxx>
|
|
#include <cppuhelper/implbase.hxx>
|
|
#include <com/sun/star/accessibility/XAccessibleSelection.hpp>
|
|
#include <comphelper/comphelperdllapi.h>
|
|
|
|
#define ACCESSIBLE_SELECTION_CHILD_ALL (sal_Int32(-1))
|
|
|
|
namespace comphelper
|
|
{
|
|
|
|
|
|
//= OCommonAccessibleSelection
|
|
|
|
/** base class encapsulating common functionality for the helper classes implementing
|
|
the XAccessibleSelection
|
|
*/
|
|
class COMPHELPER_DLLPUBLIC OCommonAccessibleSelection
|
|
{
|
|
protected:
|
|
|
|
OCommonAccessibleSelection();
|
|
|
|
~OCommonAccessibleSelection();
|
|
|
|
protected:
|
|
|
|
// access to context - still waiting to be overwritten
|
|
/// @throws css::uno::RuntimeException
|
|
virtual css::uno::Reference< css::accessibility::XAccessibleContext >
|
|
implGetAccessibleContext() = 0;
|
|
|
|
// return if the specified child is visible => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
|
|
/// @throws css::uno::RuntimeException
|
|
virtual bool
|
|
implIsSelected( sal_Int64 nAccessibleChildIndex ) = 0;
|
|
|
|
// select the specified child => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
|
|
/// @throws css::uno::RuntimeException
|
|
virtual void
|
|
implSelect( sal_Int64 nAccessibleChildIndex, bool bSelect ) = 0;
|
|
|
|
protected:
|
|
|
|
/** non-virtual versions of the methods which can be implemented using <method>implIsSelected</method> and <method>implSelect</method>
|
|
|
|
@throws css::lang::IndexOutOfBoundsException
|
|
@throws css::uno::RuntimeException
|
|
*/
|
|
void selectAccessibleChild( sal_Int64 nChildIndex );
|
|
/// @throws css::lang::IndexOutOfBoundsException
|
|
/// @throws css::uno::RuntimeException
|
|
bool isAccessibleChildSelected( sal_Int64 nChildIndex );
|
|
/// @throws css::uno::RuntimeException
|
|
void clearAccessibleSelection( );
|
|
/// @throws css::uno::RuntimeException
|
|
void selectAllAccessibleChildren( );
|
|
/// @throws css::uno::RuntimeException
|
|
sal_Int64 getSelectedAccessibleChildCount( );
|
|
/// @throws css::lang::IndexOutOfBoundsException
|
|
/// @throws css::uno::RuntimeException
|
|
css::uno::Reference< css::accessibility::XAccessible > getSelectedAccessibleChild( sal_Int64 nSelectedChildIndex );
|
|
/// @throws css::lang::IndexOutOfBoundsException
|
|
/// @throws css::uno::RuntimeException
|
|
void deselectAccessibleChild( sal_Int64 nSelectedChildIndex );
|
|
};
|
|
|
|
|
|
//= OAccessibleSelectionHelper
|
|
|
|
|
|
/** a helper class for implementing an AccessibleSelection which at the same time
|
|
supports an XAccessibleSelection interface.
|
|
*/
|
|
class UNLESS_MERGELIBS(COMPHELPER_DLLPUBLIC) OAccessibleSelectionHelper : public cppu::ImplInheritanceHelper<OAccessibleComponentHelper, css::accessibility::XAccessibleSelection>,
|
|
public OCommonAccessibleSelection
|
|
{
|
|
private:
|
|
OAccessibleSelectionHelper(OAccessibleSelectionHelper const &) = delete;
|
|
OAccessibleSelectionHelper(OAccessibleSelectionHelper &&) = delete;
|
|
void operator =(OAccessibleSelectionHelper const &) = delete;
|
|
void operator =(OAccessibleSelectionHelper &&) = delete;
|
|
|
|
protected:
|
|
|
|
OAccessibleSelectionHelper();
|
|
|
|
// return ourself here by default
|
|
virtual css::uno::Reference< css::accessibility::XAccessibleContext > implGetAccessibleContext() override final;
|
|
|
|
public:
|
|
|
|
// XAccessibleSelection - default implementations
|
|
virtual void SAL_CALL selectAccessibleChild( sal_Int64 nChildIndex ) override final;
|
|
virtual sal_Bool SAL_CALL isAccessibleChildSelected( sal_Int64 nChildIndex ) override final;
|
|
virtual void SAL_CALL clearAccessibleSelection( ) override final;
|
|
virtual void SAL_CALL selectAllAccessibleChildren( ) override final;
|
|
virtual sal_Int64 SAL_CALL getSelectedAccessibleChildCount( ) override final;
|
|
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild( sal_Int64 nSelectedChildIndex ) override final;
|
|
virtual void SAL_CALL deselectAccessibleChild( sal_Int64 nSelectedChildIndex ) override final;
|
|
};
|
|
|
|
|
|
} // namespace comphelper
|
|
|
|
|
|
#endif // INCLUDED_COMPHELPER_ACCESSIBLESELECTIONHELPER_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|