sw/source/core/access/accselectionhelper.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_SW_SOURCE_CORE_ACCESS_ACCSELECTIONHELPER_HXX
  21 #define INCLUDED_SW_SOURCE_CORE_ACCESS_ACCSELECTIONHELPER_HXX
  22
  23 #include <sal/types.h>
  24 #include <com/sun/star/uno/Reference.h>
  25
  26 namespace com::sun::star::accessibility { class XAccessible; }
  27
  28 class SwAccessibleContext;
  29 class SwFEShell;
  30
  31 class SwAccessibleSelectionHelper
  32 {
  33     /// the context on which this helper works
  34     SwAccessibleContext& m_rContext;
  35
  36     /// get FE-Shell
  37     SwFEShell* GetFEShell();
  38
  39     /// @throws css::lang::IndexOutOfBoundsException
  40     void throwIndexOutOfBoundsException();
  41
  42 public:
  43     SwAccessibleSelectionHelper( SwAccessibleContext& rContext );
  44
  45     // XAccessibleSelection
  46
  47     /// @throws css::lang::IndexOutOfBoundsException
  48     /// @throws css::uno::RuntimeException
  49     void selectAccessibleChild(
  50         sal_Int64 nChildIndex );
  51
  52     /// @throws css::lang::IndexOutOfBoundsException
  53     /// @throws css::uno::RuntimeException
  54     bool isAccessibleChildSelected(
  55         sal_Int64 nChildIndex );
  56     /// @throws css::uno::RuntimeException
  57     void selectAllAccessibleChildren(  );
  58     /// @throws css::uno::RuntimeException
  59     sal_Int64 getSelectedAccessibleChildCount(  );
  60     /// @throws css::lang::IndexOutOfBoundsException
  61     /// @throws css::uno::RuntimeException
  62     css::uno::Reference< css::accessibility::XAccessible > getSelectedAccessibleChild(
  63         sal_Int64 nSelectedChildIndex );
  64     // index has to be treated as global child index.
  65     /// @throws css::lang::IndexOutOfBoundsException
  66     /// @throws css::uno::RuntimeException
  67     void deselectAccessibleChild(
  68         sal_Int64 nChildIndex );
  69 };
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */