chart2/source/controller/inc/AccessibleTextHelper.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 #pragma once
  20
  21 #include <memory>
  22 #include <MutexContainer.hxx>
  23 #include <cppuhelper/compbase.hxx>
  24 #include <com/sun/star/lang/XInitialization.hpp>
  25 #include <com/sun/star/accessibility/XAccessibleContext.hpp>
  26
  27 // forward declaration of helper class from svx
  28 namespace accessibility
  29 {
  30 class AccessibleTextHelper;
  31 }
  32
  33 namespace chart
  34 {
  35
  36 class DrawViewWrapper;
  37
  38 namespace impl
  39 {
  40 typedef ::cppu::WeakComponentImplHelper<
  41         css::lang::XInitialization,
  42         css::accessibility::XAccessibleContext >
  43     AccessibleTextHelper_Base;
  44 }
  45
  46 class AccessibleTextHelper :
  47         public MutexContainer,
  48         public impl::AccessibleTextHelper_Base
  49 {
  50 public:
  51     explicit AccessibleTextHelper( DrawViewWrapper * pDrawViewWrapper );
  52     virtual ~AccessibleTextHelper() override;
  53
  54     // ____ XInitialization ____
  55     /** Must be called at least once for this helper class to work.
  56
  57         mandatory parameter 0: type string. This is the CID that is used to find
  58             the corresponding drawing object that contains the text that should
  59             be handled by this helper class.
  60 1
  61         mandatory parameter 1: type XAccessible.  Is used as EventSource for the
  62             ::accessibility::AccessibleTextHelper (svx)
  63
  64         mandatory parameter 2: type awt::XWindow.  The Window that shows the
  65             text currently.
  66      */
  67     virtual void SAL_CALL initialize(
  68         const css::uno::Sequence< css::uno::Any >& aArguments ) override;
  69
  70     // ____ XAccessibleContext ____
  71     virtual ::sal_Int32 SAL_CALL getAccessibleChildCount() override;
  72     virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild(
  73         ::sal_Int32 i ) override;
  74     virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent() override;
  75     virtual ::sal_Int32 SAL_CALL getAccessibleIndexInParent() override;
  76     virtual ::sal_Int16 SAL_CALL getAccessibleRole() override;
  77     virtual OUString SAL_CALL getAccessibleDescription() override;
  78     virtual OUString SAL_CALL getAccessibleName() override;
  79     virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet() override;
  80     virtual css::uno::Reference< css::accessibility::XAccessibleStateSet > SAL_CALL getAccessibleStateSet() override;
  81     virtual css::lang::Locale SAL_CALL getLocale() override;
  82
  83 private:
  84     std::unique_ptr<::accessibility::AccessibleTextHelper> m_pTextHelper;
  85     DrawViewWrapper *                                      m_pDrawViewWrapper;
  86 };
  87
  88 } //  namespace chart
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */