include/comphelper/accessibleselectionhelper.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_COMPHELPER_ACCESSIBLESELECTIONHELPER_HXX
  21 #define INCLUDED_COMPHELPER_ACCESSIBLESELECTIONHELPER_HXX
  22
  23 #include <config_options.h>
  24 #include <comphelper/accessiblecomponenthelper.hxx>
  25 #include <cppuhelper/implbase.hxx>
  26 #include <com/sun/star/accessibility/XAccessibleSelection.hpp>
  27 #include <comphelper/comphelperdllapi.h>
  28
  29 #define ACCESSIBLE_SELECTION_CHILD_ALL  (sal_Int32(-1))
  30 #define ACCESSIBLE_SELECTION_CHILD_SELF ((sal_Int32)-2)
  31
  32
  33 namespace comphelper
  34 {
  35
  36
  37     //= OCommonAccessibleSelection
  38
  39     /** base class encapsulating common functionality for the helper classes implementing
  40         the XAccessibleSelection
  41     */
  42     class COMPHELPER_DLLPUBLIC OCommonAccessibleSelection
  43     {
  44     protected:
  45
  46         OCommonAccessibleSelection();
  47
  48         ~OCommonAccessibleSelection();
  49
  50     protected:
  51
  52         // access to context - still waiting to be overwritten
  53         /// @throws css::uno::RuntimeException
  54         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  55             implGetAccessibleContext() = 0;
  56
  57         // return if the specified child is visible => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
  58         /// @throws css::uno::RuntimeException
  59         virtual bool
  60             implIsSelected( sal_Int64 nAccessibleChildIndex ) = 0;
  61
  62         // select the specified child => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
  63         /// @throws css::uno::RuntimeException
  64         virtual void
  65             implSelect( sal_Int64 nAccessibleChildIndex, bool bSelect ) = 0;
  66
  67     protected:
  68
  69         /** non-virtual versions of the methods which can be implemented using <method>implIsSelected</method> and <method>implSelect</method>
  70
  71             @throws css::lang::IndexOutOfBoundsException
  72             @throws css::uno::RuntimeException
  73         */
  74         void selectAccessibleChild( sal_Int64 nChildIndex );
  75         /// @throws css::lang::IndexOutOfBoundsException
  76         /// @throws css::uno::RuntimeException
  77         bool isAccessibleChildSelected( sal_Int64 nChildIndex );
  78         /// @throws css::uno::RuntimeException
  79         void clearAccessibleSelection(  );
  80         /// @throws css::uno::RuntimeException
  81         void selectAllAccessibleChildren(  );
  82         /// @throws css::uno::RuntimeException
  83         sal_Int64 getSelectedAccessibleChildCount(  );
  84         /// @throws css::lang::IndexOutOfBoundsException
  85         /// @throws css::uno::RuntimeException
  86         css::uno::Reference< css::accessibility::XAccessible > getSelectedAccessibleChild( sal_Int64 nSelectedChildIndex );
  87         /// @throws css::lang::IndexOutOfBoundsException
  88         /// @throws css::uno::RuntimeException
  89         void deselectAccessibleChild( sal_Int64 nSelectedChildIndex );
  90     };
  91
  92
  93     //= OAccessibleSelectionHelper
  94
  95
  96     /** a helper class for implementing an AccessibleSelection which at the same time
  97         supports an XAccessibleSelection interface.
  98     */
  99     class UNLESS_MERGELIBS(COMPHELPER_DLLPUBLIC) OAccessibleSelectionHelper : public cppu::ImplInheritanceHelper<OAccessibleComponentHelper, css::accessibility::XAccessibleSelection>,
 100                                        public OCommonAccessibleSelection
 101     {
 102     private:
 103         OAccessibleSelectionHelper(OAccessibleSelectionHelper const &) = delete;
 104         OAccessibleSelectionHelper(OAccessibleSelectionHelper &&) = delete;
 105         void operator =(OAccessibleSelectionHelper const &) = delete;
 106         void operator =(OAccessibleSelectionHelper &&) = delete;
 107
 108     protected:
 109
 110         OAccessibleSelectionHelper();
 111
 112         // return ourself here by default
 113         virtual css::uno::Reference< css::accessibility::XAccessibleContext > implGetAccessibleContext() override;
 114
 115     public:
 116
 117         // XAccessibleSelection - default implementations
 118         virtual void SAL_CALL selectAccessibleChild( sal_Int64 nChildIndex ) override;
 119         virtual sal_Bool SAL_CALL isAccessibleChildSelected( sal_Int64 nChildIndex ) override;
 120         virtual void SAL_CALL clearAccessibleSelection(  ) override;
 121         virtual void SAL_CALL selectAllAccessibleChildren(  ) override;
 122         virtual sal_Int64 SAL_CALL getSelectedAccessibleChildCount(  ) override;
 123         virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild( sal_Int64 nSelectedChildIndex ) override;
 124         virtual void SAL_CALL deselectAccessibleChild( sal_Int64 nSelectedChildIndex ) override;
 125     };
 126
 127
 128 }   // namespace comphelper
 129
 130
 131 #endif // INCLUDED_COMPHELPER_ACCESSIBLESELECTIONHELPER_HXX
 132
 133 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */