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